Trendsic Platform Service

<back to all web services

CustomersInLine

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

export class PaperworkAsks
{
    public Questionnaire: boolean;
    public Upload: boolean;

    public constructor(init?: Partial<PaperworkAsks>) { (Object as any).assign(this, init); }
}

export class CustomerInLineObject
{
    public CheckinId: string;
    public VisitKey?: string;
    public Name: string;
    public SayNameAs: string;
    public Line: string;
    public Description: string;
    public ServiceId: string;
    public Status: number;
    public SignInTime: string;
    public AdjustedSignInTime: string;
    public ArrivedTime?: string;
    public SendReminders: boolean;
    public CalledTime?: string;
    public TicketLabel: string;
    public StationId: string;
    public StationName: string;
    public Id?: string;
    public FullName: string;
    public TaskTime?: number;
    public Completed?: boolean;
    public CompletedTime?: string;
    public EmployeeId?: string;
    public Employee: string;
    public QuestionnaireSubmitted?: boolean;
    public HoldReason: string;
    public HoldExpectedUtc?: string;
    public ReturnedTime?: string;
    public ContactId?: number;
    public MobilePhone: string;
    public Source: string;
    public LastMovedFrom: string;
    public LastMovedUtc?: string;
    public PriorityTime?: string;
    public HoldByName: string;
    public HoldByStationName: string;
    public HoldSinceUtc?: string;
    public TicketNo?: number;
    public NoteCount?: number;
    public HasCarryNote?: boolean;
    public CarryNoteBy: string;
    public CarryNoteAtUtc?: string;
    public PaperworkAsks: PaperworkAsks;
    public DocumentCount?: number;

    public constructor(init?: Partial<CustomerInLineObject>) { (Object as any).assign(this, init); }
}

export class LobbySettings
{
    public LocationId: string;
    public WaitSource: string;
    public MonitorChime: string;
    public HasUploadedChime: boolean;
    public ChimeUrl: string;
    public MonitorVolume: number;
    public MonitorAnnounce: boolean;
    public MonitorAnnounceTemplate: string;
    public MonitorVoice: string;
    public MonitorVoiceLang: string;
    public MonitorVoiceRate: number;
    public MonitorRepeatAfterSec?: number;
    public MonitorTicketOnly: boolean;
    public LobbyZoneMode: string;
    public LobbyTakeoverEveryMin?: number;
    public LobbyTakeoverSec?: number;
    public LobbyIdleScreen: boolean;
    public TimeZone: string;
    public MonitorShowServices?: boolean;
    public LobbyTvCount?: number;
    public TicketPrefix: string;
    public LobbyDensity: string;
    public LobbyIdleMode: string;
    public LobbyIdleContentId?: number;

    public constructor(init?: Partial<LobbySettings>) { (Object as any).assign(this, init); }
}

export class StationSessionView
{
    public SessionId: string;
    public LocationId: string;
    public StationId: string;
    public StationName: string;
    public EmployeeId: string;
    public EmployeeName: string;
    public SignedInUtc: string;
    public LastSeenUtc: string;
    public PausedSinceUtc?: string;
    public PauseReason: string;
    public HomeBranchId?: string;
    public HomeBranchName: string;
    public IsMine: boolean;

    public constructor(init?: Partial<StationSessionView>) { (Object as any).assign(this, init); }
}

export class CustomersInLineResponse
{
    public ResponseStatus: ResponseStatus;
    public Customers: CustomerInLineObject[] = [];
    public LocationName: string;
    public MonitorShowServices?: boolean;
    public Lobby: LobbySettings;
    public WorkspaceName: string;
    public StationTerm: string;
    public Sessions: StationSessionView[] = [];

    public constructor(init?: Partial<CustomersInLineResponse>) { (Object as any).assign(this, init); }
}

export class CustomersInLine
{
    public ApiKey: string;
    public LocationId: string;
    public clientIsLoading: boolean;

    public constructor(init?: Partial<CustomersInLine>) { (Object as any).assign(this, init); }
}

TypeScript CustomersInLine DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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","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-01T00:00:00.0000000","LastSeenUtc":"0001-01-01T00:00:00.0000000","PausedSinceUtc":"0001-01-01T00:00:00.0000000","PauseReason":"String","HomeBranchId":"00000000000000000000000000000000","HomeBranchName":"String","IsMine":false}]}