Trendsic Platform Service

CustomerCheckinsRequest

The following routes are available for this service:
GET,POST,DELETE,OPTIONS	/v1/CustomerCheckins/GetSingle/{Id}

"use strict";
export class CustomerCheckinObject {
    /** @param {{Id?:string,LineId?:string,CustomerId?:string,EmployeeId?:string,LocationId?:string,StationId?:string,SignInTime?:string,AdjustedSignInTime?:string,SendReminders?:boolean,Status?:number,TaskTime?:number,Completed?:boolean,CompletedTime?:string,QuestionnaireSubmitted?:boolean,LineIds?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    LineId;
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    EmployeeId;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    StationId;
    /** @type {string} */
    SignInTime;
    /** @type {string} */
    AdjustedSignInTime;
    /** @type {boolean} */
    SendReminders;
    /** @type {number} */
    Status;
    /** @type {number} */
    TaskTime;
    /** @type {boolean} */
    Completed;
    /** @type {string} */
    CompletedTime;
    /** @type {boolean} */
    QuestionnaireSubmitted;
    /** @type {string[]} */
    LineIds = [];
}
export class LineQuestion {
    /** @param {{Id?:number,CustomerCheckInId?:string,LineId?:string,Question?:string,Answer?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    CustomerCheckInId;
    /** @type {string} */
    LineId;
    /** @type {string} */
    Question;
    /** @type {string} */
    Answer;
    /** @type {boolean} */
    Active;
}
export class LineImage {
    /** @param {{ImageId?:string,FileName?:string,ImageTitle?:string,UploadDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    ImageId;
    /** @type {string} */
    FileName;
    /** @type {string} */
    ImageTitle;
    /** @type {string} */
    UploadDate;
}
export class Line {
    /** @param {{Id?:string,LocationId?:string,LocationName?:string,Name?:string,Description?:string,ServiceDurationMinutes?:number,WaitTime?:number,Cost?:number,UpperThreshold?:number,LowerThreshold?:number,Active?:boolean,EntDate?:string,ModDate?:string,SendQuestionnaire?:boolean,RequireUpload?:boolean,UploadMessage?:string,LineImages?:LineImage[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    LocationName;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {number} */
    ServiceDurationMinutes;
    /** @type {number} */
    WaitTime;
    /** @type {number} */
    Cost;
    /** @type {?number} */
    UpperThreshold;
    /** @type {?number} */
    LowerThreshold;
    /** @type {boolean} */
    Active;
    /** @type {?string} */
    EntDate;
    /** @type {?string} */
    ModDate;
    /** @type {boolean} */
    SendQuestionnaire;
    /** @type {boolean} */
    RequireUpload;
    /** @type {string} */
    UploadMessage;
    /** @type {LineImage[]} */
    LineImages = [];
}
export class CheckinInformation {
    /** @param {{Id?:string,LocationId?:string,LocationName?:string,CustomerId?:string,QuestionnaireSubmitted?:boolean,Name?:string,Description?:string,TotalServiceDurationMinutes?:number,TotalCost?:number,SendQuestionnaire?:boolean,RequireUpload?:boolean,Questions?:LineQuestion[],Lines?:Line[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    LocationName;
    /** @type {?string} */
    CustomerId;
    /** @type {?boolean} */
    QuestionnaireSubmitted;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {number} */
    TotalServiceDurationMinutes;
    /** @type {number} */
    TotalCost;
    /** @type {boolean} */
    SendQuestionnaire;
    /** @type {boolean} */
    RequireUpload;
    /** @type {LineQuestion[]} */
    Questions = [];
    /** @type {Line[]} */
    Lines = [];
}
export class CustomerCheckinsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,CustomerCheckins?:CustomerCheckinObject[],CustomerCheckinRequirements?:CheckinInformation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CustomerCheckinObject[]} */
    CustomerCheckins = [];
    /** @type {CheckinInformation} */
    CustomerCheckinRequirements;
}
export class CustomerCheckinsRequest extends CustomerCheckinObject {
    /** @param {{Id?:string,LineId?:string,CustomerId?:string,EmployeeId?:string,LocationId?:string,StationId?:string,SignInTime?:string,AdjustedSignInTime?:string,SendReminders?:boolean,Status?:number,TaskTime?:number,Completed?:boolean,CompletedTime?:string,QuestionnaireSubmitted?:boolean,LineIds?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript CustomerCheckinsRequest 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/GetSingle/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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