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
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 SvcVisitRow() = 
        member val CheckinId:Guid = new Guid() with get,set
        member val TicketLabel:String = null with get,set
        member val LocalDate:DateTime = new DateTime() with get,set
        member val LineId:Guid = new Guid() with get,set
        member val ServiceName:String = null with get,set
        member val StationId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val StationName:String = null with get,set
        member val EmployeeId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val EmployeeName:String = null with get,set
        member val CustomerName:String = null with get,set
        member val ContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ContactAgentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CustomerId:Guid = new Guid() with get,set
        member val IsAppointment:Boolean = new Boolean() with get,set
        member val LocalHere:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LocalCalled:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LocalStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LocalEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val WaitSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ServeSec:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Outcome:String = null with get,set
        member val Fee:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type SvcTimelineStep() = 
        member val AtUtc:DateTime = new DateTime() with get,set
        member val LocalAt:DateTime = new DateTime() with get,set
        member val Kind:String = null with get,set
        member val StationName:String = null with get,set
        member val EmployeeName:String = null with get,set

    [<AllowNullLiteral>]
    type SvcTimeline() = 
        member val Visit:SvcVisitRow = null with get,set
        member val Steps:ResizeArray<SvcTimelineStep> = new ResizeArray<SvcTimelineStep>() with get,set
        member val WalkUpSec:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type CheckinTimelineResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Timeline:SvcTimeline = null with get,set

    [<AllowNullLiteral>]
    type CheckinTimelineRequest() = 
        member val Id:Guid = new Guid() with get,set

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