The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
jobs:
[
{
id: 00000000000000000000000000000000,
jobNumber: String,
jobReference: String,
jobStatusID: String,
jobImportTypeID: String,
customerID: 00000000000000000000000000000000,
timestamp: 0001-01-01,
jobKindID: String,
senderID: 00000000000000000000000000000000,
recipientID: 00000000000000000000000000000000,
senderPhone: String,
recipientPhone: String,
senderNote: String,
recipientNote: String,
instructions: String,
active: False
}
],
jobLegs:
[
{
driverID: 00000000000000000000000000000000,
driverCode: String,
vehicleID: 00000000000000000000000000000000,
vehicleCode: String,
trailer1ID: 00000000000000000000000000000000,
trailer2ID: 00000000000000000000000000000000,
id: 00000000000000000000000000000000,
jobNumber: String,
jobReference: String,
consignmentNumber: String,
consignmentReference: String,
instructions: String,
signedBy: String,
signed: False,
senderSignedBy: String,
senderSigned: False,
routeOrder: 0,
courierPickupOrderNumber: 0,
courierDeliveryOrderNumber: 0,
timestamp: 0001-01-01,
tripStatusID: String,
podStatusID: String,
podExceptionID: String,
jobLegTypeID: String,
jobTypeID: String,
jobKindID: String,
useScanLoad: False,
useScanOff: False,
sender:
{
id: 00000000000000000000000000000000,
name: String,
postCode: String,
city: String,
state: String,
countryID: 0,
country: String,
address: String,
active: False,
geoLatitude: 0,
geoLongitude: 0,
polygonPoints:
[
{
geoLatitude: 0,
geoLongitude: 0,
ordinal: 0
}
],
code: String,
companyID: 00000000000000000000000000000000,
locationTypeID: String
},
senderID: 00000000000000000000000000000000,
senderCode: String,
recepient:
{
id: 00000000000000000000000000000000,
name: String,
postCode: String,
city: String,
state: String,
countryID: 0,
country: String,
address: String,
active: False,
geoLatitude: 0,
geoLongitude: 0,
polygonPoints:
[
{
geoLatitude: 0,
geoLongitude: 0,
ordinal: 0
}
],
code: String,
companyID: 00000000000000000000000000000000,
locationTypeID: String
},
recepientID: 00000000000000000000000000000000,
recepientCode: String,
senderNote: String,
senderPhone: String,
recepientNote: String,
recepientPhone: String,
workflowID: String,
workflowSubID: String,
takenShort: False,
eta: 0001-01-01,
arrivedSenderTimestamp: 0001-01-01,
arrivedReceiverTimestamp: 0001-01-01,
departedSenderTimestamp: 0001-01-01,
departedReceiverTimestamp: 0001-01-01,
senderWaitingTime: 0,
receiverWaitingTime: 0,
customer:
{
id: 00000000000000000000000000000000,
code: String,
name: String,
accountCode: String,
abn: String,
contactName: String,
contactPhone: String,
contactEmail: String,
companyID: 00000000000000000000000000000000,
active: False
},
customerID: 00000000000000000000000000000000,
customerCode: String,
legPallets:
[
{
id: 00000000000000000000000000000000,
jobLegID: 00000000000000000000000000000000,
palletTypeID: String,
palletMovementTypeID: 0,
quantity: 0,
bookedQuantity: 0,
jobLegProductID: 00000000000000000000000000000000,
pickedQuantity: 0,
deliveredQuantity: 0
}
],
legProducts:
[
{
id: 00000000000000000000000000000000,
product:
{
id: 00000000000000000000000000000000,
code: String,
name: String,
description: String,
weight: 0,
cubic: 0,
active: False,
reference: String,
unit: String,
quantityPerUnit: 0,
width: 0,
height: 0,
depth: 0,
companyID: 00000000000000000000000000000000
},
jobLegID: 00000000000000000000000000000000,
productID: 00000000000000000000000000000000,
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,
customField01: 0,
customField02: 0,
customField03: 0,
customField04: 0,
customField05: 0,
reference: String,
shippingUnit: String,
space: 0
}
],
productQuantity: 0,
productCode: String,
productName: String,
palletQuantity: 0,
acknowledged: False,
timestampAcknowledged: 0001-01-01,
serviceCode: String,
serviceCodeName: String,
releaseNumber: String,
weight: 0,
customerReference: String,
doors: String,
dueTimestamp: 0001-01-01,
timeSlotFrom: PT0S,
timeSlotTo: PT0S,
timeSlotFromTo: String,
dangerousGoods: False,
active: False,
requiredDate: 0001-01-01,
bookDate: 0001-01-01,
readyFromDate: 0001-01-01,
requiredDateString: String,
bookDateString: String,
readyFromDateString: String,
seq: 0,
ref: 0,
jobReferences:
[
{
id: 00000000000000000000000000000000,
name: String,
value: String
}
],
jobID: 00000000000000000000000000000000
}
],
success: False,
errorMessage: String,
errorCode: 0
}