Trendsic Platform Service

<back to all web services

CustomersInLine

The following routes are available for this service:
GET/v1/CustomersInLine
GET/v1/CustomersInLine/{LocationId}
CustomersInLine Parameters:
NameParameterData TypeRequiredDescription
ApiKeyqueryGuidNo
LocationIdpathGuidNo
clientIsLoadingqueryboolNo
CustomersInLineResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CustomersformList<CustomerInLineObject>No
LocationNameformstringNo
MonitorShowServicesformbool?No
LobbyformLobbySettingsNo
WorkspaceNameformstringNo
StationTermformstringNo
SessionsformList<StationSessionView>No
CustomerInLineObject Parameters:
NameParameterData TypeRequiredDescription
CheckinIdformGuidNo
VisitKeyformGuid?No
NameformstringNo
SayNameAsformstringNo
LineformstringNo
DescriptionformstringNo
ServiceIdformGuidNo
StatusformintNo
SignInTimeformDateTimeNo
AdjustedSignInTimeformDateTimeNo
ArrivedTimeformDateTime?No
SendRemindersformboolNo
CalledTimeformDateTime?No
TicketLabelformstringNo
StationIdformGuidNo
StationNameformstringNo
IdformGuid?No
FullNameformstringNo
TaskTimeformint?No
Completedformbool?No
CompletedTimeformDateTime?No
EmployeeIdformGuid?No
EmployeeformstringNo
QuestionnaireSubmittedformbool?No
HoldReasonformstringNo
HoldExpectedUtcformDateTime?No
ReturnedTimeformDateTime?No
ContactIdformint?No
MobilePhoneformstringNo
SourceformstringNo
LastMovedFromformstringNo
LastMovedUtcformDateTime?No
PriorityTimeformDateTime?No
HoldByNameformstringNo
HoldByStationNameformstringNo
HoldSinceUtcformDateTime?No
TicketNoformint?No
NoteCountformint?No
HasCarryNoteformbool?No
CarryNoteByformstringNo
CarryNoteAtUtcformDateTime?No
PaperworkAsksformPaperworkAsksNo
DocumentCountformint?No
PaperworkAsks Parameters:
NameParameterData TypeRequiredDescription
QuestionnaireformboolNo
UploadformboolNo
LobbySettings Parameters:
NameParameterData TypeRequiredDescription
LocationIdformGuidNo
WaitSourceformstringNo
MonitorChimeformstringNo
HasUploadedChimeformboolNo
ChimeUrlformstringNo
MonitorVolumeformintNo
MonitorAnnounceformboolNo
MonitorAnnounceTemplateformstringNo
MonitorVoiceformstringNo
MonitorVoiceRateformdecimalNo
MonitorRepeatAfterSecformint?No
MonitorTicketOnlyformboolNo
LobbyZoneModeformstringNo
LobbyTakeoverEveryMinformint?No
LobbyTakeoverSecformint?No
LobbyIdleScreenformboolNo
TimeZoneformstringNo
MonitorShowServicesformbool?No
LobbyTvCountformint?No
TicketPrefixformstringNo
LobbyDensityformstringNo
LobbyIdleModeformstringNo
LobbyIdleContentIdformint?No
StationSessionView Parameters:
NameParameterData TypeRequiredDescription
SessionIdformGuidNo
LocationIdformGuidNo
StationIdformGuidNo
StationNameformstringNo
EmployeeIdformGuidNo
EmployeeNameformstringNo
SignedInUtcformDateTimeNo
LastSeenUtcformDateTimeNo
PausedSinceUtcformDateTime?No
PauseReasonformstringNo
IsMineformboolNo

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/CustomersInLine HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Customers":[{"CheckinId":"00000000000000000000000000000000","VisitKey":"00000000000000000000000000000000","Name":"String","SayNameAs":"String","Line":"String","Description":"String","ServiceId":"00000000000000000000000000000000","Status":0,"SignInTime":"0001-01-01T00:00:00.0000000","AdjustedSignInTime":"0001-01-01T00:00:00.0000000","ArrivedTime":"0001-01-01T00:00:00.0000000","SendReminders":false,"CalledTime":"0001-01-01T00:00:00.0000000","TicketLabel":"String","StationId":"00000000000000000000000000000000","StationName":"String","Id":"00000000000000000000000000000000","FullName":"String","TaskTime":0,"Completed":false,"CompletedTime":"0001-01-01T00:00:00.0000000","EmployeeId":"00000000000000000000000000000000","Employee":"String","QuestionnaireSubmitted":false,"HoldReason":"String","HoldExpectedUtc":"0001-01-01T00:00:00.0000000","ReturnedTime":"0001-01-01T00:00:00.0000000","ContactId":0,"MobilePhone":"String","Source":"String","LastMovedFrom":"String","LastMovedUtc":"0001-01-01T00:00:00.0000000","PriorityTime":"0001-01-01T00:00:00.0000000","HoldByName":"String","HoldByStationName":"String","HoldSinceUtc":"0001-01-01T00:00:00.0000000","TicketNo":0,"NoteCount":0,"HasCarryNote":false,"CarryNoteBy":"String","CarryNoteAtUtc":"0001-01-01T00:00:00.0000000","PaperworkAsks":{"Questionnaire":false,"Upload":false},"DocumentCount":0}],"LocationName":"String","MonitorShowServices":false,"Lobby":{"LocationId":"00000000000000000000000000000000","WaitSource":"String","MonitorChime":"String","HasUploadedChime":false,"ChimeUrl":"String","MonitorVolume":0,"MonitorAnnounce":false,"MonitorAnnounceTemplate":"String","MonitorVoice":"String","MonitorVoiceRate":0,"MonitorRepeatAfterSec":0,"MonitorTicketOnly":false,"LobbyZoneMode":"String","LobbyTakeoverEveryMin":0,"LobbyTakeoverSec":0,"LobbyIdleScreen":false,"TimeZone":"String","MonitorShowServices":false,"LobbyTvCount":0,"TicketPrefix":"String","LobbyDensity":"String","LobbyIdleMode":"String","LobbyIdleContentId":0},"WorkspaceName":"String","StationTerm":"String","Sessions":[{"SessionId":"00000000000000000000000000000000","LocationId":"00000000000000000000000000000000","StationId":"00000000000000000000000000000000","StationName":"String","EmployeeId":"00000000000000000000000000000000","EmployeeName":"String","SignedInUtc":"0001-01-01T00:00:00.0000000","LastSeenUtc":"0001-01-01T00:00:00.0000000","PausedSinceUtc":"0001-01-01T00:00:00.0000000","PauseReason":"String","IsMine":false}]}