Trendsic Platform Service

<back to all web services

CustomerCheckins

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,DELETE,OPTIONS/v1/CustomerCheckins/{Id}
GET,POST,DELETE,OPTIONS/v1/CustomerCheckins
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CustomerCheckins : CustomerCheckinObject()
{
    open var ApiKey:UUID? = null
}

open class CustomerCheckinObject
{
    open var Id:UUID? = null
    open var LineId:UUID? = null
    open var CustomerId:UUID? = null
    open var EmployeeId:UUID? = null
    open var LocationId:UUID? = null
    open var StationId:UUID? = null
    open var SignInTime:Date? = null
    open var AdjustedSignInTime:Date? = null
    open var SendReminders:Boolean? = null
    open var Status:Int? = null
    open var TaskTime:Int? = null
    open var Completed:Boolean? = null
    open var CompletedTime:Date? = null
    open var QuestionnaireSubmitted:Boolean? = null
    open var LineIds:ArrayList<UUID> = ArrayList<UUID>()
}

open class CustomerCheckinsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var CustomerCheckins:ArrayList<CustomerCheckinObject> = ArrayList<CustomerCheckinObject>()
    open var CustomerCheckinRequirements:CheckinInformation? = null
}

open class CheckinInformation
{
    open var Id:UUID? = null
    open var LocationId:UUID? = null
    open var LocationName:String? = null
    open var CustomerId:UUID? = null
    open var QuestionnaireSubmitted:Boolean? = null
    open var Name:String? = null
    open var Description:String? = null
    open var TotalServiceDurationMinutes:Int? = null
    open var TotalCost:BigDecimal? = null
    open var SendQuestionnaire:Boolean? = null
    open var RequireUpload:Boolean? = null
    open var Questions:ArrayList<LineQuestion> = ArrayList<LineQuestion>()
    open var Lines:ArrayList<Line> = ArrayList<Line>()
}

open class LineQuestion
{
    open var Id:Int? = null
    open var CustomerCheckInId:UUID? = null
    open var LineId:UUID? = null
    open var Question:String? = null
    open var Answer:String? = null
    open var Active:Boolean? = null
}

open class Line
{
    open var Id:UUID? = null
    open var LocationId:UUID? = null
    open var LocationName:String? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ServiceDurationMinutes:Int? = null
    open var WaitTime:Int? = null
    open var Cost:BigDecimal? = null
    open var UpperThreshold:Int? = null
    open var LowerThreshold:Int? = null
    open var Active:Boolean? = null
    open var EntDate:Date? = null
    open var ModDate:Date? = null
    open var SendQuestionnaire:Boolean? = null
    open var RequireUpload:Boolean? = null
    open var UploadMessage:String? = null
    open var LineImages:ArrayList<LineImage> = ArrayList<LineImage>()
}

open class LineImage
{
    open var ImageId:UUID? = null
    open var FileName:String? = null
    open var ImageTitle:String? = null
    open var UploadDate:Date? = null
}

Kotlin CustomerCheckins 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.

POST /v1/CustomerCheckins/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	LineId: 00000000000000000000000000000000,
	CustomerId: 00000000000000000000000000000000,
	EmployeeId: 00000000000000000000000000000000,
	LocationId: 00000000000000000000000000000000,
	StationId: 00000000000000000000000000000000,
	SignInTime: 0001-01-01,
	AdjustedSignInTime: 0001-01-01,
	SendReminders: False,
	Status: 0,
	TaskTime: 0,
	Completed: False,
	CompletedTime: 0001-01-01,
	QuestionnaireSubmitted: False,
	LineIds: 
	[
		00000000000000000000000000000000
	]
}
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
		}
	},
	CustomerCheckins: 
	[
		{
			Id: 00000000000000000000000000000000,
			LineId: 00000000000000000000000000000000,
			CustomerId: 00000000000000000000000000000000,
			EmployeeId: 00000000000000000000000000000000,
			LocationId: 00000000000000000000000000000000,
			StationId: 00000000000000000000000000000000,
			SignInTime: 0001-01-01,
			AdjustedSignInTime: 0001-01-01,
			SendReminders: False,
			Status: 0,
			TaskTime: 0,
			Completed: False,
			CompletedTime: 0001-01-01,
			QuestionnaireSubmitted: False,
			LineIds: 
			[
				00000000000000000000000000000000
			]
		}
	],
	CustomerCheckinRequirements: 
	{
		Id: 00000000000000000000000000000000,
		LocationId: 00000000000000000000000000000000,
		LocationName: String,
		CustomerId: 00000000000000000000000000000000,
		QuestionnaireSubmitted: False,
		Name: String,
		Description: String,
		TotalServiceDurationMinutes: 0,
		TotalCost: 0,
		SendQuestionnaire: False,
		RequireUpload: False,
		Questions: 
		[
			{
				Id: 0,
				CustomerCheckInId: 00000000000000000000000000000000,
				LineId: 00000000000000000000000000000000,
				Question: String,
				Answer: String,
				Active: False
			}
		],
		Lines: 
		[
			{
				Id: 00000000000000000000000000000000,
				LocationId: 00000000000000000000000000000000,
				LocationName: String,
				Name: String,
				Description: String,
				ServiceDurationMinutes: 0,
				WaitTime: 0,
				Cost: 0,
				UpperThreshold: 0,
				LowerThreshold: 0,
				Active: False,
				EntDate: 0001-01-01,
				ModDate: 0001-01-01,
				SendQuestionnaire: False,
				RequireUpload: False,
				UploadMessage: String,
				LineImages: 
				[
					{
						ImageId: 00000000000000000000000000000000,
						FileName: String,
						ImageTitle: String,
						UploadDate: 0001-01-01
					}
				]
			}
		]
	}
}