| GET | /v1/CustomersInLine | ||
|---|---|---|---|
| GET | /v1/CustomersInLine/{LocationId} |
import Foundation
import ServiceStack
public class CustomersInLine : Codable
{
public var apiKey:String
public var locationId:String
public var clientIsLoading:Bool
required public init(){}
}
public class CustomersInLineResponse : Codable
{
public var responseStatus:ResponseStatus
public var customers:[CustomerInLineObject] = []
public var locationName:String
public var monitorShowServices:Bool?
public var lobby:LobbySettings
public var workspaceName:String
public var stationTerm:String
public var sessions:[StationSessionView] = []
required public init(){}
}
public class CustomerInLineObject : Codable
{
public var checkinId:String
public var visitKey:String?
public var name:String
public var sayNameAs:String
public var line:String
public var Description:String
public var serviceId:String
public var status:Int
public var signInTime:Date
public var adjustedSignInTime:Date
public var arrivedTime:Date?
public var sendReminders:Bool
public var calledTime:Date?
public var ticketLabel:String
public var stationId:String
public var stationName:String
public var id:String?
public var fullName:String
public var taskTime:Int?
public var completed:Bool?
public var completedTime:Date?
public var employeeId:String?
public var employee:String
public var questionnaireSubmitted:Bool?
public var holdReason:String
public var holdExpectedUtc:Date?
public var returnedTime:Date?
public var contactId:Int?
public var mobilePhone:String
public var source:String
public var lastMovedFrom:String
public var lastMovedUtc:Date?
public var priorityTime:Date?
public var holdByName:String
public var holdByStationName:String
public var holdSinceUtc:Date?
public var ticketNo:Int?
public var noteCount:Int?
public var hasCarryNote:Bool?
public var carryNoteBy:String
public var carryNoteAtUtc:Date?
public var paperworkAsks:PaperworkAsks
public var documentCount:Int?
required public init(){}
}
public class PaperworkAsks : Codable
{
public var questionnaire:Bool
public var upload:Bool
required public init(){}
}
public class LobbySettings : Codable
{
public var locationId:String
public var waitSource:String
public var monitorChime:String
public var hasUploadedChime:Bool
public var chimeUrl:String
public var monitorVolume:Int
public var monitorAnnounce:Bool
public var monitorAnnounceTemplate:String
public var monitorVoice:String
public var monitorVoiceLang:String
public var monitorVoiceRate:Double
public var monitorRepeatAfterSec:Int?
public var monitorTicketOnly:Bool
public var lobbyZoneMode:String
public var lobbyTakeoverEveryMin:Int?
public var lobbyTakeoverSec:Int?
public var lobbyIdleScreen:Bool
public var timeZone:String
public var monitorShowServices:Bool?
public var lobbyTvCount:Int?
public var ticketPrefix:String
public var lobbyDensity:String
public var lobbyIdleMode:String
public var lobbyIdleContentId:Int?
required public init(){}
}
public class StationSessionView : Codable
{
public var sessionId:String
public var locationId:String
public var stationId:String
public var stationName:String
public var employeeId:String
public var employeeName:String
public var signedInUtc:Date
public var lastSeenUtc:Date
public var pausedSinceUtc:Date?
public var pauseReason:String
public var homeBranchId:String?
public var homeBranchName:String
public var isMine:Bool
required public init(){}
}
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>