Trendsic Platform Service

<back to all web services

CustomersInLine

The following routes are available for this service:
GET/v1/CustomersInLine
GET/v1/CustomersInLine/{LocationId}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PaperworkAsks() = 
        member val Questionnaire:Boolean = new Boolean() with get,set
        member val Upload:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CustomerInLineObject() = 
        member val CheckinId:Guid = new Guid() with get,set
        member val VisitKey:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Name:String = null with get,set
        member val SayNameAs:String = null with get,set
        member val Line:String = null with get,set
        member val Description:String = null with get,set
        member val ServiceId:Guid = new Guid() with get,set
        member val Status:Int32 = new Int32() with get,set
        member val SignInTime:DateTime = new DateTime() with get,set
        member val AdjustedSignInTime:DateTime = new DateTime() with get,set
        member val ArrivedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SendReminders:Boolean = new Boolean() with get,set
        member val CalledTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TicketLabel:String = null with get,set
        member val StationId:Guid = new Guid() with get,set
        member val StationName:String = null with get,set
        member val Id:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val FullName:String = null with get,set
        member val TaskTime:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Completed:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val CompletedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EmployeeId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Employee:String = null with get,set
        member val QuestionnaireSubmitted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val HoldReason:String = null with get,set
        member val HoldExpectedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ReturnedTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MobilePhone:String = null with get,set
        member val Source:String = null with get,set
        member val LastMovedFrom:String = null with get,set
        member val LastMovedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PriorityTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val HoldByName:String = null with get,set
        member val HoldByStationName:String = null with get,set
        member val HoldSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TicketNo:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val NoteCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HasCarryNote:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val CarryNoteBy:String = null with get,set
        member val CarryNoteAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PaperworkAsks:PaperworkAsks = null with get,set
        member val DocumentCount:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type LobbySettings() = 
        member val LocationId:Guid = new Guid() with get,set
        member val WaitSource:String = null with get,set
        member val MonitorChime:String = null with get,set
        member val HasUploadedChime:Boolean = new Boolean() with get,set
        member val ChimeUrl:String = null with get,set
        member val MonitorVolume:Int32 = new Int32() with get,set
        member val MonitorAnnounce:Boolean = new Boolean() with get,set
        member val MonitorAnnounceTemplate:String = null with get,set
        member val MonitorVoice:String = null with get,set
        member val MonitorVoiceLang:String = null with get,set
        member val MonitorVoiceRate:Decimal = new Decimal() with get,set
        member val MonitorRepeatAfterSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MonitorTicketOnly:Boolean = new Boolean() with get,set
        member val LobbyZoneMode:String = null with get,set
        member val LobbyTakeoverEveryMin:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LobbyTakeoverSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LobbyIdleScreen:Boolean = new Boolean() with get,set
        member val TimeZone:String = null with get,set
        member val MonitorShowServices:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val LobbyTvCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TicketPrefix:String = null with get,set
        member val LobbyDensity:String = null with get,set
        member val LobbyIdleMode:String = null with get,set
        member val LobbyIdleContentId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type StationSessionView() = 
        member val SessionId:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val StationId:Guid = new Guid() with get,set
        member val StationName:String = null with get,set
        member val EmployeeId:Guid = new Guid() with get,set
        member val EmployeeName:String = null with get,set
        member val SignedInUtc:DateTime = new DateTime() with get,set
        member val LastSeenUtc:DateTime = new DateTime() with get,set
        member val PausedSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PauseReason:String = null with get,set
        member val HomeBranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val HomeBranchName:String = null with get,set
        member val IsMine:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CustomersInLineResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Customers:ResizeArray<CustomerInLineObject> = new ResizeArray<CustomerInLineObject>() with get,set
        member val LocationName:String = null with get,set
        member val MonitorShowServices:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Lobby:LobbySettings = null with get,set
        member val WorkspaceName:String = null with get,set
        member val StationTerm:String = null with get,set
        member val Sessions:ResizeArray<StationSessionView> = new ResizeArray<StationSessionView>() with get,set

    [<AllowNullLiteral>]
    type CustomersInLine() = 
        member val ApiKey:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val clientIsLoading:Boolean = new Boolean() with get,set

F# 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>