Trendsic Platform Service

<back to all web services

BranchRequest

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

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 BranchResponse
{
    public ResponseStatus: ResponseStatus;
    public Branches: Branch[] = [];

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

export class BranchRequest
{
    public BranchId: 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 constructor(init?: Partial<BranchRequest>) { (Object as any).assign(this, init); }
}

TypeScript BranchRequest DTOs

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

HTTP + XML

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

POST /v1/branch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BranchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Address1>String</Address1>
  <Address2>String</Address2>
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <City>String</City>
  <Code>String</Code>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <Name>String</Name>
  <Phone>String</Phone>
  <State>String</State>
  <TimeZoneId>String</TimeZoneId>
  <Zip>String</Zip>
</BranchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BranchResponse 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>
  <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>
</BranchResponse>