Trendsic Platform Service

<back to all web services

CheckinTimelineRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/customercheckins/{Id}/timeline
"use strict";
export class SvcVisitRow {
    /** @param {{CheckinId?:string,TicketLabel?:string,LocalDate?:string,LineId?:string,ServiceName?:string,StationId?:string,StationName?:string,EmployeeId?:string,EmployeeName?:string,CustomerName?:string,ContactId?:number,ContactAgentId?:number,CustomerId?:string,IsAppointment?:boolean,LocalHere?:string,LocalCalled?:string,LocalStart?:string,LocalEnd?:string,WaitSec?:number,ServeSec?:number,Outcome?:string,Fee?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CheckinId;
    /** @type {string} */
    TicketLabel;
    /** @type {string} */
    LocalDate;
    /** @type {string} */
    LineId;
    /** @type {string} */
    ServiceName;
    /** @type {?string} */
    StationId;
    /** @type {string} */
    StationName;
    /** @type {?string} */
    EmployeeId;
    /** @type {string} */
    EmployeeName;
    /** @type {string} */
    CustomerName;
    /** @type {?number} */
    ContactId;
    /** @type {?number} */
    ContactAgentId;
    /** @type {string} */
    CustomerId;
    /** @type {boolean} */
    IsAppointment;
    /** @type {?string} */
    LocalHere;
    /** @type {?string} */
    LocalCalled;
    /** @type {?string} */
    LocalStart;
    /** @type {?string} */
    LocalEnd;
    /** @type {?number} */
    WaitSec;
    /** @type {?number} */
    ServeSec;
    /** @type {string} */
    Outcome;
    /** @type {?number} */
    Fee;
}
export class SvcTimelineStep {
    /** @param {{AtUtc?:string,LocalAt?:string,Kind?:string,StationName?:string,EmployeeName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AtUtc;
    /** @type {string} */
    LocalAt;
    /** @type {string} */
    Kind;
    /** @type {string} */
    StationName;
    /** @type {string} */
    EmployeeName;
}
export class SvcTimeline {
    /** @param {{Visit?:SvcVisitRow,Steps?:SvcTimelineStep[],WalkUpSec?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SvcVisitRow} */
    Visit;
    /** @type {SvcTimelineStep[]} */
    Steps = [];
    /** @type {?number} */
    WalkUpSec;
}
export class CheckinTimelineResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Timeline?:SvcTimeline}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SvcTimeline} */
    Timeline;
}
export class CheckinTimelineRequest {
    /** @param {{Id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
}

JavaScript CheckinTimelineRequest 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/customercheckins/{Id}/timeline HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CheckinTimelineResponse 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>
  <Timeline>
    <Steps>
      <SvcTimelineStep>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <EmployeeName>String</EmployeeName>
        <Kind>String</Kind>
        <LocalAt>0001-01-01T00:00:00</LocalAt>
        <StationName>String</StationName>
      </SvcTimelineStep>
    </Steps>
    <Visit>
      <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
      <ContactAgentId>0</ContactAgentId>
      <ContactId>0</ContactId>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <CustomerName>String</CustomerName>
      <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
      <EmployeeName>String</EmployeeName>
      <Fee>0</Fee>
      <IsAppointment>false</IsAppointment>
      <LineId>00000000-0000-0000-0000-000000000000</LineId>
      <LocalCalled>0001-01-01T00:00:00</LocalCalled>
      <LocalDate>0001-01-01T00:00:00</LocalDate>
      <LocalEnd>0001-01-01T00:00:00</LocalEnd>
      <LocalHere>0001-01-01T00:00:00</LocalHere>
      <LocalStart>0001-01-01T00:00:00</LocalStart>
      <Outcome>String</Outcome>
      <ServeSec>0</ServeSec>
      <ServiceName>String</ServiceName>
      <StationId>00000000-0000-0000-0000-000000000000</StationId>
      <StationName>String</StationName>
      <TicketLabel>String</TicketLabel>
      <WaitSec>0</WaitSec>
    </Visit>
    <WalkUpSec>0</WalkUpSec>
  </Timeline>
</CheckinTimelineResponse>