Trendsic Platform Service

<back to all web services

DispatchRequestRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/requests/{RequestId}
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 DispatchRequestEventView() = 
        member val EventId:Int32 = new Int32() with get,set
        member val Kind:String = null with get,set
        member val Detail:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set
        member val ByWho:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchRequestView() = 
        member val RequestId:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val CustomerName:String = null with get,set
        member val CustomerPhone:String = null with get,set
        member val CustomerEmail:String = null with get,set
        member val Cargo:String = null with get,set
        member val Units:Int32 = new Int32() with get,set
        member val FromLoc:String = null with get,set
        member val ToLoc:String = null with get,set
        member val Miles:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WindowText:String = null with get,set
        member val IsUrgent:Boolean = new Boolean() with get,set
        member val Notes:String = null with get,set
        member val Source:String = null with get,set
        member val Status:String = null with get,set
        member val RequiredRig:String = null with get,set
        member val UnitsPerTruck:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RatePerLoad:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val UrgencyPct:Decimal = new Decimal() with get,set
        member val CostPerLoad:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LoadsNeeded:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val QuoteTotal:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val QuoteVersion:Int32 = new Int32() with get,set
        member val QuotedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val QuotedBy:String = null with get,set
        member val AcceptTokenExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AcceptedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AcceptedVia:String = null with get,set
        member val DeclinedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeclinedBy:String = null with get,set
        member val DeclineReason:String = null with get,set
        member val JobsCreated:Int32 = new Int32() with get,set
        member val JobsDone:Int32 = new Int32() with get,set
        member val JobsNeedDriver:Int32 = new Int32() with get,set
        member val CreatedUtc:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val Events:ResizeArray<DispatchRequestEventView> = new ResizeArray<DispatchRequestEventView>() with get,set

    [<AllowNullLiteral>]
    type DispatchRigCountView() = 
        member val RigType:String = null with get,set
        member val Rigs:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type DispatchCarrierPickView() = 
        member val VendorID:Int32 = new Int32() with get,set
        member val VendorName:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchRequestsResponse() = 
        member val Requests:ResizeArray<DispatchRequestView> = new ResizeArray<DispatchRequestView>() with get,set
        member val Request:DispatchRequestView = null with get,set
        member val RigCounts:ResizeArray<DispatchRigCountView> = new ResizeArray<DispatchRigCountView>() with get,set
        member val Carriers:ResizeArray<DispatchCarrierPickView> = new ResizeArray<DispatchCarrierPickView>() with get,set
        member val QuoteLink:String = null with get,set
        member val Delivery:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchRequestRequest() = 
        member val RequestId:Int32 = new Int32() with get,set

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

GET /v1/dispatch/requests/{RequestId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Requests":[{"RequestId":0,"Code":"String","CustomerName":"String","CustomerPhone":"String","CustomerEmail":"String","Cargo":"String","Units":0,"FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","IsUrgent":false,"Notes":"String","Source":"String","Status":"String","RequiredRig":"String","UnitsPerTruck":0,"RatePerLoad":0,"UrgencyPct":0,"CostPerLoad":0,"LoadsNeeded":0,"QuoteTotal":0,"QuoteVersion":0,"QuotedUtc":"0001-01-01T00:00:00.0000000","QuotedBy":"String","AcceptTokenExpiresUtc":"0001-01-01T00:00:00.0000000","AcceptedUtc":"0001-01-01T00:00:00.0000000","AcceptedVia":"String","DeclinedUtc":"0001-01-01T00:00:00.0000000","DeclinedBy":"String","DeclineReason":"String","JobsCreated":0,"JobsDone":0,"JobsNeedDriver":0,"CreatedUtc":"0001-01-01T00:00:00.0000000","CreatedBy":"String","Events":[{"EventId":0,"Kind":"String","Detail":"String","AtUtc":"0001-01-01T00:00:00.0000000","ByWho":"String"}]}],"Request":{"RequestId":0,"Code":"String","CustomerName":"String","CustomerPhone":"String","CustomerEmail":"String","Cargo":"String","Units":0,"FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","IsUrgent":false,"Notes":"String","Source":"String","Status":"String","RequiredRig":"String","UnitsPerTruck":0,"RatePerLoad":0,"UrgencyPct":0,"CostPerLoad":0,"LoadsNeeded":0,"QuoteTotal":0,"QuoteVersion":0,"QuotedUtc":"0001-01-01T00:00:00.0000000","QuotedBy":"String","AcceptTokenExpiresUtc":"0001-01-01T00:00:00.0000000","AcceptedUtc":"0001-01-01T00:00:00.0000000","AcceptedVia":"String","DeclinedUtc":"0001-01-01T00:00:00.0000000","DeclinedBy":"String","DeclineReason":"String","JobsCreated":0,"JobsDone":0,"JobsNeedDriver":0,"CreatedUtc":"0001-01-01T00:00:00.0000000","CreatedBy":"String","Events":[{"EventId":0,"Kind":"String","Detail":"String","AtUtc":"0001-01-01T00:00:00.0000000","ByWho":"String"}]},"RigCounts":[{"RigType":"String","Rigs":0}],"Carriers":[{"VendorID":0,"VendorName":"String"}],"QuoteLink":"String","Delivery":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}