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