Trendsic Platform Service

<back to all web services

CustomersInLine

The following routes are available for this service:
GET/v1/CustomersInLine
GET/v1/CustomersInLine/{LocationId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CustomersInLine
{
    open var ApiKey:UUID? = null
    open var LocationId:UUID? = null
    open var clientIsLoading:Boolean? = null
}

open class CustomersInLineResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Customers:ArrayList<CustomerInLineObject> = ArrayList<CustomerInLineObject>()
    open var LocationName:String? = null
    open var MonitorShowServices:Boolean? = null
    open var Lobby:LobbySettings? = null
    open var WorkspaceName:String? = null
    open var StationTerm:String? = null
    open var Sessions:ArrayList<StationSessionView> = ArrayList<StationSessionView>()
}

open class CustomerInLineObject
{
    open var CheckinId:UUID? = null
    open var VisitKey:UUID? = null
    open var Name:String? = null
    open var SayNameAs:String? = null
    open var Line:String? = null
    open var Description:String? = null
    open var ServiceId:UUID? = null
    open var Status:Int? = null
    open var SignInTime:Date? = null
    open var AdjustedSignInTime:Date? = null
    open var ArrivedTime:Date? = null
    open var SendReminders:Boolean? = null
    open var CalledTime:Date? = null
    open var TicketLabel:String? = null
    open var StationId:UUID? = null
    open var StationName:String? = null
    open var Id:UUID? = null
    open var FullName:String? = null
    open var TaskTime:Int? = null
    open var Completed:Boolean? = null
    open var CompletedTime:Date? = null
    open var EmployeeId:UUID? = null
    open var Employee:String? = null
    open var QuestionnaireSubmitted:Boolean? = null
    open var HoldReason:String? = null
    open var HoldExpectedUtc:Date? = null
    open var ReturnedTime:Date? = null
    open var ContactId:Int? = null
    open var MobilePhone:String? = null
    open var Source:String? = null
    open var LastMovedFrom:String? = null
    open var LastMovedUtc:Date? = null
    open var PriorityTime:Date? = null
    open var HoldByName:String? = null
    open var HoldByStationName:String? = null
    open var HoldSinceUtc:Date? = null
    open var TicketNo:Int? = null
    open var NoteCount:Int? = null
    open var HasCarryNote:Boolean? = null
    open var CarryNoteBy:String? = null
    open var CarryNoteAtUtc:Date? = null
    open var PaperworkAsks:PaperworkAsks? = null
    open var DocumentCount:Int? = null
}

open class PaperworkAsks
{
    open var Questionnaire:Boolean? = null
    open var Upload:Boolean? = null
}

open class LobbySettings
{
    open var LocationId:UUID? = null
    open var WaitSource:String? = null
    open var MonitorChime:String? = null
    open var HasUploadedChime:Boolean? = null
    open var ChimeUrl:String? = null
    open var MonitorVolume:Int? = null
    open var MonitorAnnounce:Boolean? = null
    open var MonitorAnnounceTemplate:String? = null
    open var MonitorVoice:String? = null
    open var MonitorVoiceLang:String? = null
    open var MonitorVoiceRate:BigDecimal? = null
    open var MonitorRepeatAfterSec:Int? = null
    open var MonitorTicketOnly:Boolean? = null
    open var LobbyZoneMode:String? = null
    open var LobbyTakeoverEveryMin:Int? = null
    open var LobbyTakeoverSec:Int? = null
    open var LobbyIdleScreen:Boolean? = null
    open var TimeZone:String? = null
    open var MonitorShowServices:Boolean? = null
    open var LobbyTvCount:Int? = null
    open var TicketPrefix:String? = null
    open var LobbyDensity:String? = null
    open var LobbyIdleMode:String? = null
    open var LobbyIdleContentId:Int? = null
}

open class StationSessionView
{
    open var SessionId:UUID? = null
    open var LocationId:UUID? = null
    open var StationId:UUID? = null
    open var StationName:String? = null
    open var EmployeeId:UUID? = null
    open var EmployeeName:String? = null
    open var SignedInUtc:Date? = null
    open var LastSeenUtc:Date? = null
    open var PausedSinceUtc:Date? = null
    open var PauseReason:String? = null
    open var HomeBranchId:UUID? = null
    open var HomeBranchName:String? = null
    open var IsMine:Boolean? = null
}

Kotlin CustomersInLine 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.

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