Transfocus POD Web Services

<back to all web services

RapidGetJobsRequest

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

<RapidGetJobsRequest 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">00000000-0000-0000-0000-000000000000</AuthToken>
  <JobLegIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </JobLegIDs>
  <TimeStamp>0001-01-01T00:00:00</TimeStamp>
</RapidGetJobsRequest>

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

<RapidGetJobsResponse 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>
  <JobLegs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Transfocus.POD.BusinessLogic.BusinessObjects.Mobile">
    <d2p1:JobLeg>
      <d2p1:Acknowledged>false</d2p1:Acknowledged>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:ArrivedReceiverTimestamp>0001-01-01T00:00:00</d2p1:ArrivedReceiverTimestamp>
      <d2p1:ArrivedSenderTimestamp>0001-01-01T00:00:00</d2p1:ArrivedSenderTimestamp>
      <d2p1:BookDate>0001-01-01T00:00:00</d2p1:BookDate>
      <d2p1:BookDateString>String</d2p1:BookDateString>
      <d2p1:ConsignmentNumber>String</d2p1:ConsignmentNumber>
      <d2p1:ConsignmentReference>String</d2p1:ConsignmentReference>
      <d2p1:CourierDeliveryOrderNumber>0</d2p1:CourierDeliveryOrderNumber>
      <d2p1:CourierPickupOrderNumber>0</d2p1:CourierPickupOrderNumber>
      <d2p1:Customer>
        <d2p1:ABN>String</d2p1:ABN>
        <d2p1:AccountCode>String</d2p1:AccountCode>
        <d2p1:Active>false</d2p1:Active>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:CompanyID>00000000-0000-0000-0000-000000000000</d2p1:CompanyID>
        <d2p1:ContactEmail>String</d2p1:ContactEmail>
        <d2p1:ContactName>String</d2p1:ContactName>
        <d2p1:ContactPhone>String</d2p1:ContactPhone>
        <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Customer>
      <d2p1:CustomerCode>String</d2p1:CustomerCode>
      <d2p1:CustomerID>00000000-0000-0000-0000-000000000000</d2p1:CustomerID>
      <d2p1:CustomerReference>String</d2p1:CustomerReference>
      <d2p1:DangerousGoods>false</d2p1:DangerousGoods>
      <d2p1:DepartedReceiverTimestamp>0001-01-01T00:00:00</d2p1:DepartedReceiverTimestamp>
      <d2p1:DepartedSenderTimestamp>0001-01-01T00:00:00</d2p1:DepartedSenderTimestamp>
      <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:ETA>0001-01-01T00:00:00</d2p1:ETA>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Instructions>String</d2p1:Instructions>
      <d2p1:JobID>00000000-0000-0000-0000-000000000000</d2p1:JobID>
      <d2p1:JobKindID>String</d2p1:JobKindID>
      <d2p1:JobLegTypeID>String</d2p1:JobLegTypeID>
      <d2p1:JobNumber>String</d2p1:JobNumber>
      <d2p1:JobReference>String</d2p1:JobReference>
      <d2p1:JobReferences>
        <d2p1:JobReference>
          <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Value>String</d2p1:Value>
        </d2p1:JobReference>
      </d2p1:JobReferences>
      <d2p1:JobTypeID>String</d2p1:JobTypeID>
      <d2p1:LegPallets>
        <d2p1:JobLegPallet>
          <d2p1:BookedQuantity>0</d2p1:BookedQuantity>
          <d2p1:DeliveredQuantity>0</d2p1:DeliveredQuantity>
          <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
          <d2p1:JobLegID>00000000-0000-0000-0000-000000000000</d2p1:JobLegID>
          <d2p1:JobLegProductID>00000000-0000-0000-0000-000000000000</d2p1:JobLegProductID>
          <d2p1:PalletMovementTypeID>0</d2p1:PalletMovementTypeID>
          <d2p1:PalletTypeID>String</d2p1:PalletTypeID>
          <d2p1:PickedQuantity>0</d2p1:PickedQuantity>
          <d2p1:Quantity>0</d2p1:Quantity>
        </d2p1:JobLegPallet>
      </d2p1:LegPallets>
      <d2p1:LegProducts>
        <d2p1:JobLegProduct>
          <d2p1:Barcode>String</d2p1:Barcode>
          <d2p1:Cubic>0</d2p1:Cubic>
          <d2p1:CustomField01>0</d2p1:CustomField01>
          <d2p1:CustomField02>0</d2p1:CustomField02>
          <d2p1:CustomField03>0</d2p1:CustomField03>
          <d2p1:CustomField04>0</d2p1:CustomField04>
          <d2p1:CustomField05>0</d2p1:CustomField05>
          <d2p1:Depth>0</d2p1:Depth>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:Height>0</d2p1:Height>
          <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
          <d2p1:JobLegID>00000000-0000-0000-0000-000000000000</d2p1:JobLegID>
          <d2p1:Pallet>0</d2p1:Pallet>
          <d2p1:Product>
            <d2p1:Active>false</d2p1:Active>
            <d2p1:Code>String</d2p1:Code>
            <d2p1:CompanyID>00000000-0000-0000-0000-000000000000</d2p1:CompanyID>
            <d2p1:Cubic>0</d2p1:Cubic>
            <d2p1:Depth>0</d2p1:Depth>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:Height>0</d2p1:Height>
            <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:QuantityPerUnit>0</d2p1:QuantityPerUnit>
            <d2p1:Reference>String</d2p1:Reference>
            <d2p1:Unit>String</d2p1:Unit>
            <d2p1:Weight>0</d2p1:Weight>
            <d2p1:Width>0</d2p1:Width>
          </d2p1:Product>
          <d2p1:ProductID>00000000-0000-0000-0000-000000000000</d2p1:ProductID>
          <d2p1:Quantity>0</d2p1:Quantity>
          <d2p1:Reference>String</d2p1:Reference>
          <d2p1:ScannedLoad>false</d2p1:ScannedLoad>
          <d2p1:ScannedOff>false</d2p1:ScannedOff>
          <d2p1:ShippingUnit>String</d2p1:ShippingUnit>
          <d2p1:Space>0</d2p1:Space>
          <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:PODExceptionID>String</d2p1:PODExceptionID>
      <d2p1:PODStatusID>String</d2p1:PODStatusID>
      <d2p1:PalletQuantity>0</d2p1:PalletQuantity>
      <d2p1:ProductCode>String</d2p1:ProductCode>
      <d2p1:ProductName>String</d2p1:ProductName>
      <d2p1:ProductQuantity>0</d2p1:ProductQuantity>
      <d2p1:ReadyFromDate>0001-01-01T00:00:00</d2p1:ReadyFromDate>
      <d2p1:ReadyFromDateString>String</d2p1:ReadyFromDateString>
      <d2p1:ReceiverWaitingTime>0</d2p1:ReceiverWaitingTime>
      <d2p1:Recepient>
        <d2p1:Active>false</d2p1:Active>
        <d2p1:Address>String</d2p1:Address>
        <d2p1:City>String</d2p1:City>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:CompanyID>00000000-0000-0000-0000-000000000000</d2p1:CompanyID>
        <d2p1:Country>String</d2p1:Country>
        <d2p1:CountryID>0</d2p1:CountryID>
        <d2p1:GeoLatitude>0</d2p1:GeoLatitude>
        <d2p1:GeoLongitude>0</d2p1:GeoLongitude>
        <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
        <d2p1:LocationTypeID>String</d2p1:LocationTypeID>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:PolygonPoints>
          <d2p1:LocationPolygonPoint>
            <d2p1:GeoLatitude>0</d2p1:GeoLatitude>
            <d2p1:GeoLongitude>0</d2p1:GeoLongitude>
            <d2p1:Ordinal>0</d2p1:Ordinal>
          </d2p1:LocationPolygonPoint>
        </d2p1:PolygonPoints>
        <d2p1:PostCode>String</d2p1:PostCode>
        <d2p1:State>String</d2p1:State>
      </d2p1:Recepient>
      <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:Ref>0</d2p1:Ref>
      <d2p1:ReleaseNumber>String</d2p1:ReleaseNumber>
      <d2p1:RequiredDate>0001-01-01T00:00:00</d2p1:RequiredDate>
      <d2p1:RequiredDateString>String</d2p1:RequiredDateString>
      <d2p1:RouteOrder>0</d2p1:RouteOrder>
      <d2p1:Sender>
        <d2p1:Active>false</d2p1:Active>
        <d2p1:Address>String</d2p1:Address>
        <d2p1:City>String</d2p1:City>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:CompanyID>00000000-0000-0000-0000-000000000000</d2p1:CompanyID>
        <d2p1:Country>String</d2p1:Country>
        <d2p1:CountryID>0</d2p1:CountryID>
        <d2p1:GeoLatitude>0</d2p1:GeoLatitude>
        <d2p1:GeoLongitude>0</d2p1:GeoLongitude>
        <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
        <d2p1:LocationTypeID>String</d2p1:LocationTypeID>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:PolygonPoints>
          <d2p1:LocationPolygonPoint>
            <d2p1:GeoLatitude>0</d2p1:GeoLatitude>
            <d2p1:GeoLongitude>0</d2p1:GeoLongitude>
            <d2p1:Ordinal>0</d2p1:Ordinal>
          </d2p1:LocationPolygonPoint>
        </d2p1:PolygonPoints>
        <d2p1:PostCode>String</d2p1:PostCode>
        <d2p1:State>String</d2p1:State>
      </d2p1:Sender>
      <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:SenderSigned>false</d2p1:SenderSigned>
      <d2p1:SenderSignedBy>String</d2p1:SenderSignedBy>
      <d2p1:SenderWaitingTime>0</d2p1:SenderWaitingTime>
      <d2p1:Seq>0</d2p1:Seq>
      <d2p1:ServiceCode>String</d2p1:ServiceCode>
      <d2p1:ServiceCodeName>String</d2p1:ServiceCodeName>
      <d2p1:Signed>false</d2p1:Signed>
      <d2p1:SignedBy>String</d2p1:SignedBy>
      <d2p1:TakenShort>false</d2p1:TakenShort>
      <d2p1:TimeSlotFrom>PT0S</d2p1:TimeSlotFrom>
      <d2p1:TimeSlotFromTo>String</d2p1:TimeSlotFromTo>
      <d2p1:TimeSlotTo>PT0S</d2p1:TimeSlotTo>
      <d2p1:Timestamp>0001-01-01T00:00:00</d2p1:Timestamp>
      <d2p1:TimestampAcknowledged>0001-01-01T00:00:00</d2p1:TimestampAcknowledged>
      <d2p1:Trailer1ID>00000000-0000-0000-0000-000000000000</d2p1:Trailer1ID>
      <d2p1:Trailer2ID>00000000-0000-0000-0000-000000000000</d2p1:Trailer2ID>
      <d2p1:TripStatusID>String</d2p1:TripStatusID>
      <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>
    </d2p1:JobLeg>
  </JobLegs>
  <Jobs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Transfocus.POD.BusinessLogic.BusinessObjects.Mobile">
    <d2p1:Job>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:CustomerID>00000000-0000-0000-0000-000000000000</d2p1:CustomerID>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Instructions>String</d2p1:Instructions>
      <d2p1:JobImportTypeID>String</d2p1:JobImportTypeID>
      <d2p1:JobKindID>String</d2p1:JobKindID>
      <d2p1:JobNumber>String</d2p1:JobNumber>
      <d2p1:JobReference>String</d2p1:JobReference>
      <d2p1:JobStatusID>String</d2p1:JobStatusID>
      <d2p1:RecipientID>00000000-0000-0000-0000-000000000000</d2p1:RecipientID>
      <d2p1:RecipientNote>String</d2p1:RecipientNote>
      <d2p1:RecipientPhone>String</d2p1:RecipientPhone>
      <d2p1:SenderID>00000000-0000-0000-0000-000000000000</d2p1:SenderID>
      <d2p1:SenderNote>String</d2p1:SenderNote>
      <d2p1:SenderPhone>String</d2p1:SenderPhone>
      <d2p1:Timestamp>0001-01-01T00:00:00</d2p1:Timestamp>
    </d2p1:Job>
  </Jobs>
</RapidGetJobsResponse>