Trendsic Platform Service

<back to all web services

DispatchIncidentOpenRequest

Requires Authentication
Requires any of the permissions:DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/incidents

export class DispatchIncidentMessageView
{
    public MessageId: number;
    public Who: string;
    public Role: string;
    public Msg: string;
    public AtUtc: string;

    public constructor(init?: Partial<DispatchIncidentMessageView>) { (Object as any).assign(this, init); }
}

export class DispatchIncidentView
{
    public IncidentId: number;
    public Code: string;
    public Kind: string;
    public KindDetail: string;
    public LoadId?: number;
    public LoadCode: string;
    public LoadStatus: string;
    public SourceLabel: string;
    public DestinationLabel: string;
    public QtyText: string;
    public TruckCode: string;
    public TruckLabel: string;
    public LocationText: string;
    public Lat?: number;
    public Lng?: number;
    public DriverPref: string;
    public OpenedBy: string;
    public OpenedVia: string;
    public Resolver: string;
    public Status: string;
    public TruckRecovery: string;
    public TruckRecoveredUtc?: string;
    public LoadRecovery: string;
    public LoadRecoveredUtc?: string;
    public TransloadTruckCode: string;
    public HoldId?: number;
    public HoldCode: string;
    public PhotoCount: number;
    public OpenedUtc: string;
    public ResolvedUtc?: string;
    public ResolvedBy: string;
    public ReopenedUtc?: string;
    public Messages: DispatchIncidentMessageView[] = [];

    public constructor(init?: Partial<DispatchIncidentView>) { (Object as any).assign(this, init); }
}

export class DispatchIncidentTruckView
{
    public Code: string;
    public DriverName: string;
    public Stage: string;
    public OpenLoadCode: string;

    public constructor(init?: Partial<DispatchIncidentTruckView>) { (Object as any).assign(this, init); }
}

export class DispatchIncidentsResponse
{
    public Incidents: DispatchIncidentView[] = [];
    public EmptyTrucks: DispatchIncidentTruckView[] = [];
    public Trucks: DispatchIncidentTruckView[] = [];
    public TransloadTruckCode: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchIncidentsResponse>) { (Object as any).assign(this, init); }
}

export class DispatchIncidentOpenRequest
{
    public Kind: string;
    public KindDetail: string;
    public TruckCode: string;
    public LoadCode: string;
    public LocationText: string;
    public Lat?: number;
    public Lng?: number;
    public DriverPref: string;
    public Note: string;
    public OpenedBy: string;
    public OpenedVia: string;

    public constructor(init?: Partial<DispatchIncidentOpenRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchIncidentOpenRequest 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.

POST /v1/dispatch/incidents HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Kind: String,
	KindDetail: String,
	TruckCode: String,
	LoadCode: String,
	LocationText: String,
	Lat: 0,
	Lng: 0,
	DriverPref: String,
	Note: String,
	OpenedBy: String,
	OpenedVia: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Incidents: 
	[
		{
			IncidentId: 0,
			Code: String,
			Kind: String,
			KindDetail: String,
			LoadId: 0,
			LoadCode: String,
			LoadStatus: String,
			SourceLabel: String,
			DestinationLabel: String,
			QtyText: String,
			TruckCode: String,
			TruckLabel: String,
			LocationText: String,
			Lat: 0,
			Lng: 0,
			DriverPref: String,
			OpenedBy: String,
			OpenedVia: String,
			Resolver: String,
			Status: String,
			TruckRecovery: String,
			TruckRecoveredUtc: 0001-01-01,
			LoadRecovery: String,
			LoadRecoveredUtc: 0001-01-01,
			TransloadTruckCode: String,
			HoldId: 0,
			HoldCode: String,
			PhotoCount: 0,
			OpenedUtc: 0001-01-01,
			ResolvedUtc: 0001-01-01,
			ResolvedBy: String,
			ReopenedUtc: 0001-01-01,
			Messages: 
			[
				{
					MessageId: 0,
					Who: String,
					Role: String,
					Msg: String,
					AtUtc: 0001-01-01
				}
			]
		}
	],
	EmptyTrucks: 
	[
		{
			Code: String,
			DriverName: String,
			Stage: String,
			OpenLoadCode: String
		}
	],
	Trucks: 
	[
		{
			Code: String,
			DriverName: String,
			Stage: String,
			OpenLoadCode: String
		}
	],
	TransloadTruckCode: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}