Trendsic Platform Service

<back to all web services

CourierDriverVehicleRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/worker/dispatch/od/vehicle
"use strict";
export class CourierVehicleClassView {
    /** @param {{Code?:string,Name?:string,NameEs?:string,Hint?:string,HintEs?:string,Cap?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    NameEs;
    /** @type {string} */
    Hint;
    /** @type {string} */
    HintEs;
    /** @type {number} */
    Cap;
}
export class CourierDriverVehicleResponse {
    /** @param {{EquipmentID?:number,UnitNumber?:string,IsOwn?:boolean,SetByOffice?:boolean,ClassCode?:string,ClassName?:string,ClassNameEs?:string,Cap?:number,UnitOne?:string,UnitMany?:string,UnitOneEs?:string,UnitManyEs?:string,Classes?:CourierVehicleClassView[],Saved?:boolean,SavedText?:string,SavedTextEs?:string,MessageEs?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    EquipmentID;
    /** @type {string} */
    UnitNumber;
    /** @type {boolean} */
    IsOwn;
    /** @type {boolean} */
    SetByOffice;
    /** @type {string} */
    ClassCode;
    /** @type {string} */
    ClassName;
    /** @type {string} */
    ClassNameEs;
    /** @type {?number} */
    Cap;
    /** @type {string} */
    UnitOne;
    /** @type {string} */
    UnitMany;
    /** @type {string} */
    UnitOneEs;
    /** @type {string} */
    UnitManyEs;
    /** @type {CourierVehicleClassView[]} */
    Classes = [];
    /** @type {boolean} */
    Saved;
    /** @type {string} */
    SavedText;
    /** @type {string} */
    SavedTextEs;
    /** @type {string} */
    MessageEs;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CourierDriverVehicleRequest {
    /** @param {{ClassCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ClassCode;
}

JavaScript CourierDriverVehicleRequest 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/worker/dispatch/od/vehicle HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClassCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	EquipmentID: 0,
	UnitNumber: String,
	IsOwn: False,
	SetByOffice: False,
	ClassCode: String,
	ClassName: String,
	ClassNameEs: String,
	Cap: 0,
	UnitOne: String,
	UnitMany: String,
	UnitOneEs: String,
	UnitManyEs: String,
	Classes: 
	[
		{
			Code: String,
			Name: String,
			NameEs: String,
			Hint: String,
			HintEs: String,
			Cap: 0
		}
	],
	Saved: False,
	SavedText: String,
	SavedTextEs: String,
	MessageEs: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}