| GET,OPTIONS | /v1/branch/context |
|---|
"use strict";
export class Branch {
/** @param {{BranchId?:string,TenantId?:string,Name?:string,Code?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Phone?:string,Latitude?:number,Longitude?:number,TimeZoneId?:string,IsDefault?:boolean,IsActive?:boolean,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
BranchId;
/** @type {string} */
TenantId;
/** @type {string} */
Name;
/** @type {string} */
Code;
/** @type {string} */
Address1;
/** @type {string} */
Address2;
/** @type {string} */
City;
/** @type {string} */
State;
/** @type {string} */
Zip;
/** @type {string} */
Phone;
/** @type {?number} */
Latitude;
/** @type {?number} */
Longitude;
/** @type {string} */
TimeZoneId;
/** @type {boolean} */
IsDefault;
/** @type {boolean} */
IsActive;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
UpdatedAt;
}
export class BranchContextResponse {
/** @param {{ResponseStatus?:ResponseStatus,Branches?:Branch[],SelectedBranchId?:string,DefaultBranchId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Branch[]} */
Branches = [];
/** @type {?string} */
SelectedBranchId;
/** @type {?string} */
DefaultBranchId;
}
export class BranchContextRequest {
constructor(init) { Object.assign(this, init) }
}
JavaScript BranchContextRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BranchContextResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Branches>
<Branch>
<Address1>String</Address1>
<Address2>String</Address2>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<City>String</City>
<Code>String</Code>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<IsActive>false</IsActive>
<IsDefault>false</IsDefault>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<Name>String</Name>
<Phone>String</Phone>
<State>String</State>
<TenantId>00000000-0000-0000-0000-000000000000</TenantId>
<TimeZoneId>String</TimeZoneId>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<Zip>String</Zip>
</Branch>
</Branches>
<DefaultBranchId>00000000-0000-0000-0000-000000000000</DefaultBranchId>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SelectedBranchId>00000000-0000-0000-0000-000000000000</SelectedBranchId>
</BranchContextResponse>