Trendsic Platform Service

<back to all web services

CustomersInLine

The following routes are available for this service:
GET/v1/CustomersInLine
GET/v1/CustomersInLine/{LocationId}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PaperworkAsks() = 
        member val Questionnaire:Boolean = new Boolean() with get,set
        member val Upload:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CustomerInLineObject() = 
        member val CheckinId:Guid = new Guid() with get,set
        member val VisitKey:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Name:String = null with get,set
        member val SayNameAs:String = null with get,set
        member val Line:String = null with get,set
        member val Description:String = null with get,set
        member val ServiceId:Guid = new Guid() with get,set
        member val Status:Int32 = new Int32() with get,set
        member val SignInTime:DateTime = new DateTime() with get,set
        member val AdjustedSignInTime:DateTime = new DateTime() with get,set
        member val ArrivedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SendReminders:Boolean = new Boolean() with get,set
        member val CalledTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TicketLabel:String = null with get,set
        member val StationId:Guid = new Guid() with get,set
        member val StationName:String = null with get,set
        member val Id:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val FullName:String = null with get,set
        member val TaskTime:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Completed:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val CompletedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EmployeeId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Employee:String = null with get,set
        member val QuestionnaireSubmitted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val HoldReason:String = null with get,set
        member val HoldExpectedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ReturnedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MobilePhone:String = null with get,set
        member val Source:String = null with get,set
        member val LastMovedFrom:String = null with get,set
        member val LastMovedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PriorityTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val HoldByName:String = null with get,set
        member val HoldByStationName:String = null with get,set
        member val HoldSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TicketNo:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val NoteCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HasCarryNote:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val CarryNoteBy:String = null with get,set
        member val CarryNoteAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PaperworkAsks:PaperworkAsks = null with get,set
        member val DocumentCount:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type LobbySettings() = 
        member val LocationId:Guid = new Guid() with get,set
        member val WaitSource:String = null with get,set
        member val MonitorChime:String = null with get,set
        member val HasUploadedChime:Boolean = new Boolean() with get,set
        member val ChimeUrl:String = null with get,set
        member val MonitorVolume:Int32 = new Int32() with get,set
        member val MonitorAnnounce:Boolean = new Boolean() with get,set
        member val MonitorAnnounceTemplate:String = null with get,set
        member val MonitorVoice:String = null with get,set
        member val MonitorVoiceLang:String = null with get,set
        member val MonitorVoiceRate:Decimal = new Decimal() with get,set
        member val MonitorRepeatAfterSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MonitorTicketOnly:Boolean = new Boolean() with get,set
        member val LobbyZoneMode:String = null with get,set
        member val LobbyTakeoverEveryMin:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LobbyTakeoverSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LobbyIdleScreen:Boolean = new Boolean() with get,set
        member val TimeZone:String = null with get,set
        member val MonitorShowServices:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val LobbyTvCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TicketPrefix:String = null with get,set
        member val LobbyDensity:String = null with get,set
        member val LobbyIdleMode:String = null with get,set
        member val LobbyIdleContentId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type StationSessionView() = 
        member val SessionId:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val StationId:Guid = new Guid() with get,set
        member val StationName:String = null with get,set
        member val EmployeeId:Guid = new Guid() with get,set
        member val EmployeeName:String = null with get,set
        member val SignedInUtc:DateTime = new DateTime() with get,set
        member val LastSeenUtc:DateTime = new DateTime() with get,set
        member val PausedSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PauseReason:String = null with get,set
        member val HomeBranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val HomeBranchName:String = null with get,set
        member val IsMine:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CustomersInLineResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Customers:ResizeArray<CustomerInLineObject> = new ResizeArray<CustomerInLineObject>() with get,set
        member val LocationName:String = null with get,set
        member val MonitorShowServices:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Lobby:LobbySettings = null with get,set
        member val WorkspaceName:String = null with get,set
        member val StationTerm:String = null with get,set
        member val Sessions:ResizeArray<StationSessionView> = new ResizeArray<StationSessionView>() with get,set

    [<AllowNullLiteral>]
    type CustomersInLine() = 
        member val ApiKey:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val clientIsLoading:Boolean = new Boolean() with get,set

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