Trendsic Platform Service

<back to all web services

CourierRunBuildRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/runs
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CourierItemView
    {
        public virtual int CourierItemID { get; set; }
        public virtual int DispatchOdRequestID { get; set; }
        public virtual int Seq { get; set; }
        public virtual string TagCode { get; set; }
        public virtual string Custody { get; set; }
        public virtual bool IsOpen { get; set; }
        public virtual bool IsMissing { get; set; }
        public virtual string MissingReason { get; set; }
        public virtual bool IsManual { get; set; }
        public virtual bool ReTagFlag { get; set; }
        public virtual bool Scanned { get; set; }
    }

    public partial class CourierRunBuildRequest
    {
        public virtual int ProfileId { get; set; }
        public virtual string FacilityCode { get; set; }
        public virtual List<string> Codes { get; set; } = [];
        public virtual int? DriverContactId { get; set; }
        public virtual int? EquipmentID { get; set; }
    }

    public partial class CourierRunResponse
    {
        public virtual List<CourierRunView> Runs { get; set; } = [];
        public virtual CourierRunView Run { get; set; }
        public virtual string Message { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class CourierRunView
    {
        public virtual int CourierRunID { get; set; }
        public virtual string Code { get; set; }
        public virtual string Status { get; set; }
        public virtual int CourierProfileId { get; set; }
        public virtual string ProfileName { get; set; }
        public virtual int CourierFacilityId { get; set; }
        public virtual string FacilityName { get; set; }
        public virtual string FacilityAddress { get; set; }
        public virtual int? DriverContactId { get; set; }
        public virtual string DriverName { get; set; }
        public virtual int? EquipmentID { get; set; }
        public virtual string VehicleUnit { get; set; }
        public virtual string UnitOne { get; set; }
        public virtual string UnitMany { get; set; }
        public virtual int Units { get; set; }
        public virtual int StopCount { get; set; }
        public virtual int StopsDone { get; set; }
        public virtual decimal? Pay { get; set; }
        public virtual DateTime? BuiltUtc { get; set; }
        public virtual DateTime? StartedUtc { get; set; }
        public virtual DateTime? CompletedUtc { get; set; }
        public virtual int ToLoad { get; set; }
        public virtual int ToReturn { get; set; }
        public virtual List<CourierStopView> Stops { get; set; } = [];
    }

    public partial class CourierStopView
    {
        public virtual int Sequence { get; set; }
        public virtual string Status { get; set; }
        public virtual int DispatchOdRequestID { get; set; }
        public virtual string Code { get; set; }
        public virtual string CourierStep { get; set; }
        public virtual string Address { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual string Zip { get; set; }
        public virtual decimal? Lat { get; set; }
        public virtual decimal? Lng { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string Handoff { get; set; }
        public virtual string GateCode { get; set; }
        public virtual string Instructions { get; set; }
        public virtual int Units { get; set; }
        public virtual string DueText { get; set; }
        public virtual string Note { get; set; }
        public virtual List<string> Needs { get; set; } = [];
        public virtual List<CourierItemView> Items { get; set; } = [];
    }

}

C# CourierRunBuildRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dispatch/courier/runs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProfileId":0,"FacilityCode":"String","Codes":["String"],"DriverContactId":0,"EquipmentID":0}

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

{"Runs":[{"CourierRunID":0,"Code":"String","Status":"String","CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"FacilityName":"String","FacilityAddress":"String","DriverContactId":0,"DriverName":"String","EquipmentID":0,"VehicleUnit":"String","UnitOne":"String","UnitMany":"String","Units":0,"StopCount":0,"StopsDone":0,"Pay":0,"BuiltUtc":"0001-01-01T00:00:00.0000000","StartedUtc":"0001-01-01T00:00:00.0000000","CompletedUtc":"0001-01-01T00:00:00.0000000","ToLoad":0,"ToReturn":0,"Stops":[{"Sequence":0,"Status":"String","DispatchOdRequestID":0,"Code":"String","CourierStep":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","Units":0,"DueText":"String","Note":"String","Needs":["String"],"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}]}]}],"Run":{"CourierRunID":0,"Code":"String","Status":"String","CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"FacilityName":"String","FacilityAddress":"String","DriverContactId":0,"DriverName":"String","EquipmentID":0,"VehicleUnit":"String","UnitOne":"String","UnitMany":"String","Units":0,"StopCount":0,"StopsDone":0,"Pay":0,"BuiltUtc":"0001-01-01T00:00:00.0000000","StartedUtc":"0001-01-01T00:00:00.0000000","CompletedUtc":"0001-01-01T00:00:00.0000000","ToLoad":0,"ToReturn":0,"Stops":[{"Sequence":0,"Status":"String","DispatchOdRequestID":0,"Code":"String","CourierStep":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","Units":0,"DueText":"String","Note":"String","Needs":["String"],"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}]}]},"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}