| GET | /v1/CustomersInLine | ||
|---|---|---|---|
| GET | /v1/CustomersInLine/{LocationId} |
"use strict";
export class PaperworkAsks {
/** @param {{Questionnaire?:boolean,Upload?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Questionnaire;
/** @type {boolean} */
Upload;
}
export class CustomerInLineObject {
/** @param {{CheckinId?:string,VisitKey?:string,Name?:string,SayNameAs?:string,Line?:string,Description?:string,ServiceId?:string,Status?:number,SignInTime?:string,AdjustedSignInTime?:string,ArrivedTime?:string,SendReminders?:boolean,CalledTime?:string,TicketLabel?:string,StationId?:string,StationName?:string,Id?:string,FullName?:string,TaskTime?:number,Completed?:boolean,CompletedTime?:string,EmployeeId?:string,Employee?:string,QuestionnaireSubmitted?:boolean,HoldReason?:string,HoldExpectedUtc?:string,ReturnedTime?:string,ContactId?:number,MobilePhone?:string,Source?:string,LastMovedFrom?:string,LastMovedUtc?:string,PriorityTime?:string,HoldByName?:string,HoldByStationName?:string,HoldSinceUtc?:string,TicketNo?:number,NoteCount?:number,HasCarryNote?:boolean,CarryNoteBy?:string,CarryNoteAtUtc?:string,PaperworkAsks?:PaperworkAsks,DocumentCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CheckinId;
/** @type {?string} */
VisitKey;
/** @type {string} */
Name;
/** @type {string} */
SayNameAs;
/** @type {string} */
Line;
/** @type {string} */
Description;
/** @type {string} */
ServiceId;
/** @type {number} */
Status;
/** @type {string} */
SignInTime;
/** @type {string} */
AdjustedSignInTime;
/** @type {?string} */
ArrivedTime;
/** @type {boolean} */
SendReminders;
/** @type {?string} */
CalledTime;
/** @type {string} */
TicketLabel;
/** @type {string} */
StationId;
/** @type {string} */
StationName;
/** @type {?string} */
Id;
/** @type {string} */
FullName;
/** @type {?number} */
TaskTime;
/** @type {?boolean} */
Completed;
/** @type {?string} */
CompletedTime;
/** @type {?string} */
EmployeeId;
/** @type {string} */
Employee;
/** @type {?boolean} */
QuestionnaireSubmitted;
/** @type {string} */
HoldReason;
/** @type {?string} */
HoldExpectedUtc;
/** @type {?string} */
ReturnedTime;
/** @type {?number} */
ContactId;
/** @type {string} */
MobilePhone;
/** @type {string} */
Source;
/** @type {string} */
LastMovedFrom;
/** @type {?string} */
LastMovedUtc;
/** @type {?string} */
PriorityTime;
/** @type {string} */
HoldByName;
/** @type {string} */
HoldByStationName;
/** @type {?string} */
HoldSinceUtc;
/** @type {?number} */
TicketNo;
/** @type {?number} */
NoteCount;
/** @type {?boolean} */
HasCarryNote;
/** @type {string} */
CarryNoteBy;
/** @type {?string} */
CarryNoteAtUtc;
/** @type {PaperworkAsks} */
PaperworkAsks;
/** @type {?number} */
DocumentCount;
}
export class LobbySettings {
/** @param {{LocationId?:string,WaitSource?:string,MonitorChime?:string,HasUploadedChime?:boolean,ChimeUrl?:string,MonitorVolume?:number,MonitorAnnounce?:boolean,MonitorAnnounceTemplate?:string,MonitorVoice?:string,MonitorVoiceLang?:string,MonitorVoiceRate?:number,MonitorRepeatAfterSec?:number,MonitorTicketOnly?:boolean,LobbyZoneMode?:string,LobbyTakeoverEveryMin?:number,LobbyTakeoverSec?:number,LobbyIdleScreen?:boolean,TimeZone?:string,MonitorShowServices?:boolean,LobbyTvCount?:number,TicketPrefix?:string,LobbyDensity?:string,LobbyIdleMode?:string,LobbyIdleContentId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LocationId;
/** @type {string} */
WaitSource;
/** @type {string} */
MonitorChime;
/** @type {boolean} */
HasUploadedChime;
/** @type {string} */
ChimeUrl;
/** @type {number} */
MonitorVolume;
/** @type {boolean} */
MonitorAnnounce;
/** @type {string} */
MonitorAnnounceTemplate;
/** @type {string} */
MonitorVoice;
/** @type {string} */
MonitorVoiceLang;
/** @type {number} */
MonitorVoiceRate;
/** @type {?number} */
MonitorRepeatAfterSec;
/** @type {boolean} */
MonitorTicketOnly;
/** @type {string} */
LobbyZoneMode;
/** @type {?number} */
LobbyTakeoverEveryMin;
/** @type {?number} */
LobbyTakeoverSec;
/** @type {boolean} */
LobbyIdleScreen;
/** @type {string} */
TimeZone;
/** @type {?boolean} */
MonitorShowServices;
/** @type {?number} */
LobbyTvCount;
/** @type {string} */
TicketPrefix;
/** @type {string} */
LobbyDensity;
/** @type {string} */
LobbyIdleMode;
/** @type {?number} */
LobbyIdleContentId;
}
export class StationSessionView {
/** @param {{SessionId?:string,LocationId?:string,StationId?:string,StationName?:string,EmployeeId?:string,EmployeeName?:string,SignedInUtc?:string,LastSeenUtc?:string,PausedSinceUtc?:string,PauseReason?:string,HomeBranchId?:string,HomeBranchName?:string,IsMine?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SessionId;
/** @type {string} */
LocationId;
/** @type {string} */
StationId;
/** @type {string} */
StationName;
/** @type {string} */
EmployeeId;
/** @type {string} */
EmployeeName;
/** @type {string} */
SignedInUtc;
/** @type {string} */
LastSeenUtc;
/** @type {?string} */
PausedSinceUtc;
/** @type {string} */
PauseReason;
/** @type {?string} */
HomeBranchId;
/** @type {string} */
HomeBranchName;
/** @type {boolean} */
IsMine;
}
export class CustomersInLineResponse {
/** @param {{ResponseStatus?:ResponseStatus,Customers?:CustomerInLineObject[],LocationName?:string,MonitorShowServices?:boolean,Lobby?:LobbySettings,WorkspaceName?:string,StationTerm?:string,Sessions?:StationSessionView[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {CustomerInLineObject[]} */
Customers = [];
/** @type {string} */
LocationName;
/** @type {?boolean} */
MonitorShowServices;
/** @type {LobbySettings} */
Lobby;
/** @type {string} */
WorkspaceName;
/** @type {string} */
StationTerm;
/** @type {StationSessionView[]} */
Sessions = [];
}
export class CustomersInLine {
/** @param {{ApiKey?:string,LocationId?:string,clientIsLoading?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ApiKey;
/** @type {string} */
LocationId;
/** @type {boolean} */
clientIsLoading;
}
JavaScript CustomersInLine DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomersInLineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Customers>
<CustomerInLineObject>
<AdjustedSignInTime>0001-01-01T00:00:00</AdjustedSignInTime>
<ArrivedTime>0001-01-01T00:00:00</ArrivedTime>
<CalledTime>0001-01-01T00:00:00</CalledTime>
<CarryNoteAtUtc>0001-01-01T00:00:00</CarryNoteAtUtc>
<CarryNoteBy>String</CarryNoteBy>
<CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
<Completed>false</Completed>
<CompletedTime>0001-01-01T00:00:00</CompletedTime>
<ContactId>0</ContactId>
<Description>String</Description>
<DocumentCount>0</DocumentCount>
<Employee>String</Employee>
<EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
<FullName>String</FullName>
<HasCarryNote>false</HasCarryNote>
<HoldByName>String</HoldByName>
<HoldByStationName>String</HoldByStationName>
<HoldExpectedUtc>0001-01-01T00:00:00</HoldExpectedUtc>
<HoldReason>String</HoldReason>
<HoldSinceUtc>0001-01-01T00:00:00</HoldSinceUtc>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LastMovedFrom>String</LastMovedFrom>
<LastMovedUtc>0001-01-01T00:00:00</LastMovedUtc>
<Line>String</Line>
<MobilePhone>String</MobilePhone>
<Name>String</Name>
<NoteCount>0</NoteCount>
<PaperworkAsks>
<Questionnaire>false</Questionnaire>
<Upload>false</Upload>
</PaperworkAsks>
<PriorityTime>0001-01-01T00:00:00</PriorityTime>
<QuestionnaireSubmitted>false</QuestionnaireSubmitted>
<ReturnedTime>0001-01-01T00:00:00</ReturnedTime>
<SayNameAs>String</SayNameAs>
<SendReminders>false</SendReminders>
<ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
<SignInTime>0001-01-01T00:00:00</SignInTime>
<Source>String</Source>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<StationName>String</StationName>
<Status>0</Status>
<TaskTime>0</TaskTime>
<TicketLabel>String</TicketLabel>
<TicketNo>0</TicketNo>
<VisitKey>00000000-0000-0000-0000-000000000000</VisitKey>
</CustomerInLineObject>
</Customers>
<Lobby>
<ChimeUrl>String</ChimeUrl>
<HasUploadedChime>false</HasUploadedChime>
<LobbyDensity>String</LobbyDensity>
<LobbyIdleContentId>0</LobbyIdleContentId>
<LobbyIdleMode>String</LobbyIdleMode>
<LobbyIdleScreen>false</LobbyIdleScreen>
<LobbyTakeoverEveryMin>0</LobbyTakeoverEveryMin>
<LobbyTakeoverSec>0</LobbyTakeoverSec>
<LobbyTvCount>0</LobbyTvCount>
<LobbyZoneMode>String</LobbyZoneMode>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<MonitorAnnounce>false</MonitorAnnounce>
<MonitorAnnounceTemplate>String</MonitorAnnounceTemplate>
<MonitorChime>String</MonitorChime>
<MonitorRepeatAfterSec>0</MonitorRepeatAfterSec>
<MonitorShowServices>false</MonitorShowServices>
<MonitorTicketOnly>false</MonitorTicketOnly>
<MonitorVoice>String</MonitorVoice>
<MonitorVoiceLang>String</MonitorVoiceLang>
<MonitorVoiceRate>0</MonitorVoiceRate>
<MonitorVolume>0</MonitorVolume>
<TicketPrefix>String</TicketPrefix>
<TimeZone>String</TimeZone>
<WaitSource>String</WaitSource>
</Lobby>
<LocationName>String</LocationName>
<MonitorShowServices>false</MonitorShowServices>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Sessions>
<StationSessionView>
<EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
<EmployeeName>String</EmployeeName>
<HomeBranchId>00000000-0000-0000-0000-000000000000</HomeBranchId>
<HomeBranchName>String</HomeBranchName>
<IsMine>false</IsMine>
<LastSeenUtc>0001-01-01T00:00:00</LastSeenUtc>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<PauseReason>String</PauseReason>
<PausedSinceUtc>0001-01-01T00:00:00</PausedSinceUtc>
<SessionId>00000000-0000-0000-0000-000000000000</SessionId>
<SignedInUtc>0001-01-01T00:00:00</SignedInUtc>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<StationName>String</StationName>
</StationSessionView>
</Sessions>
<StationTerm>String</StationTerm>
<WorkspaceName>String</WorkspaceName>
</CustomersInLineResponse>