Trendsic Platform Service

<back to all web services

CustomersInLine

The following routes are available for this service:
GET/v1/CustomersInLine
GET/v1/CustomersInLine/{LocationId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CustomersInLine
{
    open var ApiKey:UUID? = null
    open var LocationId:UUID? = null
    open var clientIsLoading:Boolean? = null
}

open class CustomersInLineResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Customers:ArrayList<CustomerInLineObject> = ArrayList<CustomerInLineObject>()
    open var LocationName:String? = null
    open var MonitorShowServices:Boolean? = null
    open var Lobby:LobbySettings? = null
    open var WorkspaceName:String? = null
    open var StationTerm:String? = null
    open var Sessions:ArrayList<StationSessionView> = ArrayList<StationSessionView>()
}

open class CustomerInLineObject
{
    open var CheckinId:UUID? = null
    open var VisitKey:UUID? = null
    open var Name:String? = null
    open var SayNameAs:String? = null
    open var Line:String? = null
    open var Description:String? = null
    open var ServiceId:UUID? = null
    open var Status:Int? = null
    open var SignInTime:Date? = null
    open var AdjustedSignInTime:Date? = null
    open var ArrivedTime:Date? = null
    open var SendReminders:Boolean? = null
    open var CalledTime:Date? = null
    open var TicketLabel:String? = null
    open var StationId:UUID? = null
    open var StationName:String? = null
    open var Id:UUID? = null
    open var FullName:String? = null
    open var TaskTime:Int? = null
    open var Completed:Boolean? = null
    open var CompletedTime:Date? = null
    open var EmployeeId:UUID? = null
    open var Employee:String? = null
    open var QuestionnaireSubmitted:Boolean? = null
    open var HoldReason:String? = null
    open var HoldExpectedUtc:Date? = null
    open var ReturnedTime:Date? = null
    open var ContactId:Int? = null
    open var MobilePhone:String? = null
    open var Source:String? = null
    open var LastMovedFrom:String? = null
    open var LastMovedUtc:Date? = null
    open var PriorityTime:Date? = null
    open var HoldByName:String? = null
    open var HoldByStationName:String? = null
    open var HoldSinceUtc:Date? = null
    open var TicketNo:Int? = null
    open var NoteCount:Int? = null
    open var HasCarryNote:Boolean? = null
    open var CarryNoteBy:String? = null
    open var CarryNoteAtUtc:Date? = null
    open var PaperworkAsks:PaperworkAsks? = null
    open var DocumentCount:Int? = null
}

open class PaperworkAsks
{
    open var Questionnaire:Boolean? = null
    open var Upload:Boolean? = null
}

open class LobbySettings
{
    open var LocationId:UUID? = null
    open var WaitSource:String? = null
    open var MonitorChime:String? = null
    open var HasUploadedChime:Boolean? = null
    open var ChimeUrl:String? = null
    open var MonitorVolume:Int? = null
    open var MonitorAnnounce:Boolean? = null
    open var MonitorAnnounceTemplate:String? = null
    open var MonitorVoice:String? = null
    open var MonitorVoiceLang:String? = null
    open var MonitorVoiceRate:BigDecimal? = null
    open var MonitorRepeatAfterSec:Int? = null
    open var MonitorTicketOnly:Boolean? = null
    open var LobbyZoneMode:String? = null
    open var LobbyTakeoverEveryMin:Int? = null
    open var LobbyTakeoverSec:Int? = null
    open var LobbyIdleScreen:Boolean? = null
    open var TimeZone:String? = null
    open var MonitorShowServices:Boolean? = null
    open var LobbyTvCount:Int? = null
    open var TicketPrefix:String? = null
    open var LobbyDensity:String? = null
    open var LobbyIdleMode:String? = null
    open var LobbyIdleContentId:Int? = null
}

open class StationSessionView
{
    open var SessionId:UUID? = null
    open var LocationId:UUID? = null
    open var StationId:UUID? = null
    open var StationName:String? = null
    open var EmployeeId:UUID? = null
    open var EmployeeName:String? = null
    open var SignedInUtc:Date? = null
    open var LastSeenUtc:Date? = null
    open var PausedSinceUtc:Date? = null
    open var PauseReason:String? = null
    open var HomeBranchId:UUID? = null
    open var HomeBranchName:String? = null
    open var IsMine:Boolean? = null
}

Kotlin CustomersInLine DTOs

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

HTTP + 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>