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

export class SvcVisitRow
{
    public CheckinId: string;
    public TicketLabel: string;
    public LocalDate: string;
    public LineId: string;
    public ServiceName: string;
    public StationId?: string;
    public StationName: string;
    public EmployeeId?: string;
    public EmployeeName: string;
    public CustomerName: string;
    public ContactId?: number;
    public ContactAgentId?: number;
    public CustomerId: string;
    public IsAppointment: boolean;
    public LocalHere?: string;
    public LocalCalled?: string;
    public LocalStart?: string;
    public LocalEnd?: string;
    public WaitSec?: number;
    public ServeSec?: number;
    public Outcome: string;
    public Fee?: number;

    public constructor(init?: Partial<SvcVisitRow>) { (Object as any).assign(this, init); }
}

export class SvcTimelineStep
{
    public AtUtc: string;
    public LocalAt: string;
    public Kind: string;
    public StationName: string;
    public EmployeeName: string;

    public constructor(init?: Partial<SvcTimelineStep>) { (Object as any).assign(this, init); }
}

export class SvcTimeline
{
    public Visit: SvcVisitRow;
    public Steps: SvcTimelineStep[] = [];
    public WalkUpSec?: number;

    public constructor(init?: Partial<SvcTimeline>) { (Object as any).assign(this, init); }
}

export class CheckinTimelineResponse
{
    public ResponseStatus: ResponseStatus;
    public Timeline: SvcTimeline;

    public constructor(init?: Partial<CheckinTimelineResponse>) { (Object as any).assign(this, init); }
}

export class CheckinTimelineRequest
{
    public Id: string;

    public constructor(init?: Partial<CheckinTimelineRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}