Trendsic Platform Service

ContactVisitSummaryRequest

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

The following routes are available for this service:
GET,OPTIONS	/v1/contact/{ContactId}/visit-summary

"use strict";
export class ContactQueueVisit {
    /** @param {{CheckinId?:string,BranchId?:string,BranchName?:string,LineId?:string,ServiceName?:string,Outcome?:number,OutcomeLabel?:string,IsAppointment?:boolean,SignInUtc?:string,CalledUtc?:string,FirstStartUtc?:string,CompletedTime?:string,WaitMinutes?:number,ServiceMinutes?:number,WindowName?:string,TicketLabel?:string,HoldReason?:string,ReturnedTime?:string,PausedMinutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CheckinId;
    /** @type {string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {string} */
    LineId;
    /** @type {string} */
    ServiceName;
    /** @type {number} */
    Outcome;
    /** @type {string} */
    OutcomeLabel;
    /** @type {boolean} */
    IsAppointment;
    /** @type {?string} */
    SignInUtc;
    /** @type {?string} */
    CalledUtc;
    /** @type {?string} */
    FirstStartUtc;
    /** @type {?string} */
    CompletedTime;
    /** @type {?number} */
    WaitMinutes;
    /** @type {?number} */
    ServiceMinutes;
    /** @type {string} */
    WindowName;
    /** @type {string} */
    TicketLabel;
    /** @type {string} */
    HoldReason;
    /** @type {?string} */
    ReturnedTime;
    /** @type {number} */
    PausedMinutes;
}
export class ContactQueueVisitSummary {
    /** @param {{Visits?:number,Completed?:number,NoShows?:number,NoShows90d?:number,Cancelled?:number,Unfulfilled?:number,Appointments?:number,LastVisitUtc?:string,LastNoShowUtc?:string,AvgWaitMinutes?:number,SmsOptIn?:boolean,TextsSent90d?:number,SayNameAs?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Visits;
    /** @type {number} */
    Completed;
    /** @type {number} */
    NoShows;
    /** @type {number} */
    NoShows90d;
    /** @type {number} */
    Cancelled;
    /** @type {number} */
    Unfulfilled;
    /** @type {number} */
    Appointments;
    /** @type {?string} */
    LastVisitUtc;
    /** @type {?string} */
    LastNoShowUtc;
    /** @type {?number} */
    AvgWaitMinutes;
    /** @type {boolean} */
    SmsOptIn;
    /** @type {number} */
    TextsSent90d;
    /** @type {string} */
    SayNameAs;
}
export class ContactVisitsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Visits?:ContactQueueVisit[],Summary?:ContactQueueVisitSummary}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ContactQueueVisit[]} */
    Visits = [];
    /** @type {ContactQueueVisitSummary} */
    Summary;
}
export class ContactVisitSummaryRequest {
    /** @param {{ContactId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactId;
}

JavaScript ContactVisitSummaryRequest 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/contact/{ContactId}/visit-summary HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ContactVisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Summary>
    <Appointments>0</Appointments>
    <AvgWaitMinutes>0</AvgWaitMinutes>
    <Cancelled>0</Cancelled>
    <Completed>0</Completed>
    <LastNoShowUtc>0001-01-01T00:00:00</LastNoShowUtc>
    <LastVisitUtc>0001-01-01T00:00:00</LastVisitUtc>
    <NoShows>0</NoShows>
    <NoShows90d>0</NoShows90d>
    <SayNameAs>String</SayNameAs>
    <SmsOptIn>false</SmsOptIn>
    <TextsSent90d>0</TextsSent90d>
    <Unfulfilled>0</Unfulfilled>
    <Visits>0</Visits>
  </Summary>
  <Visits>
    <ContactQueueVisit>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <CalledUtc>0001-01-01T00:00:00</CalledUtc>
      <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
      <CompletedTime>0001-01-01T00:00:00</CompletedTime>
      <FirstStartUtc>0001-01-01T00:00:00</FirstStartUtc>
      <HoldReason>String</HoldReason>
      <IsAppointment>false</IsAppointment>
      <LineId>00000000-0000-0000-0000-000000000000</LineId>
      <Outcome>0</Outcome>
      <OutcomeLabel>String</OutcomeLabel>
      <PausedMinutes>0</PausedMinutes>
      <ReturnedTime>0001-01-01T00:00:00</ReturnedTime>
      <ServiceMinutes>0</ServiceMinutes>
      <ServiceName>String</ServiceName>
      <SignInUtc>0001-01-01T00:00:00</SignInUtc>
      <TicketLabel>String</TicketLabel>
      <WaitMinutes>0</WaitMinutes>
      <WindowName>String</WindowName>
    </ContactQueueVisit>
  </Visits>
</ContactVisitsResponse>