Trendsic Platform Service

<back to all web services

CustomersInLine

The following routes are available for this service:
GET/v1/CustomersInLine
GET/v1/CustomersInLine/{LocationId}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CustomerInLineObject
    {
        public virtual Guid CheckinId { get; set; }
        public virtual Guid? VisitKey { get; set; }
        public virtual string Name { get; set; }
        public virtual string SayNameAs { get; set; }
        public virtual string Line { get; set; }
        public virtual string Description { get; set; }
        public virtual Guid ServiceId { get; set; }
        public virtual int Status { get; set; }
        public virtual DateTime SignInTime { get; set; }
        public virtual DateTime AdjustedSignInTime { get; set; }
        public virtual DateTime? ArrivedTime { get; set; }
        public virtual bool SendReminders { get; set; }
        public virtual DateTime? CalledTime { get; set; }
        public virtual string TicketLabel { get; set; }
        public virtual Guid StationId { get; set; }
        public virtual string StationName { get; set; }
        public virtual Guid? Id { get; set; }
        public virtual string FullName { get; set; }
        public virtual int? TaskTime { get; set; }
        public virtual bool? Completed { get; set; }
        public virtual DateTime? CompletedTime { get; set; }
        public virtual Guid? EmployeeId { get; set; }
        public virtual string Employee { get; set; }
        public virtual bool? QuestionnaireSubmitted { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? HoldExpectedUtc { get; set; }
        public virtual DateTime? ReturnedTime { get; set; }
        public virtual int? ContactId { get; set; }
        public virtual string MobilePhone { get; set; }
        public virtual string Source { get; set; }
        public virtual string LastMovedFrom { get; set; }
        public virtual DateTime? LastMovedUtc { get; set; }
        public virtual DateTime? PriorityTime { get; set; }
        public virtual string HoldByName { get; set; }
        public virtual string HoldByStationName { get; set; }
        public virtual DateTime? HoldSinceUtc { get; set; }
        public virtual int? TicketNo { get; set; }
        public virtual int? NoteCount { get; set; }
        public virtual bool? HasCarryNote { get; set; }
        public virtual string CarryNoteBy { get; set; }
        public virtual DateTime? CarryNoteAtUtc { get; set; }
        public virtual PaperworkAsks PaperworkAsks { get; set; }
        public virtual int? DocumentCount { get; set; }
    }

    public partial class CustomersInLine
    {
        public virtual Guid ApiKey { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual bool clientIsLoading { get; set; }
    }

    public partial class CustomersInLineResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<CustomerInLineObject> Customers { get; set; } = [];
        public virtual string LocationName { get; set; }
        public virtual bool? MonitorShowServices { get; set; }
        public virtual LobbySettings Lobby { get; set; }
        public virtual string WorkspaceName { get; set; }
        public virtual string StationTerm { get; set; }
        public virtual List<StationSessionView> Sessions { get; set; } = [];
    }

    public partial class LobbySettings
    {
        public virtual Guid LocationId { get; set; }
        public virtual string WaitSource { get; set; }
        public virtual string MonitorChime { get; set; }
        public virtual bool HasUploadedChime { get; set; }
        public virtual string ChimeUrl { get; set; }
        public virtual int MonitorVolume { get; set; }
        public virtual bool MonitorAnnounce { get; set; }
        public virtual string MonitorAnnounceTemplate { get; set; }
        public virtual string MonitorVoice { get; set; }
        public virtual string MonitorVoiceLang { get; set; }
        public virtual decimal MonitorVoiceRate { get; set; }
        public virtual int? MonitorRepeatAfterSec { get; set; }
        public virtual bool MonitorTicketOnly { get; set; }
        public virtual string LobbyZoneMode { get; set; }
        public virtual int? LobbyTakeoverEveryMin { get; set; }
        public virtual int? LobbyTakeoverSec { get; set; }
        public virtual bool LobbyIdleScreen { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual bool? MonitorShowServices { get; set; }
        public virtual int? LobbyTvCount { get; set; }
        public virtual string TicketPrefix { get; set; }
        public virtual string LobbyDensity { get; set; }
        public virtual string LobbyIdleMode { get; set; }
        public virtual int? LobbyIdleContentId { get; set; }
    }

    public partial class PaperworkAsks
    {
        public virtual bool Questionnaire { get; set; }
        public virtual bool Upload { get; set; }
    }

    public partial class StationSessionView
    {
        public virtual Guid SessionId { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual Guid StationId { get; set; }
        public virtual string StationName { get; set; }
        public virtual Guid EmployeeId { get; set; }
        public virtual string EmployeeName { get; set; }
        public virtual DateTime SignedInUtc { get; set; }
        public virtual DateTime LastSeenUtc { get; set; }
        public virtual DateTime? PausedSinceUtc { get; set; }
        public virtual string PauseReason { get; set; }
        public virtual Guid? HomeBranchId { get; set; }
        public virtual string HomeBranchName { get; set; }
        public virtual bool IsMine { get; set; }
    }

}

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