Trendsic Platform Service

<back to all web services

BranchApptChangeRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/queue/appointments/{CheckInId}/change
"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 BranchApptChangeRequest {
    /** @param {{CheckInId?:string,Date?:string,StartLocal?:string,LineIds?:string[],Notify?:boolean,Reason?:string,Note?:string,Overbook?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CheckInId;
    /** @type {string} */
    Date;
    /** @type {string} */
    StartLocal;
    /** @type {string[]} */
    LineIds = [];
    /** @type {boolean} */
    Notify;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Note;
    /** @type {boolean} */
    Overbook;
}

JavaScript BranchApptChangeRequest DTOs

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

HTTP + CSV

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

POST /v1/queue/appointments/{CheckInId}/change HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CheckInId":"00000000000000000000000000000000","Date":"String","StartLocal":"String","LineIds":["00000000000000000000000000000000"],"Notify":false,"Reason":"String","Note":"String","Overbook":false}

HTTP/1.1 200 OK
Content-Type: text/csv
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}