Trendsic Platform Service

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

**CustomerCheckins** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	body	Guid	No

**CustomerCheckinObject** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
LineId	form	Guid	No
CustomerId	form	Guid	No
EmployeeId	form	Guid	No
LocationId	form	Guid	No
StationId	form	Guid	No
SignInTime	form	DateTime	No
AdjustedSignInTime	form	DateTime	No
SendReminders	form	bool	No
Status	form	int	No
TaskTime	form	int	No
Completed	form	bool	No
CompletedTime	form	DateTime	No
QuestionnaireSubmitted	form	bool	No
LineIds	form	List<Guid>	No

**CustomerCheckinsResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
CustomerCheckins	form	List<CustomerCheckinObject>	No
CustomerCheckinRequirements	form	CheckinInformation	No

**CheckinInformation** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
LocationId	form	Guid	No
LocationName	form	string	No
CustomerId	form	Guid?	No
QuestionnaireSubmitted	form	bool?	No
Name	form	string	No
Description	form	string	No
TotalServiceDurationMinutes	form	int	No
TotalCost	form	decimal	No
SendQuestionnaire	form	bool	No
RequireUpload	form	bool	No
Questions	form	List<LineQuestion>	No
Lines	form	List<Line>	No

**LineQuestion** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CustomerCheckInId	form	Guid	No
LineId	form	Guid	No
Question	form	string	No
Answer	form	string	No
Active	form	bool	No

**Line** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
LocationId	form	Guid	No
LocationName	form	string	No
Name	form	string	No
Description	form	string	No
ServiceDurationMinutes	form	int	No
WaitTime	form	int	No
Cost	form	decimal	No
UpperThreshold	form	int?	No
LowerThreshold	form	int?	No
Active	form	bool	No
EntDate	form	DateTime?	No
ModDate	form	DateTime?	No
SendQuestionnaire	form	bool	No
RequireUpload	form	bool	No
UploadMessage	form	string	No
LineImages	form	List<LineImage>	No

**LineImage** Parameters:
Name	Parameter	Data Type	Required
ImageId	form	Guid?	No
FileName	form	string	No
ImageTitle	form	string	No
UploadDate	form	DateTime	No

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