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
CustomerCheckins Parameters:
NameParameterData TypeRequiredDescription
ApiKeybodyGuidNo
CustomerCheckinObject Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
LineIdformGuidNo
CustomerIdformGuidNo
EmployeeIdformGuidNo
LocationIdformGuidNo
StationIdformGuidNo
SignInTimeformDateTimeNo
AdjustedSignInTimeformDateTimeNo
SendRemindersformboolNo
StatusformintNo
TaskTimeformintNo
CompletedformboolNo
CompletedTimeformDateTimeNo
QuestionnaireSubmittedformboolNo
LineIdsformList<Guid>No
CustomerCheckinsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CustomerCheckinsformList<CustomerCheckinObject>No
CustomerCheckinRequirementsformCheckinInformationNo
CheckinInformation Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
LocationIdformGuidNo
LocationNameformstringNo
CustomerIdformGuid?No
QuestionnaireSubmittedformbool?No
NameformstringNo
DescriptionformstringNo
TotalServiceDurationMinutesformintNo
TotalCostformdecimalNo
SendQuestionnaireformboolNo
RequireUploadformboolNo
QuestionsformList<LineQuestion>No
LinesformList<Line>No
LineQuestion Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerCheckInIdformGuidNo
LineIdformGuidNo
QuestionformstringNo
AnswerformstringNo
ActiveformboolNo
Line Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
LocationIdformGuidNo
LocationNameformstringNo
NameformstringNo
DescriptionformstringNo
ServiceDurationMinutesformintNo
WaitTimeformintNo
CostformdecimalNo
UpperThresholdformint?No
LowerThresholdformint?No
ActiveformboolNo
EntDateformDateTime?No
ModDateformDateTime?No
SendQuestionnaireformboolNo
RequireUploadformboolNo
UploadMessageformstringNo
LineImagesformList<LineImage>No
LineImage Parameters:
NameParameterData TypeRequiredDescription
ImageIdformGuid?No
FileNameformstringNo
ImageTitleformstringNo
UploadDateformDateTimeNo

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","CustomerId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","LocationId":"00000000000000000000000000000000","StationId":"00000000000000000000000000000000","SignInTime":"0001-01-01T00:00:00.0000000","AdjustedSignInTime":"0001-01-01T00:00:00.0000000","SendReminders":false,"Status":0,"TaskTime":0,"Completed":false,"CompletedTime":"0001-01-01T00:00:00.0000000","QuestionnaireSubmitted":false,"LineIds":["00000000000000000000000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","AdjustedSignInTime":"0001-01-01T00:00:00.0000000","SendReminders":false,"Status":0,"TaskTime":0,"Completed":false,"CompletedTime":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","SendQuestionnaire":false,"RequireUpload":false,"UploadMessage":"String","LineImages":[{"ImageId":"00000000000000000000000000000000","FileName":"String","ImageTitle":"String","UploadDate":"0001-01-01T00:00:00.0000000"}]}]}}