Trendsic Platform Service

<back to all web services

CourierTrackProblemRequest

export class CourierTrackActRequest
{
    public Token: string;
    public ActToken: string;

    public constructor(init?: Partial<CourierTrackActRequest>) { (Object as any).assign(this, init); }
}

export class DispatchTrackStepView
{
    public Name: string;
    public At?: string;
    public Done: boolean;
    public Current: boolean;

    public constructor(init?: Partial<DispatchTrackStepView>) { (Object as any).assign(this, init); }
}

export class CourierTrackBusiness
{
    public Name: string;
    public Phone: string;

    public constructor(init?: Partial<CourierTrackBusiness>) { (Object as any).assign(this, init); }
}

export class CourierTrackDriver
{
    public FirstName: string;
    public Initial: string;
    public Vehicle: string;
    public Plate: string;
    public EtaMin?: number;
    public EtaPct?: number;

    public constructor(init?: Partial<CourierTrackDriver>) { (Object as any).assign(this, init); }
}

export class CourierTrackProof
{
    public Kind: string;
    public PhotoUrl: string;
    public AtText: string;
    public GpsOk: boolean;
    public Units: number;
    public DamageNote: string;
    public DeliveredTo: string;
    public WaitedMin: number;
    public Attempts: number;
    public ContactedText: string;
    public EachTagged: boolean;
    public EachScanned: boolean;

    public constructor(init?: Partial<CourierTrackProof>) { (Object as any).assign(this, init); }
}

export class CourierTrackRating
{
    public Stars: number;
    public Tags: string;
    public Tip: number;
    public TipStatus: string;

    public constructor(init?: Partial<CourierTrackRating>) { (Object as any).assign(this, init); }
}

export class CourierTrackSlot
{
    public Id: string;
    public Day: string;
    public DayEs: string;
    public Win: string;

    public constructor(init?: Partial<CourierTrackSlot>) { (Object as any).assign(this, init); }
}

export class CourierTrackMissed
{
    public Code: string;
    public Fee: number;
    public WaitedMin: number;
    public AutoRebook: boolean;
    public RebookWindowText: string;
    public Slots: CourierTrackSlot[] = [];

    public constructor(init?: Partial<CourierTrackMissed>) { (Object as any).assign(this, init); }
}

export class CourierTrackCan
{
    public EditInstructions: boolean;
    public ChangeUnits: boolean;
    public Cancel: boolean;
    public RescheduleDelivery: boolean;
    public Rebook: boolean;
    public Rate: boolean;
    public Message: boolean;
    public Report: boolean;
    public MaxUnits: number;

    public constructor(init?: Partial<CourierTrackCan>) { (Object as any).assign(this, init); }
}

export class CourierTrackMessage
{
    public Who: string;
    public Mine: boolean;
    public Office: boolean;
    public AtText: string;
    public Body: string;

    public constructor(init?: Partial<CourierTrackMessage>) { (Object as any).assign(this, init); }
}

export class CourierTrackView
{
    public State: string;
    public Code: string;
    public RunCode: string;
    public Shape: string;
    public Template: string;
    public CourierStep: string;
    public UnitOne: string;
    public UnitMany: string;
    public UnitOneEs: string;
    public UnitManyEs: string;
    public FacilityNoun: string;
    public FacilityNounEs: string;
    public Units: number;
    public UnitsCounted: boolean;
    public Address: string;
    public DropoffAddress: string;
    public DropoffName: string;
    public Instructions: string;
    public GateCode: string;
    public Handoff: string;
    public LevelName: string;
    public ReadyPromise: string;
    public WindowText: string;
    public IsAsap: boolean;
    public Times: { [index:string]: string; } = {};
    public StopPosition?: number;
    public StopCount?: number;
    public DeliveryWindowText: string;
    public Driver: CourierTrackDriver;
    public Proof: CourierTrackProof;
    public HandoffCode: string;
    public Rating: CourierTrackRating;
    public TipAllowed: boolean;
    public TipsPct: number;
    public Missed: CourierTrackMissed;
    public CancelFee: number;
    public CancelFeeCharged: number;
    public CancelledBy: string;
    public BookUrl: string;
    public Can: CourierTrackCan;
    public DeliverySlots: CourierTrackSlot[] = [];
    public Messages: CourierTrackMessage[] = [];
    public MessagesOpen: boolean;
    public CaseCode: string;
    public CaseStatus: string;
    public CaseReply: string;
    public ThreadHrs: number;
    public ExpiresUtc?: string;
    public LiveEta: boolean;
    public Live: boolean;
    public ServerUtc: string;

    public constructor(init?: Partial<CourierTrackView>) { (Object as any).assign(this, init); }
}

export class DispatchTrackResponse
{
    public Kind: string;
    public Code: string;
    public What: string;
    public FromLoc: string;
    public ToLoc: string;
    public Bags?: number;
    public Fare?: number;
    public PayMode: string;
    public CardLast4: string;
    public Charged: boolean;
    public Stage: string;
    public Headline: string;
    public Sub: string;
    public IsClosed: boolean;
    public Eta: string;
    public DriverName: string;
    public CustomerName: string;
    public Steps: DispatchTrackStepView[] = [];
    public Expired: boolean;
    public Invalid: boolean;
    public Business: CourierTrackBusiness;
    public Courier: CourierTrackView;
    public Notice: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchTrackResponse>) { (Object as any).assign(this, init); }
}

export class CourierTrackProblemRequest extends CourierTrackActRequest
{
    public Reason: string;
    public Note: string;
    public Photos: string[] = [];

    public constructor(init?: Partial<CourierTrackProblemRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CourierTrackProblemRequest DTOs

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

<CourierTrackProblemRequest 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>
  <Note>String</Note>
  <Photos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Photos>
  <Reason>String</Reason>
</CourierTrackProblemRequest>

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>