Trendsic Platform Service

CustomersInLine

The following routes are available for this service:
GET	/v1/CustomersInLine
GET	/v1/CustomersInLine/{LocationId}

**CustomersInLine** Parameters:
Name	Parameter	Data Type	Required
ApiKey	query	Guid	No
LocationId	path	Guid	No
clientIsLoading	query	bool	No

**CustomersInLineResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Customers	form	List<CustomerInLineObject>	No
LocationName	form	string	No
MonitorShowServices	form	bool?	No
Lobby	form	LobbySettings	No
WorkspaceName	form	string	No
StationTerm	form	string	No
Sessions	form	List<StationSessionView>	No

**CustomerInLineObject** Parameters:
Name	Parameter	Data Type	Required
CheckinId	form	Guid	No
VisitKey	form	Guid?	No
Name	form	string	No
SayNameAs	form	string	No
Line	form	string	No
Description	form	string	No
ServiceId	form	Guid	No
Status	form	int	No
SignInTime	form	DateTime	No
AdjustedSignInTime	form	DateTime	No
ArrivedTime	form	DateTime?	No
SendReminders	form	bool	No
CalledTime	form	DateTime?	No
TicketLabel	form	string	No
StationId	form	Guid	No
StationName	form	string	No
Id	form	Guid?	No
FullName	form	string	No
TaskTime	form	int?	No
Completed	form	bool?	No
CompletedTime	form	DateTime?	No
EmployeeId	form	Guid?	No
Employee	form	string	No
QuestionnaireSubmitted	form	bool?	No
HoldReason	form	string	No
HoldExpectedUtc	form	DateTime?	No
ReturnedTime	form	DateTime?	No
ContactId	form	int?	No
MobilePhone	form	string	No
Source	form	string	No
LastMovedFrom	form	string	No
LastMovedUtc	form	DateTime?	No
PriorityTime	form	DateTime?	No
HoldByName	form	string	No
HoldByStationName	form	string	No
HoldSinceUtc	form	DateTime?	No
TicketNo	form	int?	No
NoteCount	form	int?	No
HasCarryNote	form	bool?	No
CarryNoteBy	form	string	No
CarryNoteAtUtc	form	DateTime?	No
PaperworkAsks	form	PaperworkAsks	No
DocumentCount	form	int?	No

**PaperworkAsks** Parameters:
Name	Parameter	Data Type	Required	Description
Questionnaire	form	bool	No
Upload	form	bool	No

**LobbySettings** Parameters:
Name	Parameter	Data Type	Required
LocationId	form	Guid	No
WaitSource	form	string	No
MonitorChime	form	string	No
HasUploadedChime	form	bool	No
ChimeUrl	form	string	No
MonitorVolume	form	int	No
MonitorAnnounce	form	bool	No
MonitorAnnounceTemplate	form	string	No
MonitorVoice	form	string	No
MonitorVoiceLang	form	string	No
MonitorVoiceRate	form	decimal	No
MonitorRepeatAfterSec	form	int?	No
MonitorTicketOnly	form	bool	No
LobbyZoneMode	form	string	No
LobbyTakeoverEveryMin	form	int?	No
LobbyTakeoverSec	form	int?	No
LobbyIdleScreen	form	bool	No
TimeZone	form	string	No
MonitorShowServices	form	bool?	No
LobbyTvCount	form	int?	No
TicketPrefix	form	string	No
LobbyDensity	form	string	No
LobbyIdleMode	form	string	No
LobbyIdleContentId	form	int?	No

**StationSessionView** Parameters:
Name	Parameter	Data Type	Required
SessionId	form	Guid	No
LocationId	form	Guid	No
StationId	form	Guid	No
StationName	form	string	No
EmployeeId	form	Guid	No
EmployeeName	form	string	No
SignedInUtc	form	DateTime	No
LastSeenUtc	form	DateTime	No
PausedSinceUtc	form	DateTime?	No
PauseReason	form	string	No
HomeBranchId	form	Guid?	No
HomeBranchName	form	string	No
IsMine	form	bool	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.

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

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
		}
	},
	Customers: 
	[
		{
			CheckinId: 00000000000000000000000000000000,
			VisitKey: 00000000000000000000000000000000,
			Name: String,
			SayNameAs: String,
			Line: String,
			Description: String,
			ServiceId: 00000000000000000000000000000000,
			Status: 0,
			SignInTime: 0001-01-01,
			AdjustedSignInTime: 0001-01-01,
			ArrivedTime: 0001-01-01,
			SendReminders: False,
			CalledTime: 0001-01-01,
			TicketLabel: String,
			StationId: 00000000000000000000000000000000,
			StationName: String,
			Id: 00000000000000000000000000000000,
			FullName: String,
			TaskTime: 0,
			Completed: False,
			CompletedTime: 0001-01-01,
			EmployeeId: 00000000000000000000000000000000,
			Employee: String,
			QuestionnaireSubmitted: False,
			HoldReason: String,
			HoldExpectedUtc: 0001-01-01,
			ReturnedTime: 0001-01-01,
			ContactId: 0,
			MobilePhone: String,
			Source: String,
			LastMovedFrom: String,
			LastMovedUtc: 0001-01-01,
			PriorityTime: 0001-01-01,
			HoldByName: String,
			HoldByStationName: String,
			HoldSinceUtc: 0001-01-01,
			TicketNo: 0,
			NoteCount: 0,
			HasCarryNote: False,
			CarryNoteBy: String,
			CarryNoteAtUtc: 0001-01-01,
			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,
		MonitorVoiceLang: 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-01,
			LastSeenUtc: 0001-01-01,
			PausedSinceUtc: 0001-01-01,
			PauseReason: String,
			HomeBranchId: 00000000000000000000000000000000,
			HomeBranchName: String,
			IsMine: False
		}
	]
}