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 .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/customercheckins/{Id}/timeline 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
		}
	},
	Timeline: 
	{
		Visit: 
		{
			CheckinId: 00000000000000000000000000000000,
			TicketLabel: String,
			LocalDate: 0001-01-01,
			LineId: 00000000000000000000000000000000,
			ServiceName: String,
			StationId: 00000000000000000000000000000000,
			StationName: String,
			EmployeeId: 00000000000000000000000000000000,
			EmployeeName: String,
			CustomerName: String,
			ContactId: 0,
			ContactAgentId: 0,
			CustomerId: 00000000000000000000000000000000,
			IsAppointment: False,
			LocalHere: 0001-01-01,
			LocalCalled: 0001-01-01,
			LocalStart: 0001-01-01,
			LocalEnd: 0001-01-01,
			WaitSec: 0,
			ServeSec: 0,
			Outcome: String,
			Fee: 0
		},
		Steps: 
		[
			{
				AtUtc: 0001-01-01,
				LocalAt: 0001-01-01,
				Kind: String,
				StationName: String,
				EmployeeName: String
			}
		],
		WalkUpSec: 0
	}
}