Trendsic Platform Service

CheckinTimelineRequest

The following routes are available for this service:
GET,OPTIONS	/v1/customercheckins/{Id}/timeline

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcVisitRow:
    checkin_id: Optional[str] = None
    ticket_label: Optional[str] = None
    local_date: datetime.datetime = datetime.datetime(1, 1, 1)
    line_id: Optional[str] = None
    service_name: Optional[str] = None
    station_id: Optional[str] = None
    station_name: Optional[str] = None
    employee_id: Optional[str] = None
    employee_name: Optional[str] = None
    customer_name: Optional[str] = None
    contact_id: Optional[int] = None
    contact_agent_id: Optional[int] = None
    customer_id: Optional[str] = None
    is_appointment: bool = False
    local_here: Optional[datetime.datetime] = None
    local_called: Optional[datetime.datetime] = None
    local_start: Optional[datetime.datetime] = None
    local_end: Optional[datetime.datetime] = None
    wait_sec: Optional[int] = None
    serve_sec: Optional[int] = None
    outcome: Optional[str] = None
    fee: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcTimelineStep:
    at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    local_at: datetime.datetime = datetime.datetime(1, 1, 1)
    kind: Optional[str] = None
    station_name: Optional[str] = None
    employee_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SvcTimeline:
    visit: Optional[SvcVisitRow] = None
    steps: List[SvcTimelineStep] = field(default_factory=list)
    walk_up_sec: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckinTimelineResponse:
    response_status: Optional[ResponseStatus] = None
    timeline: Optional[SvcTimeline] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckinTimelineRequest:
    id: Optional[str] = None

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