Trendsic Platform Service

<back to all web services

BranchApptAuditRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/queue/appointments/{CheckInId}/audit
"use strict";
export class BranchApptAuditEntry {
    /** @param {{Kind?:string,Summary?:string,Reason?:string,Notified?:boolean,UserName?:string,AtLocal?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {string} */
    Summary;
    /** @type {string} */
    Reason;
    /** @type {boolean} */
    Notified;
    /** @type {string} */
    UserName;
    /** @type {string} */
    AtLocal;
}
export class BranchApptAuditResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Entries?:BranchApptAuditEntry[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {BranchApptAuditEntry[]} */
    Entries = [];
}
export class BranchApptAuditRequest {
    /** @param {{CheckInId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CheckInId;
}

JavaScript BranchApptAuditRequest DTOs

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

HTTP + JSV

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

GET /v1/queue/appointments/{CheckInId}/audit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Entries: 
	[
		{
			Kind: String,
			Summary: String,
			Reason: String,
			Notified: False,
			UserName: String,
			AtLocal: 0001-01-01
		}
	]
}