Trendsic Platform Service

<back to all web services

DispatchRequestUpdateRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/requests/{RequestId}
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 DispatchCarrierPickView
    {
        public virtual int VendorID { get; set; }
        public virtual string VendorName { get; set; }
    }

    public partial class DispatchRequestEventView
    {
        public virtual int EventId { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Detail { get; set; }
        public virtual DateTime AtUtc { get; set; }
        public virtual string ByWho { get; set; }
    }

    public partial class DispatchRequestsResponse
    {
        public virtual List<DispatchRequestView> Requests { get; set; } = [];
        public virtual DispatchRequestView Request { get; set; }
        public virtual List<DispatchRigCountView> RigCounts { get; set; } = [];
        public virtual List<DispatchCarrierPickView> Carriers { get; set; } = [];
        public virtual string QuoteLink { get; set; }
        public virtual string Delivery { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchRequestUpdateRequest
    {
        public virtual int RequestId { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string CustomerEmail { get; set; }
        public virtual string Cargo { get; set; }
        public virtual int? Units { get; set; }
        public virtual string FromLoc { get; set; }
        public virtual string ToLoc { get; set; }
        public virtual int? Miles { get; set; }
        public virtual string WindowText { get; set; }
        public virtual bool? IsUrgent { get; set; }
        public virtual string Notes { get; set; }
        public virtual string RequiredRig { get; set; }
        public virtual int? UnitsPerTruck { get; set; }
        public virtual decimal? RatePerLoad { get; set; }
        public virtual decimal? UrgencyPct { get; set; }
        public virtual decimal? CostPerLoad { get; set; }
    }

    public partial class DispatchRequestView
    {
        public virtual int RequestId { get; set; }
        public virtual string Code { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string CustomerEmail { get; set; }
        public virtual string Cargo { get; set; }
        public virtual int Units { get; set; }
        public virtual string FromLoc { get; set; }
        public virtual string ToLoc { get; set; }
        public virtual int? Miles { get; set; }
        public virtual string WindowText { get; set; }
        public virtual bool IsUrgent { get; set; }
        public virtual string Notes { get; set; }
        public virtual string Source { get; set; }
        public virtual string Status { get; set; }
        public virtual string RequiredRig { get; set; }
        public virtual int? UnitsPerTruck { get; set; }
        public virtual decimal? RatePerLoad { get; set; }
        public virtual decimal UrgencyPct { get; set; }
        public virtual decimal? CostPerLoad { get; set; }
        public virtual int? LoadsNeeded { get; set; }
        public virtual decimal? QuoteTotal { get; set; }
        public virtual int QuoteVersion { get; set; }
        public virtual DateTime? QuotedUtc { get; set; }
        public virtual string QuotedBy { get; set; }
        public virtual DateTime? AcceptTokenExpiresUtc { get; set; }
        public virtual DateTime? AcceptedUtc { get; set; }
        public virtual string AcceptedVia { get; set; }
        public virtual DateTime? DeclinedUtc { get; set; }
        public virtual string DeclinedBy { get; set; }
        public virtual string DeclineReason { get; set; }
        public virtual int JobsCreated { get; set; }
        public virtual int JobsDone { get; set; }
        public virtual int JobsNeedDriver { get; set; }
        public virtual DateTime CreatedUtc { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual List<DispatchRequestEventView> Events { get; set; } = [];
    }

    public partial class DispatchRigCountView
    {
        public virtual string RigType { get; set; }
        public virtual int Rigs { get; set; }
    }

}

C# DispatchRequestUpdateRequest DTOs

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

HTTP + JSV

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

PUT /v1/dispatch/requests/{RequestId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RequestId: 0,
	CustomerName: String,
	CustomerPhone: String,
	CustomerEmail: String,
	Cargo: String,
	Units: 0,
	FromLoc: String,
	ToLoc: String,
	Miles: 0,
	WindowText: String,
	IsUrgent: False,
	Notes: String,
	RequiredRig: String,
	UnitsPerTruck: 0,
	RatePerLoad: 0,
	UrgencyPct: 0,
	CostPerLoad: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			QuotedBy: String,
			AcceptTokenExpiresUtc: 0001-01-01,
			AcceptedUtc: 0001-01-01,
			AcceptedVia: String,
			DeclinedUtc: 0001-01-01,
			DeclinedBy: String,
			DeclineReason: String,
			JobsCreated: 0,
			JobsDone: 0,
			JobsNeedDriver: 0,
			CreatedUtc: 0001-01-01,
			CreatedBy: String,
			Events: 
			[
				{
					EventId: 0,
					Kind: String,
					Detail: String,
					AtUtc: 0001-01-01,
					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-01,
		QuotedBy: String,
		AcceptTokenExpiresUtc: 0001-01-01,
		AcceptedUtc: 0001-01-01,
		AcceptedVia: String,
		DeclinedUtc: 0001-01-01,
		DeclinedBy: String,
		DeclineReason: String,
		JobsCreated: 0,
		JobsDone: 0,
		JobsNeedDriver: 0,
		CreatedUtc: 0001-01-01,
		CreatedBy: String,
		Events: 
		[
			{
				EventId: 0,
				Kind: String,
				Detail: String,
				AtUtc: 0001-01-01,
				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
		}
	}
}