Trendsic Platform Service

CourierTrackMessageRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/track/{Token}/messages

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierTrackMessageRequest : CourierTrackActRequest()
{
    open var Text:String? = null
}

open class CourierTrackActRequest
{
    open var Token:String? = null
    open var ActToken:String? = null
}

open class DispatchTrackResponse
{
    open var Kind:String? = null
    open var Code:String? = null
    open var What:String? = null
    open var FromLoc:String? = null
    open var ToLoc:String? = null
    open var Bags:Int? = null
    open var Fare:BigDecimal? = null
    open var PayMode:String? = null
    open var CardLast4:String? = null
    open var Charged:Boolean? = null
    open var Stage:String? = null
    open var Headline:String? = null
    open var Sub:String? = null
    open var IsClosed:Boolean? = null
    open var Eta:String? = null
    open var DriverName:String? = null
    open var CustomerName:String? = null
    open var Steps:ArrayList<DispatchTrackStepView> = ArrayList<DispatchTrackStepView>()
    open var Expired:Boolean? = null
    open var Invalid:Boolean? = null
    open var Business:CourierTrackBusiness? = null
    open var Courier:CourierTrackView? = null
    open var Notice:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchTrackStepView
{
    open var Name:String? = null
    open var At:Date? = null
    open var Done:Boolean? = null
    open var Current:Boolean? = null
}

open class CourierTrackBusiness
{
    open var Name:String? = null
    open var Phone:String? = null
}

open class CourierTrackView
{
    open var State:String? = null
    open var Code:String? = null
    open var RunCode:String? = null
    open var Shape:String? = null
    open var Template:String? = null
    open var CourierStep:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var UnitOneEs:String? = null
    open var UnitManyEs:String? = null
    open var FacilityNoun:String? = null
    open var FacilityNounEs:String? = null
    open var Units:Int? = null
    open var UnitsCounted:Boolean? = null
    open var Address:String? = null
    open var DropoffAddress:String? = null
    open var DropoffName:String? = null
    open var Instructions:String? = null
    open var GateCode:String? = null
    open var Handoff:String? = null
    open var LevelName:String? = null
    open var ReadyPromise:String? = null
    open var WindowText:String? = null
    open var IsAsap:Boolean? = null
    open var Times:HashMap<String,String> = HashMap<String,String>()
    open var StopPosition:Int? = null
    open var StopCount:Int? = null
    open var DeliveryWindowText:String? = null
    open var Driver:CourierTrackDriver? = null
    open var Proof:CourierTrackProof? = null
    open var HandoffCode:String? = null
    open var Rating:CourierTrackRating? = null
    open var TipAllowed:Boolean? = null
    open var TipsPct:BigDecimal? = null
    open var Missed:CourierTrackMissed? = null
    open var CancelFee:BigDecimal? = null
    open var CancelFeeCharged:BigDecimal? = null
    open var CancelledBy:String? = null
    open var BookUrl:String? = null
    open var Can:CourierTrackCan? = null
    open var DeliverySlots:ArrayList<CourierTrackSlot> = ArrayList<CourierTrackSlot>()
    open var Messages:ArrayList<CourierTrackMessage> = ArrayList<CourierTrackMessage>()
    open var MessagesOpen:Boolean? = null
    open var CaseCode:String? = null
    open var CaseStatus:String? = null
    open var CaseReply:String? = null
    open var ThreadHrs:Int? = null
    open var ExpiresUtc:Date? = null
    open var LiveEta:Boolean? = null
    open var Live:Boolean? = null
    open var ServerUtc:Date? = null
}

open class CourierTrackDriver
{
    open var FirstName:String? = null
    open var Initial:String? = null
    open var Vehicle:String? = null
    open var Plate:String? = null
    open var EtaMin:Int? = null
    open var EtaPct:Int? = null
}

open class CourierTrackProof
{
    open var Kind:String? = null
    open var PhotoUrl:String? = null
    open var AtText:String? = null
    open var GpsOk:Boolean? = null
    open var Units:Int? = null
    open var DamageNote:String? = null
    open var DeliveredTo:String? = null
    open var WaitedMin:Int? = null
    open var Attempts:Int? = null
    open var ContactedText:String? = null
    open var EachTagged:Boolean? = null
    open var EachScanned:Boolean? = null
}

open class CourierTrackRating
{
    open var Stars:Int? = null
    open var Tags:String? = null
    open var Tip:BigDecimal? = null
    open var TipStatus:String? = null
}

open class CourierTrackMissed
{
    open var Code:String? = null
    open var Fee:BigDecimal? = null
    open var WaitedMin:Int? = null
    open var AutoRebook:Boolean? = null
    open var RebookWindowText:String? = null
    open var Slots:ArrayList<CourierTrackSlot> = ArrayList<CourierTrackSlot>()
}

open class CourierTrackSlot
{
    open var Id:String? = null
    open var Day:String? = null
    open var DayEs:String? = null
    open var Win:String? = null
}

open class CourierTrackCan
{
    open var EditInstructions:Boolean? = null
    open var ChangeUnits:Boolean? = null
    open var Cancel:Boolean? = null
    open var RescheduleDelivery:Boolean? = null
    open var Rebook:Boolean? = null
    open var Rate:Boolean? = null
    open var Message:Boolean? = null
    open var Report:Boolean? = null
    open var MaxUnits:Int? = null
}

open class CourierTrackMessage
{
    open var Who:String? = null
    open var Mine:Boolean? = null
    open var Office:Boolean? = null
    open var AtText:String? = null
    open var Body:String? = null
}

Kotlin 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>