Transfocus POD Web Services

<back to all web services

GetCompanySettingsRequest

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

HTTP + CSV

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

POST /csv/reply/GetCompanySettingsRequest HTTP/1.1 
Host: api.podapp.com.au 
Content-Type: text/csv
Content-Length: length

CompanyCode
String


HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

Settings,Success,ErrorMessage,ErrorCode
"{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}]}",False,String,0