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
CheckinTimelineRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidNo
CheckinTimelineResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TimelineformSvcTimelineNo
SvcTimeline Parameters:
NameParameterData TypeRequiredDescription
VisitformSvcVisitRowNo
StepsformList<SvcTimelineStep>No
WalkUpSecformint?No
SvcVisitRow Parameters:
NameParameterData TypeRequiredDescription
CheckinIdformGuidNo
TicketLabelformstringNo
LocalDateformDateTimeNo
LineIdformGuidNo
ServiceNameformstringNo
StationIdformGuid?No
StationNameformstringNo
EmployeeIdformGuid?No
EmployeeNameformstringNo
CustomerNameformstringNo
ContactIdformint?No
ContactAgentIdformint?No
CustomerIdformGuidNo
IsAppointmentformboolNo
LocalHereformDateTime?No
LocalCalledformDateTime?No
LocalStartformDateTime?No
LocalEndformDateTime?No
WaitSecformint?No
ServeSecformint?No
OutcomeformstringNo
Feeformdecimal?No
SvcTimelineStep Parameters:
NameParameterData TypeRequiredDescription
AtUtcformDateTimeNo
LocalAtformDateTimeNo
KindformstringNo
StationNameformstringNo
EmployeeNameformstringNo

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