Trendsic Platform Service

BranchApptCreateRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/queue/appointments

"use strict";
export class BranchApptWriteResponse {
    /** @param {{ResponseStatus?:ResponseStatus,CalendarEventId?:number,CheckInId?:string,StartLocal?:string,EndLocal?:string,ContactId?:number,ContactExisted?:boolean,Notified?:boolean,Open?:number,Capacity?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    CalendarEventId;
    /** @type {string} */
    CheckInId;
    /** @type {?string} */
    StartLocal;
    /** @type {?string} */
    EndLocal;
    /** @type {number} */
    ContactId;
    /** @type {boolean} */
    ContactExisted;
    /** @type {boolean} */
    Notified;
    /** @type {?number} */
    Open;
    /** @type {?number} */
    Capacity;
}
export class BranchApptNewContact {
    /** @param {{Name?:string,Phone?:string,Email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
}
export class BranchApptCreateRequest {
    /** @param {{LocationId?:string,Date?:string,StartLocal?:string,LineIds?:string[],ContactId?:number,NewContact?:BranchApptNewContact,Via?:string,Notify?:boolean,Note?:string,Overbook?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string} */
    Date;
    /** @type {string} */
    StartLocal;
    /** @type {string[]} */
    LineIds = [];
    /** @type {?number} */
    ContactId;
    /** @type {BranchApptNewContact} */
    NewContact;
    /** @type {string} */
    Via;
    /** @type {boolean} */
    Notify;
    /** @type {string} */
    Note;
    /** @type {boolean} */
    Overbook;
}

JavaScript BranchApptCreateRequest 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/queue/appointments HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BranchApptCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactId>0</ContactId>
  <Date>String</Date>
  <LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LineIds>
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
  <NewContact>
    <Email>String</Email>
    <Name>String</Name>
    <Phone>String</Phone>
  </NewContact>
  <Note>String</Note>
  <Notify>false</Notify>
  <Overbook>false</Overbook>
  <StartLocal>String</StartLocal>
  <Via>String</Via>
</BranchApptCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BranchApptWriteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CalendarEventId>0</CalendarEventId>
  <Capacity>0</Capacity>
  <CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
  <ContactExisted>false</ContactExisted>
  <ContactId>0</ContactId>
  <EndLocal>0001-01-01T00:00:00</EndLocal>
  <Notified>false</Notified>
  <Open>0</Open>
  <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>
  <StartLocal>0001-01-01T00:00:00</StartLocal>
</BranchApptWriteResponse>