Trendsic Platform Service

<back to all web services

CourierTrackMessageRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/track/{Token}/messages
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 DispatchTrackStepView() = 
        member val Name:String = null with get,set
        member val At:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Done:Boolean = new Boolean() with get,set
        member val Current:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierTrackBusiness() = 
        member val Name:String = null with get,set
        member val Phone:String = null with get,set

    [<AllowNullLiteral>]
    type CourierTrackDriver() = 
        member val FirstName:String = null with get,set
        member val Initial:String = null with get,set
        member val Vehicle:String = null with get,set
        member val Plate:String = null with get,set
        member val EtaMin:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EtaPct:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type CourierTrackProof() = 
        member val Kind:String = null with get,set
        member val PhotoUrl:String = null with get,set
        member val AtText:String = null with get,set
        member val GpsOk:Boolean = new Boolean() with get,set
        member val Units:Int32 = new Int32() with get,set
        member val DamageNote:String = null with get,set
        member val DeliveredTo:String = null with get,set
        member val WaitedMin:Int32 = new Int32() with get,set
        member val Attempts:Int32 = new Int32() with get,set
        member val ContactedText:String = null with get,set
        member val EachTagged:Boolean = new Boolean() with get,set
        member val EachScanned:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierTrackRating() = 
        member val Stars:Int32 = new Int32() with get,set
        member val Tags:String = null with get,set
        member val Tip:Decimal = new Decimal() with get,set
        member val TipStatus:String = null with get,set

    [<AllowNullLiteral>]
    type CourierTrackSlot() = 
        member val Id:String = null with get,set
        member val Day:String = null with get,set
        member val DayEs:String = null with get,set
        member val Win:String = null with get,set

    [<AllowNullLiteral>]
    type CourierTrackMissed() = 
        member val Code:String = null with get,set
        member val Fee:Decimal = new Decimal() with get,set
        member val WaitedMin:Int32 = new Int32() with get,set
        member val AutoRebook:Boolean = new Boolean() with get,set
        member val RebookWindowText:String = null with get,set
        member val Slots:ResizeArray<CourierTrackSlot> = new ResizeArray<CourierTrackSlot>() with get,set

    [<AllowNullLiteral>]
    type CourierTrackCan() = 
        member val EditInstructions:Boolean = new Boolean() with get,set
        member val ChangeUnits:Boolean = new Boolean() with get,set
        member val Cancel:Boolean = new Boolean() with get,set
        member val RescheduleDelivery:Boolean = new Boolean() with get,set
        member val Rebook:Boolean = new Boolean() with get,set
        member val Rate:Boolean = new Boolean() with get,set
        member val Message:Boolean = new Boolean() with get,set
        member val Report:Boolean = new Boolean() with get,set
        member val MaxUnits:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CourierTrackMessage() = 
        member val Who:String = null with get,set
        member val Mine:Boolean = new Boolean() with get,set
        member val Office:Boolean = new Boolean() with get,set
        member val AtText:String = null with get,set
        member val Body:String = null with get,set

    [<AllowNullLiteral>]
    type CourierTrackView() = 
        member val State:String = null with get,set
        member val Code:String = null with get,set
        member val RunCode:String = null with get,set
        member val Shape:String = null with get,set
        member val Template:String = null with get,set
        member val CourierStep:String = null with get,set
        member val UnitOne:String = null with get,set
        member val UnitMany:String = null with get,set
        member val UnitOneEs:String = null with get,set
        member val UnitManyEs:String = null with get,set
        member val FacilityNoun:String = null with get,set
        member val FacilityNounEs:String = null with get,set
        member val Units:Int32 = new Int32() with get,set
        member val UnitsCounted:Boolean = new Boolean() with get,set
        member val Address:String = null with get,set
        member val DropoffAddress:String = null with get,set
        member val DropoffName:String = null with get,set
        member val Instructions:String = null with get,set
        member val GateCode:String = null with get,set
        member val Handoff:String = null with get,set
        member val LevelName:String = null with get,set
        member val ReadyPromise:String = null with get,set
        member val WindowText:String = null with get,set
        member val IsAsap:Boolean = new Boolean() with get,set
        member val Times:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val StopPosition:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StopCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DeliveryWindowText:String = null with get,set
        member val Driver:CourierTrackDriver = null with get,set
        member val Proof:CourierTrackProof = null with get,set
        member val HandoffCode:String = null with get,set
        member val Rating:CourierTrackRating = null with get,set
        member val TipAllowed:Boolean = new Boolean() with get,set
        member val TipsPct:Decimal = new Decimal() with get,set
        member val Missed:CourierTrackMissed = null with get,set
        member val CancelFee:Decimal = new Decimal() with get,set
        member val CancelFeeCharged:Decimal = new Decimal() with get,set
        member val CancelledBy:String = null with get,set
        member val BookUrl:String = null with get,set
        member val Can:CourierTrackCan = null with get,set
        member val DeliverySlots:ResizeArray<CourierTrackSlot> = new ResizeArray<CourierTrackSlot>() with get,set
        member val Messages:ResizeArray<CourierTrackMessage> = new ResizeArray<CourierTrackMessage>() with get,set
        member val MessagesOpen:Boolean = new Boolean() with get,set
        member val CaseCode:String = null with get,set
        member val CaseStatus:String = null with get,set
        member val CaseReply:String = null with get,set
        member val ThreadHrs:Int32 = new Int32() with get,set
        member val ExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LiveEta:Boolean = new Boolean() with get,set
        member val Live:Boolean = new Boolean() with get,set
        member val ServerUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type DispatchTrackResponse() = 
        member val Kind:String = null with get,set
        member val Code:String = null with get,set
        member val What:String = null with get,set
        member val FromLoc:String = null with get,set
        member val ToLoc:String = null with get,set
        member val Bags:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Fare:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PayMode:String = null with get,set
        member val CardLast4:String = null with get,set
        member val Charged:Boolean = new Boolean() with get,set
        member val Stage:String = null with get,set
        member val Headline:String = null with get,set
        member val Sub:String = null with get,set
        member val IsClosed:Boolean = new Boolean() with get,set
        member val Eta:String = null with get,set
        member val DriverName:String = null with get,set
        member val CustomerName:String = null with get,set
        member val Steps:ResizeArray<DispatchTrackStepView> = new ResizeArray<DispatchTrackStepView>() with get,set
        member val Expired:Boolean = new Boolean() with get,set
        member val Invalid:Boolean = new Boolean() with get,set
        member val Business:CourierTrackBusiness = null with get,set
        member val Courier:CourierTrackView = null with get,set
        member val Notice:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierTrackActRequest() = 
        member val Token:String = null with get,set
        member val ActToken:String = null with get,set

    [<AllowNullLiteral>]
    type CourierTrackMessageRequest() = 
        inherit CourierTrackActRequest()
        member val Text:String = null with get,set

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

