Trendsic Platform Service

<back to all web services

BranchContextRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/branch/context

export class Branch
{
    public BranchId: string;
    public TenantId: string;
    public Name: string;
    public Code: string;
    public Address1: string;
    public Address2: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Phone: string;
    public Latitude?: number;
    public Longitude?: number;
    public TimeZoneId: string;
    public IsDefault: boolean;
    public IsActive: boolean;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<Branch>) { (Object as any).assign(this, init); }
}

export class BranchContextResponse
{
    public ResponseStatus: ResponseStatus;
    public Branches: Branch[] = [];
    public SelectedBranchId?: string;
    public DefaultBranchId?: string;

    public constructor(init?: Partial<BranchContextResponse>) { (Object as any).assign(this, init); }
}

export class BranchContextRequest
{

    public constructor(init?: Partial<BranchContextRequest>) { (Object as any).assign(this, init); }
}

TypeScript BranchContextRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/branch/context HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Branches: 
	[
		{
			BranchId: 00000000000000000000000000000000,
			TenantId: 00000000000000000000000000000000,
			Name: String,
			Code: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Phone: String,
			Latitude: 0,
			Longitude: 0,
			TimeZoneId: String,
			IsDefault: False,
			IsActive: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	SelectedBranchId: 00000000000000000000000000000000,
	DefaultBranchId: 00000000000000000000000000000000
}