Transfocus POD Web Services

<back to all web services

DispatchJobsBulkRequest

To override the Content-type in your clients 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 /jsv/reply/DispatchJobsBulkRequest HTTP/1.1 
Host: api.podapp.com.au 
Content-Type: text/jsv
Content-Length: length

{
	jobs: 
	[
		{
			id: 00000000000000000000000000000000,
			jobNumber: String,
			jobReference: String,
			consignmentNumber: String,
			consignmentReference: String,
			instructions: String,
			routeOrder: 0,
			createdBy: String,
			jobLegTypeID: String,
			jobTypeID: String,
			jobKindID: String,
			useScanLoad: False,
			useScanOff: False,
			driverID: 00000000000000000000000000000000,
			driverCode: String,
			vehicleID: 00000000000000000000000000000000,
			customerID: 00000000000000000000000000000000,
			customerCode: String,
			senderID: 00000000000000000000000000000000,
			senderCode: String,
			recepientID: 00000000000000000000000000000000,
			recepientCode: String,
			senderNote: String,
			senderPhone: String,
			recepientNote: String,
			recepientPhone: String,
			workflowID: String,
			workflowSubID: String,
			legProducts: 
			[
				{
					id: 00000000000000000000000000000000,
					jobLegID: 00000000000000000000000000000000,
					productID: 00000000000000000000000000000000,
					code: String,
					productCode: String,
					barcode: String,
					quantity: 0,
					pallet: 0,
					cubic: 0,
					weight: 0,
					description: String,
					width: 0,
					height: 0,
					depth: 0,
					timestampScanLoad: 0001-01-01,
					scannedLoad: False,
					timestampScanOff: 0001-01-01,
					scannedOff: False,
					space: 0,
					hooks: 0,
					ties: 0,
					temp: String
				}
			],
			legPallets: 
			[
				{
					id: 00000000000000000000000000000000,
					palletTypeID: String,
					movementTypeID: 0,
					bookedQuantity: 0
				}
			],
			trailer1ID: 00000000000000000000000000000000,
			trailer2ID: 00000000000000000000000000000000,
			serviceCodeID: 00000000000000000000000000000000,
			serviceCode: String,
			releaseNumber: String,
			weight: 0,
			customerReference: String,
			doors: String,
			dueTimestamp: 0001-01-01,
			trailer1Code: String,
			trailer2Code: String,
			vehicleCode: String,
			masterNumber: String,
			product: String
		}
	],
	authToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	jobStatuses: 
	[
		{
			jobNumber: String,
			status: String
		}
	],
	success: False,
	errorMessage: String,
	errorCode: 0
}