POST /v1/dispatch/track/{Token}/messages HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierTrackMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ActToken>String</ActToken>
  <Token>String</Token>
  <Text>String</Text>
</CourierTrackMessageRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchTrackResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Bags>0</Bags>
  <Business>
    <Name>String</Name>
    <Phone>String</Phone>
  </Business>
  <CardLast4>String</CardLast4>
  <Charged>false</Charged>
  <Code>String</Code>
  <Courier>
    <Address>String</Address>
    <BookUrl>String</BookUrl>
    <Can>
      <Cancel>false</Cancel>
      <ChangeUnits>false</ChangeUnits>
      <EditInstructions>false</EditInstructions>
      <MaxUnits>0</MaxUnits>
      <Message>false</Message>
      <Rate>false</Rate>
      <Rebook>false</Rebook>
      <Report>false</Report>
      <RescheduleDelivery>false</RescheduleDelivery>
    </Can>
    <CancelFee>0</CancelFee>
    <CancelFeeCharged>0</CancelFeeCharged>
    <CancelledBy>String</CancelledBy>
    <CaseCode>String</CaseCode>
    <CaseReply>String</CaseReply>
    <CaseStatus>String</CaseStatus>
    <Code>String</Code>
    <CourierStep>String</CourierStep>
    <DeliverySlots>
      <CourierTrackSlot>
        <Day>String</Day>
        <DayEs>String</DayEs>
        <Id>String</Id>
        <Win>String</Win>
      </CourierTrackSlot>
    </DeliverySlots>
    <DeliveryWindowText>String</DeliveryWindowText>
    <Driver>
      <EtaMin>0</EtaMin>
      <EtaPct>0</EtaPct>
      <FirstName>String</FirstName>
      <Initial>String</Initial>
      <Plate>String</Plate>
      <Vehicle>String</Vehicle>
    </Driver>
    <DropoffAddress>String</DropoffAddress>
    <DropoffName>String</DropoffName>
    <ExpiresUtc>0001-01-01T00:00:00</ExpiresUtc>
    <FacilityNoun>String</FacilityNoun>
    <FacilityNounEs>String</FacilityNounEs>
    <GateCode>String</GateCode>
    <Handoff>String</Handoff>
    <HandoffCode>String</HandoffCode>
    <Instructions>String</Instructions>
    <IsAsap>false</IsAsap>
    <LevelName>String</LevelName>
    <Live>false</Live>
    <LiveEta>false</LiveEta>
    <Messages>
      <CourierTrackMessage>
        <AtText>String</AtText>
        <Body>String</Body>
        <Mine>false</Mine>
        <Office>false</Office>
        <Who>String</Who>
      </CourierTrackMessage>
    </Messages>
    <MessagesOpen>false</MessagesOpen>
    <Missed>
      <AutoRebook>false</AutoRebook>
      <Code>String</Code>
      <Fee>0</Fee>
      <RebookWindowText>String</RebookWindowText>
      <Slots>
        <CourierTrackSlot>
          <Day>String</Day>
          <DayEs>String</DayEs>
          <Id>String</Id>
          <Win>String</Win>
        </CourierTrackSlot>
      </Slots>
      <WaitedMin>0</WaitedMin>
    </Missed>
    <Proof>
      <AtText>String</AtText>
      <Attempts>0</Attempts>
      <ContactedText>String</ContactedText>
      <DamageNote>String</DamageNote>
      <DeliveredTo>String</DeliveredTo>
      <EachScanned>false</EachScanned>
      <EachTagged>false</EachTagged>
      <GpsOk>false</GpsOk>
      <Kind>String</Kind>
      <PhotoUrl>String</PhotoUrl>
      <Units>0</Units>
      <WaitedMin>0</WaitedMin>
    </Proof>
    <Rating>
      <Stars>0</Stars>
      <Tags>String</Tags>
      <Tip>0</Tip>
      <TipStatus>String</TipStatus>
    </Rating>
    <ReadyPromise>String</ReadyPromise>
    <RunCode>String</RunCode>
    <ServerUtc>0001-01-01T00:00:00</ServerUtc>
    <Shape>String</Shape>
    <State>String</State>
    <StopCount>0</StopCount>
    <StopPosition>0</StopPosition>
    <Template>String</Template>
    <ThreadHrs>0</ThreadHrs>
    <Times xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Times>
    <TipAllowed>false</TipAllowed>
    <TipsPct>0</TipsPct>
    <UnitMany>String</UnitMany>
    <UnitManyEs>String</UnitManyEs>
    <UnitOne>String</UnitOne>
    <UnitOneEs>String</UnitOneEs>
    <Units>0</Units>
    <UnitsCounted>false</UnitsCounted>
    <WindowText>String</WindowText>
  </Courier>
  <CustomerName>String</CustomerName>
  <DriverName>String</DriverName>
  <Eta>String</Eta>
  <Expired>false</Expired>
  <Fare>0</Fare>
  <FromLoc>String</FromLoc>
  <Headline>String</Headline>
  <Invalid>false</Invalid>
  <IsClosed>false</IsClosed>
  <Kind>String</Kind>
  <Notice>String</Notice>
  <PayMode>String</PayMode>
  <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>
  <Stage>String</Stage>
  <Steps>
    <DispatchTrackStepView>
      <At>0001-01-01T00:00:00</At>
      <Current>false</Current>
      <Done>false</Done>
      <Name>String</Name>
    </DispatchTrackStepView>
  </Steps>
  <Sub>String</Sub>
  <ToLoc>String</ToLoc>
  <What>String</What>
</DispatchTrackResponse>