Transfocus POD Web Services

RapidGetJobsRequest

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/RapidGetJobsRequest HTTP/1.1 
Host: api.podapp.com.au 
Content-Type: application/json
Content-Length: length

{"timeStamp":"\/Date(-62135596800000-0000)\/","jobLegIDs":["00000000000000000000000000000000"],"authToken":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"jobs":[{"id":"00000000000000000000000000000000","jobNumber":"String","jobReference":"String","jobStatusID":"String","jobImportTypeID":"String","customerID":"00000000000000000000000000000000","timestamp":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","arrivedSenderTimestamp":"\/Date(-62135596800000-0000)\/","arrivedReceiverTimestamp":"\/Date(-62135596800000-0000)\/","departedSenderTimestamp":"\/Date(-62135596800000-0000)\/","departedReceiverTimestamp":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","scannedLoad":false,"timestampScanOff":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","serviceCode":"String","serviceCodeName":"String","releaseNumber":"String","weight":0,"customerReference":"String","doors":"String","dueTimestamp":"\/Date(-62135596800000-0000)\/","timeSlotFrom":"PT0S","timeSlotTo":"PT0S","timeSlotFromTo":"String","dangerousGoods":false,"active":false,"requiredDate":"\/Date(-62135596800000-0000)\/","bookDate":"\/Date(-62135596800000-0000)\/","readyFromDate":"\/Date(-62135596800000-0000)\/","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}