| Requires any of the roles: | Agent, Administrator |
| 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 .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"LocationId":"00000000000000000000000000000000","Date":"String","StartLocal":"String","LineIds":["00000000000000000000000000000000"],"ContactId":0,"NewContact":{"Name":"String","Phone":"String","Email":"String"},"Via":"String","Notify":false,"Note":"String","Overbook":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"CalendarEventId":0,"CheckInId":"00000000000000000000000000000000","StartLocal":"0001-01-01T00:00:00.0000000","EndLocal":"0001-01-01T00:00:00.0000000","ContactId":0,"ContactExisted":false,"Notified":false,"Open":0,"Capacity":0}