Transfocus POD Web Services

<back to all web services

SetJobDataRequest

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

HTTP + XML

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

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

<SetJobDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transfocus.POD.WS.Services">
  <AuthToken xmlns="http://schemas.datacontract.org/2004/07/Transfocus.POD.WS.Services.Objects">String</AuthToken>
  <Job xmlns:d2p1="http://schemas.datacontract.org/2004/07/Transfocus.POD.BusinessLogic.BusinessObjects.TMS">
    <d2p1:ConsignmentNumber>String</d2p1:ConsignmentNumber>
    <d2p1:ConsignmentReference>String</d2p1:ConsignmentReference>
    <d2p1:CreatedBy>String</d2p1:CreatedBy>
    <d2p1:CustomerCode>String</d2p1:CustomerCode>
    <d2p1:CustomerID>00000000-0000-0000-0000-000000000000</d2p1:CustomerID>
    <d2p1:CustomerReference>String</d2p1:CustomerReference>
    <d2p1:Doors>String</d2p1:Doors>
    <d2p1:DriverCode>String</d2p1:DriverCode>
    <d2p1:DriverID>00000000-0000-0000-0000-000000000000</d2p1:DriverID>
    <d2p1:DueTimestamp>0001-01-01T00:00:00</d2p1:DueTimestamp>
    <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
    <d2p1:Instructions>String</d2p1:Instructions>
    <d2p1:JobKindID>String</d2p1:JobKindID>
    <d2p1:JobLegTypeID>String</d2p1:JobLegTypeID>
    <d2p1:JobNumber>String</d2p1:JobNumber>
    <d2p1:JobReference>String</d2p1:JobReference>
    <d2p1:JobTypeID>String</d2p1:JobTypeID>
    <d2p1:LegPallets>
      <d2p1:JobLegPallet>
        <d2p1:BookedQuantity>0</d2p1:BookedQuantity>
        <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
        <d2p1:MovementTypeID>0</d2p1:MovementTypeID>
        <d2p1:PalletTypeID>String</d2p1:PalletTypeID>
      </d2p1:JobLegPallet>
    </d2p1:LegPallets>
    <d2p1:LegProducts>
      <d2p1:JobLegProduct>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:Cubic>0</d2p1:Cubic>
        <d2p1:Depth>0</d2p1:Depth>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Height>0</d2p1:Height>
        <d2p1:Hooks>0</d2p1:Hooks>
        <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
        <d2p1:JobLegID>00000000-0000-0000-0000-000000000000</d2p1:JobLegID>
        <d2p1:Pallet>0</d2p1:Pallet>
        <d2p1:ProductCode>String</d2p1:ProductCode>
        <d2p1:ProductID>00000000-0000-0000-0000-000000000000</d2p1:ProductID>
        <d2p1:Quantity>0</d2p1:Quantity>
        <d2p1:ScannedLoad>false</d2p1:ScannedLoad>
        <d2p1:ScannedOff>false</d2p1:ScannedOff>
        <d2p1:Space>0</d2p1:Space>
        <d2p1:Temp>String</d2p1:Temp>
        <d2p1:Ties>0</d2p1:Ties>
        <d2p1:TimestampScanLoad>0001-01-01T00:00:00</d2p1:TimestampScanLoad>
        <d2p1:TimestampScanOff>0001-01-01T00:00:00</d2p1:TimestampScanOff>
        <d2p1:Weight>0</d2p1:Weight>
        <d2p1:Width>0</d2p1:Width>
      </d2p1:JobLegProduct>
    </d2p1:LegProducts>
    <d2p1:MasterNumber>String</d2p1:MasterNumber>
    <d2p1:Product>String</d2p1:Product>
    <d2p1:RecepientCode>String</d2p1:RecepientCode>
    <d2p1:RecepientID>00000000-0000-0000-0000-000000000000</d2p1:RecepientID>
    <d2p1:RecepientNote>String</d2p1:RecepientNote>
    <d2p1:RecepientPhone>String</d2p1:RecepientPhone>
    <d2p1:ReleaseNumber>String</d2p1:ReleaseNumber>
    <d2p1:RouteOrder>0</d2p1:RouteOrder>
    <d2p1:SenderCode>String</d2p1:SenderCode>
    <d2p1:SenderID>00000000-0000-0000-0000-000000000000</d2p1:SenderID>
    <d2p1:SenderNote>String</d2p1:SenderNote>
    <d2p1:SenderPhone>String</d2p1:SenderPhone>
    <d2p1:ServiceCode>String</d2p1:ServiceCode>
    <d2p1:ServiceCodeID>00000000-0000-0000-0000-000000000000</d2p1:ServiceCodeID>
    <d2p1:Trailer1Code>String</d2p1:Trailer1Code>
    <d2p1:Trailer1ID>00000000-0000-0000-0000-000000000000</d2p1:Trailer1ID>
    <d2p1:Trailer2Code>String</d2p1:Trailer2Code>
    <d2p1:Trailer2ID>00000000-0000-0000-0000-000000000000</d2p1:Trailer2ID>
    <d2p1:UseScanLoad>false</d2p1:UseScanLoad>
    <d2p1:UseScanOff>false</d2p1:UseScanOff>
    <d2p1:VehicleCode>String</d2p1:VehicleCode>
    <d2p1:VehicleID>00000000-0000-0000-0000-000000000000</d2p1:VehicleID>
    <d2p1:Weight>0</d2p1:Weight>
    <d2p1:WorkflowID>String</d2p1:WorkflowID>
    <d2p1:WorkflowSubID>String</d2p1:WorkflowSubID>
  </Job>
</SetJobDataRequest>

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

<SetJobDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transfocus.POD.WS.Services">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Transfocus.POD.WS.Services.Objects">0</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Transfocus.POD.WS.Services.Objects">String</ErrorMessage>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Transfocus.POD.WS.Services.Objects">false</Success>
</SetJobDataResponse>