| GET,OPTIONS | /v1/dispatch/courier/vans |
|---|
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 CourierDeskRow
{
public virtual string Code { get; set; }
public virtual int CourierProfileId { get; set; }
public virtual string FacilityName { get; set; }
public virtual string LevelCode { get; set; }
public virtual string LevelName { get; set; }
public virtual DateTime? DueUtc { get; set; }
public virtual string DueText { get; set; }
public virtual int Units { get; set; }
public virtual int? UnitsFound { get; set; }
public virtual string UnitMany { get; set; }
public virtual decimal? Fare { get; set; }
public virtual decimal? FinalPrice { get; set; }
public virtual decimal? TipAmount { get; set; }
public virtual string PayMode { get; set; }
public virtual string CaptureMode { get; set; }
public virtual string CustomerName { get; set; }
public virtual string Area { get; set; }
public virtual DateTime? IntakeUtc { get; set; }
public virtual int? IntakeMinAgo { get; set; }
public virtual string DamageNote { get; set; }
public virtual bool FinalPriceAfterCount { get; set; }
public virtual bool NeedsPrice { get; set; }
public virtual int ItemCount { get; set; }
public virtual int MissingCount { get; set; }
public virtual int PhotoCount { get; set; }
}
public partial class CourierDriverOption
{
public virtual int ContactId { get; set; }
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual bool Online { get; set; }
public virtual string Zone { get; set; }
public virtual string VehicleUnit { get; set; }
public virtual int? EquipmentID { get; set; }
public virtual bool SentToFacility { get; set; }
}
public partial class CourierFacilityOption
{
public virtual int CourierFacilityID { get; set; }
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string Address { get; set; }
public virtual int IntakeMin { get; set; }
}
public partial class CourierHeldView
{
public virtual string Code { get; set; }
public virtual string Area { get; set; }
public virtual int Units { get; set; }
public virtual string UnitMany { get; set; }
public virtual decimal? Miles { get; set; }
public virtual string LevelCode { get; set; }
public virtual string LevelName { get; set; }
public virtual string DueText { get; set; }
public virtual string HeldReason { get; set; }
public virtual int? HeldMin { get; set; }
public virtual List<string> Why { get; set; } = [];
public virtual int? BestDriverContactId { get; set; }
public virtual string BestName { get; set; }
public virtual string BestLeaveByText { get; set; }
}
public partial class CourierMoveTarget
{
public virtual int DriverContactId { get; set; }
public virtual string Name { get; set; }
public virtual bool Ok { get; set; }
public virtual string Why { get; set; }
public virtual string LeaveByText { get; set; }
}
public partial class CourierOfficeResponse
{
public virtual CourierOfficeView Office { get; set; }
public virtual bool Available { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class CourierOfficeVan
{
public virtual int DriverContactId { get; set; }
public virtual string DriverCode { get; set; }
public virtual string Name { get; set; }
public virtual bool Online { get; set; }
public virtual string Zone { get; set; }
public virtual string VehicleUnit { get; set; }
public virtual string FacilityName { get; set; }
public virtual string State { get; set; }
public virtual DateTime? LeaveByUtc { get; set; }
public virtual string LeaveByText { get; set; }
public virtual int? SlackMin { get; set; }
public virtual int InVan { get; set; }
public virtual int Committed { get; set; }
public virtual decimal? Cap { get; set; }
public virtual string CapUnit { get; set; }
public virtual string UnitMany { get; set; }
public virtual string CriticalCode { get; set; }
public virtual int DriveMin { get; set; }
public virtual string SendNote { get; set; }
public virtual List<CourierVanChip> Aboard { get; set; } = [];
public virtual List<CourierVanChip> Queued { get; set; } = [];
}
public partial class CourierOfficeView
{
public virtual DateTime ServerUtc { get; set; }
public virtual List<CourierOfficeVan> Vans { get; set; } = [];
public virtual List<CourierHeldView> Held { get; set; } = [];
public virtual List<CourierVehicleOption> Vehicles { get; set; } = [];
public virtual List<CourierProfileOption> Profiles { get; set; } = [];
public virtual List<CourierDriverOption> Drivers { get; set; } = [];
public virtual List<CourierDeskRow> Desk { get; set; } = [];
public virtual int GoCount { get; set; }
public virtual int HeldCount { get; set; }
public virtual int ReadyToOffer { get; set; }
public virtual int? IntakeMin { get; set; }
public virtual string FacilityNoun { get; set; }
}
public partial class CourierProfileOption
{
public virtual int CourierProfileID { get; set; }
public virtual string Name { get; set; }
public virtual string RouteShape { get; set; }
public virtual bool Enabled { get; set; }
public virtual string UnitOne { get; set; }
public virtual string UnitMany { get; set; }
public virtual string FacilityNoun { get; set; }
public virtual List<CourierFacilityOption> Facilities { get; set; } = [];
}
public partial class CourierVanChip
{
public virtual string Code { get; set; }
public virtual string CourierStep { get; set; }
public virtual string LevelCode { get; set; }
public virtual string LevelName { get; set; }
public virtual int Units { get; set; }
public virtual string Area { get; set; }
public virtual DateTime? DueUtc { get; set; }
public virtual string DueText { get; set; }
public virtual bool Movable { get; set; }
public virtual string NoMoveWhy { get; set; }
public virtual List<CourierMoveTarget> Targets { get; set; } = [];
}
public partial class CourierVansRequest
{
}
public partial class CourierVehicleOption
{
public virtual int CourierProfileId { get; set; }
public virtual int EquipmentID { get; set; }
public virtual string UnitNumber { get; set; }
public virtual string VehicleType { get; set; }
public virtual string CapacityUnit { get; set; }
public virtual decimal? CapacityLimit { get; set; }
public virtual bool IsRefrigerated { get; set; }
public virtual string Status { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/dispatch/courier/vans HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Office":{"ServerUtc":"0001-01-01T00:00:00.0000000","Vans":[{"DriverContactId":0,"DriverCode":"String","Name":"String","Online":false,"Zone":"String","VehicleUnit":"String","FacilityName":"String","State":"String","LeaveByUtc":"0001-01-01T00:00:00.0000000","LeaveByText":"String","SlackMin":0,"InVan":0,"Committed":0,"Cap":0,"CapUnit":"String","UnitMany":"String","CriticalCode":"String","DriveMin":0,"SendNote":"String","Aboard":[{"Code":"String","CourierStep":"String","LevelCode":"String","LevelName":"String","Units":0,"Area":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Movable":false,"NoMoveWhy":"String","Targets":[{"DriverContactId":0,"Name":"String","Ok":false,"Why":"String","LeaveByText":"String"}]}],"Queued":[{"Code":"String","CourierStep":"String","LevelCode":"String","LevelName":"String","Units":0,"Area":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Movable":false,"NoMoveWhy":"String","Targets":[{"DriverContactId":0,"Name":"String","Ok":false,"Why":"String","LeaveByText":"String"}]}]}],"Held":[{"Code":"String","Area":"String","Units":0,"UnitMany":"String","Miles":0,"LevelCode":"String","LevelName":"String","DueText":"String","HeldReason":"String","HeldMin":0,"Why":["String"],"BestDriverContactId":0,"BestName":"String","BestLeaveByText":"String"}],"Vehicles":[{"CourierProfileId":0,"EquipmentID":0,"UnitNumber":"String","VehicleType":"String","CapacityUnit":"String","CapacityLimit":0,"IsRefrigerated":false,"Status":"String"}],"Profiles":[{"CourierProfileID":0,"Name":"String","RouteShape":"String","Enabled":false,"UnitOne":"String","UnitMany":"String","FacilityNoun":"String","Facilities":[{"CourierFacilityID":0,"Code":"String","Name":"String","Address":"String","IntakeMin":0}]}],"Drivers":[{"ContactId":0,"Code":"String","Name":"String","Online":false,"Zone":"String","VehicleUnit":"String","EquipmentID":0,"SentToFacility":false}],"Desk":[{"Code":"String","CourierProfileId":0,"FacilityName":"String","LevelCode":"String","LevelName":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Units":0,"UnitsFound":0,"UnitMany":"String","Fare":0,"FinalPrice":0,"TipAmount":0,"PayMode":"String","CaptureMode":"String","CustomerName":"String","Area":"String","IntakeUtc":"0001-01-01T00:00:00.0000000","IntakeMinAgo":0,"DamageNote":"String","FinalPriceAfterCount":false,"NeedsPrice":false,"ItemCount":0,"MissingCount":0,"PhotoCount":0}],"GoCount":0,"HeldCount":0,"ReadyToOffer":0,"IntakeMin":0,"FacilityNoun":"String"},"Available":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}