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 .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.

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

<BranchApptAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Entries>
    <BranchApptAuditEntry>
      <AtLocal>0001-01-01T00:00:00</AtLocal>
      <Kind>String</Kind>
      <Notified>false</Notified>
      <Reason>String</Reason>
      <Summary>String</Summary>
      <UserName>String</UserName>
    </BranchApptAuditEntry>
  </Entries>
  <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>
</BranchApptAuditResponse>