Transfocus POD Web Services

GetCompanySettingsRequest

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/GetCompanySettingsRequest HTTP/1.1 
Host: api.podapp.com.au 
Content-Type: application/json
Content-Length: length

{"companyCode":"String"}

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

{"settings":{"companyID":"00000000000000000000000000000000","companyName":"String","webServiceURL":"String","webServiceTimeout":0,"photoSize":0,"gpsFrequency":0,"gpsSendFrequency":0,"version":0,"consignmentsEnabled":false,"pickupsEnabled":false,"couriersEnabled":false,"linehaulsEnabled":false,"requestConsigmentsAcknowledgement":false,"requestPickupsAcknowledgement":false,"requestCouriersAcknowledgement":false,"requestLinehaulsAcknowledgement":false,"requestMessagesAcknowledgement":false,"useModernDateTimePicker":false,"forceLogoutTimeout":0,"backupSyncFrequency":0,"termsAndConditions":"String","bookingFormEnabled":false,"useGlobalAlerts":false,"groupBySender":false,"groupByRecipient":false,"deliveryShowETAButtonCustomer":false,"deliveryShowETAButtonDepot":false,"deliverySignatureAtArrivedSenderCustomer":false,"deliverySignatureAtArrivedSenderDepot":false,"deliverySignatureAtArrivedReceiverCustomer":false,"deliverySignatureAtArrivedReceiverDepot":false,"deliveryWaitingTimeAtSenderCustomer":false,"deliveryWaitingTimeAtSenderDepot":false,"deliveryWaitingTimeAtReceiverCustomer":false,"deliveryWaitingTimeAtReceiverDepot":false,"deliveryTimestampsAtSenderCustomer":false,"deliveryTimestampsAtSenderDepot":false,"deliveryTimestampsAtReceiverCustomer":false,"deliveryTimestampsAtReceiverDepot":false,"deliveryScanAtSenderCustomer":false,"deliveryScanAtSenderDepot":false,"deliveryScanAtReceiverCustomer":false,"deliveryScanAtReceiverDepot":false,"pickupShowETAButtonCustomer":false,"pickupShowETAButtonDepot":false,"pickupSignatureAtArrivedSenderCustomer":false,"pickupSignatureAtArrivedSenderDepot":false,"pickupSignatureAtArrivedReceiverCustomer":false,"pickupSignatureAtArrivedReceiverDepot":false,"pickupWaitingTimeAtSenderCustomer":false,"pickupWaitingTimeAtSenderDepot":false,"pickupWaitingTimeAtReceiverCustomer":false,"pickupWaitingTimeAtReceiverDepot":false,"pickupTimestampsAtSenderCustomer":false,"pickupTimestampsAtSenderDepot":false,"pickupTimestampsAtReceiverCustomer":false,"pickupTimestampsAtReceiverDepot":false,"pickupScanAtSenderCustomer":false,"pickupScanAtSenderDepot":false,"pickupScanAtReceiverCustomer":false,"pickupScanAtReceiverDepot":false,"courierShowETAButtonCustomer":false,"courierShowETAButtonDepot":false,"courierSignatureAtArrivedSenderCustomer":false,"courierSignatureAtArrivedSenderDepot":false,"courierSignatureAtArrivedReceiverCustomer":false,"courierSignatureAtArrivedReceiverDepot":false,"courierWaitingTimeAtSenderCustomer":false,"courierWaitingTimeAtSenderDepot":false,"courierWaitingTimeAtReceiverCustomer":false,"courierWaitingTimeAtReceiverDepot":false,"courierTimestampsAtSenderCustomer":false,"courierTimestampsAtSenderDepot":false,"courierTimestampsAtReceiverCustomer":false,"courierTimestampsAtReceiverDepot":false,"courierScanAtSenderCustomer":false,"courierScanAtSenderDepot":false,"courierScanAtReceiverCustomer":false,"courierScanAtReceiverDepot":false,"mergePickupsAndCouriers":false,"mergeAllJobLegTypes":false,"linehaulShowETAButtonCustomer":false,"linehaulShowETAButtonDepot":false,"linehaulSignatureAtArrivedSenderCustomer":false,"linehaulSignatureAtArrivedSenderDepot":false,"linehaulSignatureAtArrivedReceiverCustomer":false,"linehaulSignatureAtArrivedReceiverDepot":false,"linehaulWaitingTimeAtSenderCustomer":false,"linehaulWaitingTimeAtSenderDepot":false,"linehaulWaitingTimeAtReceiverCustomer":false,"linehaulWaitingTimeAtReceiverDepot":false,"linehaulTimestampsAtSenderCustomer":false,"linehaulTimestampsAtSenderDepot":false,"linehaulTimestampsAtReceiverCustomer":false,"linehaulTimestampsAtReceiverDepot":false,"linehaulScanAtSenderCustomer":false,"linehaulScanAtSenderDepot":false,"linehaulScanAtReceiverCustomer":false,"linehaulScanAtReceiverDepot":false,"deliveryShowButtonArrivedSenderCustomer":false,"deliveryShowButtonArrivedSenderDepot":false,"deliveryShowButtonDepartedSenderCustomer":false,"deliveryShowButtonDepartedSenderDepot":false,"deliveryShowButtonArrivedReceiverCustomer":false,"deliveryShowButtonArrivedReceiverDepot":false,"deliveryShowButtonDepartedReceiverCustomer":false,"deliveryShowButtonDepartedReceiverDepot":false,"pickupShowButtonArrivedSenderCustomer":false,"pickupShowButtonArrivedSenderDepot":false,"pickupShowButtonDepartedSenderCustomer":false,"pickupShowButtonDepartedSenderDepot":false,"pickupShowButtonArrivedReceiverCustomer":false,"pickupShowButtonArrivedReceiverDepot":false,"pickupShowButtonDepartedReceiverCustomer":false,"pickupShowButtonDepartedReceiverDepot":false,"courierShowButtonArrivedSenderCustomer":false,"courierShowButtonArrivedSenderDepot":false,"courierShowButtonDepartedSenderCustomer":false,"courierShowButtonDepartedSenderDepot":false,"courierShowButtonArrivedReceiverCustomer":false,"courierShowButtonArrivedReceiverDepot":false,"courierShowButtonDepartedReceiverCustomer":false,"courierShowButtonDepartedReceiverDepot":false,"linehaulShowButtonArrivedSenderCustomer":false,"linehaulShowButtonArrivedSenderDepot":false,"linehaulShowButtonDepartedSenderCustomer":false,"linehaulShowButtonDepartedSenderDepot":false,"linehaulShowButtonArrivedReceiverCustomer":false,"linehaulShowButtonArrivedReceiverDepot":false,"linehaulShowButtonDepartedReceiverCustomer":false,"linehaulShowButtonDepartedReceiverDepot":false,"isETAMandatory":false,"isETAVisible":false,"showProductSummaryInJobLegsList":false,"palletControlledDelivery":false,"pickupPalletManagement":false,"palletManagementMandatory":false,"productCustomFieldLabel01":"String","productCustomFieldLabel02":"String","productCustomFieldLabel03":"String","productCustomFieldLabel04":"String","productCustomFieldLabel05":"String","splitCourierIntoPickupAndDelivery":false,"useTimeSlots":false,"consignmentsLabel":"String","senderLabel":"String","receiverLabel":"String","productDimensionEntry":"String","usePODPhotographs":false,"jobKinds":[{"id":"String","name":"String"}],"jobStatuses":[{"id":"String","name":"String"}],"jobImportTypes":[{"id":"String","name":"String"}],"jobLegTypes":[{"id":"String","name":"String"}],"jobTypes":[{"id":"String","name":"String"}],"podExceptions":[{"id":"String","name":"String","podStatusID":"String"}],"podStatuses":[{"id":"String","name":"String"}],"tripStatuses":[{"id":"String","name":"String"}],"workflowKinds":[{"id":"String","name":"String"}],"workflowSubKinds":[{"id":"String","name":"String"}],"vehicleTypes":[{"id":"String","name":"String"}],"locationTypes":[{"id":"String","name":"String"}],"activities":[{"id":"00000000000000000000000000000000","name":"String"}],"adminPIN":0,"customers":[{"id":"00000000000000000000000000000000","code":"String","name":"String","accountCode":"String","abn":"String","contactName":"String","contactPhone":"String","contactEmail":"String","companyID":"00000000000000000000000000000000","active":false}],"locations":[{"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"}],"palletTypes":[{"id":"String","name":"String"}],"palletMovementTypes":[{"id":0,"name":"String"}]},"success":false,"errorMessage":"String","errorCode":0}