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
import Foundation
import ServiceStack

public class CheckinTimelineRequest : Codable
{
    public var id:String

    required public init(){}
}

public class CheckinTimelineResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var timeline:SvcTimeline

    required public init(){}
}

public class SvcTimeline : Codable
{
    public var visit:SvcVisitRow
    public var steps:[SvcTimelineStep] = []
    public var walkUpSec:Int?

    required public init(){}
}

public class SvcVisitRow : Codable
{
    public var checkinId:String
    public var ticketLabel:String
    public var localDate:Date
    public var lineId:String
    public var serviceName:String
    public var stationId:String?
    public var stationName:String
    public var employeeId:String?
    public var employeeName:String
    public var customerName:String
    public var contactId:Int?
    public var contactAgentId:Int?
    public var customerId:String
    public var isAppointment:Bool
    public var localHere:Date?
    public var localCalled:Date?
    public var localStart:Date?
    public var localEnd:Date?
    public var waitSec:Int?
    public var serveSec:Int?
    public var outcome:String
    public var fee:Double?

    required public init(){}
}

public class SvcTimelineStep : Codable
{
    public var atUtc:Date
    public var localAt:Date
    public var kind:String
    public var stationName:String
    public var employeeName:String

    required public init(){}
}


Swift CheckinTimelineRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","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-01T00:00:00.0000000","LocalCalled":"0001-01-01T00:00:00.0000000","LocalStart":"0001-01-01T00:00:00.0000000","LocalEnd":"0001-01-01T00:00:00.0000000","WaitSec":0,"ServeSec":0,"Outcome":"String","Fee":0},"Steps":[{"AtUtc":"0001-01-01T00:00:00.0000000","LocalAt":"0001-01-01T00:00:00.0000000","Kind":"String","StationName":"String","EmployeeName":"String"}],"WalkUpSec":0}}