Trendsic Platform Service

<back to all web services

CheckinTimelineRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/customercheckins/{Id}/timeline
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CheckinTimelineRequest
            Public Overridable Property Id As Guid
        End Class

        Public Partial Class CheckinTimelineResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Timeline As SvcTimeline
        End Class

        Public Partial Class SvcTimeline
            Public Overridable Property Visit As SvcVisitRow
            Public Overridable Property Steps As List(Of SvcTimelineStep) = New List(Of SvcTimelineStep)
            Public Overridable Property WalkUpSec As Integer?
        End Class

        Public Partial Class SvcTimelineStep
            Public Overridable Property AtUtc As Date
            Public Overridable Property LocalAt As Date
            Public Overridable Property Kind As String
            Public Overridable Property StationName As String
            Public Overridable Property EmployeeName As String
        End Class

        Public Partial Class SvcVisitRow
            Public Overridable Property CheckinId As Guid
            Public Overridable Property TicketLabel As String
            Public Overridable Property LocalDate As Date
            Public Overridable Property LineId As Guid
            Public Overridable Property ServiceName As String
            Public Overridable Property StationId As Guid?
            Public Overridable Property StationName As String
            Public Overridable Property EmployeeId As Guid?
            Public Overridable Property EmployeeName As String
            Public Overridable Property CustomerName As String
            Public Overridable Property ContactId As Integer?
            Public Overridable Property ContactAgentId As Integer?
            Public Overridable Property CustomerId As Guid
            Public Overridable Property IsAppointment As Boolean
            Public Overridable Property LocalHere As Date?
            Public Overridable Property LocalCalled As Date?
            Public Overridable Property LocalStart As Date?
            Public Overridable Property LocalEnd As Date?
            Public Overridable Property WaitSec As Integer?
            Public Overridable Property ServeSec As Integer?
            Public Overridable Property Outcome As String
            Public Overridable Property Fee As Decimal?
        End Class
    End Namespace
End Namespace

VB.NET CheckinTimelineRequest 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/customercheckins/{Id}/timeline HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CheckinTimelineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Timeline>
    <Steps>
      <SvcTimelineStep>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <EmployeeName>String</EmployeeName>
        <Kind>String</Kind>
        <LocalAt>0001-01-01T00:00:00</LocalAt>
        <StationName>String</StationName>
      </SvcTimelineStep>
    </Steps>
    <Visit>
      <CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
      <ContactAgentId>0</ContactAgentId>
      <ContactId>0</ContactId>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <CustomerName>String</CustomerName>
      <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
      <EmployeeName>String</EmployeeName>
      <Fee>0</Fee>
      <IsAppointment>false</IsAppointment>
      <LineId>00000000-0000-0000-0000-000000000000</LineId>
      <LocalCalled>0001-01-01T00:00:00</LocalCalled>
      <LocalDate>0001-01-01T00:00:00</LocalDate>
      <LocalEnd>0001-01-01T00:00:00</LocalEnd>
      <LocalHere>0001-01-01T00:00:00</LocalHere>
      <LocalStart>0001-01-01T00:00:00</LocalStart>
      <Outcome>String</Outcome>
      <ServeSec>0</ServeSec>
      <ServiceName>String</ServiceName>
      <StationId>00000000-0000-0000-0000-000000000000</StationId>
      <StationName>String</StationName>
      <TicketLabel>String</TicketLabel>
      <WaitSec>0</WaitSec>
    </Visit>
    <WalkUpSec>0</WalkUpSec>
  </Timeline>
</CheckinTimelineResponse>