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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CheckinTimelineRequest
{
    open var Id:UUID? = null
}

open class CheckinTimelineResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Timeline:SvcTimeline? = null
}

open class SvcTimeline
{
    open var Visit:SvcVisitRow? = null
    open var Steps:ArrayList<SvcTimelineStep> = ArrayList<SvcTimelineStep>()
    open var WalkUpSec:Int? = null
}

open class SvcVisitRow
{
    open var CheckinId:UUID? = null
    open var TicketLabel:String? = null
    open var LocalDate:Date? = null
    open var LineId:UUID? = null
    open var ServiceName:String? = null
    open var StationId:UUID? = null
    open var StationName:String? = null
    open var EmployeeId:UUID? = null
    open var EmployeeName:String? = null
    open var CustomerName:String? = null
    open var ContactId:Int? = null
    open var ContactAgentId:Int? = null
    open var CustomerId:UUID? = null
    open var IsAppointment:Boolean? = null
    open var LocalHere:Date? = null
    open var LocalCalled:Date? = null
    open var LocalStart:Date? = null
    open var LocalEnd:Date? = null
    open var WaitSec:Int? = null
    open var ServeSec:Int? = null
    open var Outcome:String? = null
    open var Fee:BigDecimal? = null
}

open class SvcTimelineStep
{
    open var AtUtc:Date? = null
    open var LocalAt:Date? = null
    open var Kind:String? = null
    open var StationName:String? = null
    open var EmployeeName:String? = null
}

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