GET api/{siteCode}/Job/GetJobById/{id}
Gets the Job record by identifier.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteCode |
The site code will be issued when instruction has been received from our mutual client. |
integer |
Required |
id |
The record identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The entire job data record.
JobDataName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
JobNumber | string |
String length: inclusive between 0 and 12 |
|
JobType | string |
String length: inclusive between 0 and 50 |
|
Mode | string |
String length: inclusive between 0 and 50 |
|
JobDate | date |
None. |
|
HouseNumber | string |
String length: inclusive between 0 and 20 |
|
OriginLOCODE | string |
String length: inclusive between 0 and 5 |
|
OriginName | string |
String length: inclusive between 0 and 50 |
|
OriginIATA | string |
String length: inclusive between 0 and 3 |
|
OriginPort | string |
String length: inclusive between 0 and 50 |
|
OriginPortLOCODE | string |
String length: inclusive between 0 and 5 |
|
DestinationLOCODE | string |
String length: inclusive between 0 and 5 |
|
DestinationName | string |
String length: inclusive between 0 and 50 |
|
DestinationIATA | string |
String length: inclusive between 0 and 3 |
|
DestinationPort | string |
String length: inclusive between 0 and 50 |
|
DestinationPortLOCODE | string |
String length: inclusive between 0 and 5 |
|
CustAccNum | string |
String length: inclusive between 0 and 8 |
|
CustomerName | string |
String length: inclusive between 0 and 50 |
|
Principal | string |
String length: inclusive between 0 and 50 |
|
RoutedTariff | string |
String length: inclusive between 0 and 50 |
|
CreditHold | integer |
None. |
|
CustRef | string |
String length: inclusive between 0 and 1000 |
|
CompletedBy | string |
String length: inclusive between 0 and 50 |
|
Complete | integer |
None. |
|
SalesPerson | string |
String length: inclusive between 0 and 50 |
|
WebTrack | integer |
None. |
|
Consol | integer |
None. |
|
ConsolMaster | string |
String length: inclusive between 0 and 50 |
|
Comments | string |
String length: inclusive between 0 and 5000 |
|
Problem | integer |
None. |
|
Cube | decimal number |
None. |
|
TEU | decimal number |
None. |
|
NOP | integer |
None. |
|
Weight | decimal number |
None. |
|
VolWeight | decimal number |
None. |
|
WeightType | string |
String length: inclusive between 0 and 5 |
|
CubeType | string |
String length: inclusive between 0 and 50 |
|
ChargeableWeight | decimal number |
None. |
|
LCL | integer |
None. |
|
ShipperAccNum | string |
String length: inclusive between 0 and 8 |
|
ShipperName | string |
String length: inclusive between 0 and 50 |
|
ShipperAddress | string |
String length: inclusive between 0 and 1000 |
|
ShipperCity | string |
String length: inclusive between 0 and 50 |
|
ShipperCountry | string |
String length: inclusive between 0 and 2 |
|
ShipperPostCode | string |
String length: inclusive between 0 and 50 |
|
ShipperLOCODE | string |
String length: inclusive between 0 and 5 |
|
ShipperContact | string |
String length: inclusive between 0 and 50 |
|
ShipperPhone | string |
String length: inclusive between 0 and 50 |
|
ShipperEmail | string |
String length: inclusive between 0 and 50 |
|
ShipperRef | string |
String length: inclusive between 0 and 1000 |
|
ConsigneeAccNum | string |
String length: inclusive between 0 and 8 |
|
ConsigneeName | string |
String length: inclusive between 0 and 50 |
|
ConsigneeAddress | string |
String length: inclusive between 0 and 1000 |
|
ConsigneeCity | string |
String length: inclusive between 0 and 50 |
|
ConsigneeCountry | string |
String length: inclusive between 0 and 2 |
|
ConsigneePostCode | string |
String length: inclusive between 0 and 50 |
|
ConsigneeLOCODE | string |
String length: inclusive between 0 and 5 |
|
ConsigneeContact | string |
String length: inclusive between 0 and 50 |
|
ConsigneePhone | string |
String length: inclusive between 0 and 25 |
|
ConsigneeEmail | string |
String length: inclusive between 0 and 50 |
|
ConsigneeRef | string |
String length: inclusive between 0 and 1000 |
|
AgentAccNum | string |
String length: inclusive between 0 and 8 |
|
AgentName | string |
String length: inclusive between 0 and 50 |
|
AgentAddress | string |
String length: inclusive between 0 and 1000 |
|
AgentCity | string |
String length: inclusive between 0 and 50 |
|
AgentCountry | string |
String length: inclusive between 0 and 2 |
|
AgentPostCode | string |
String length: inclusive between 0 and 20 |
|
AgentLOCODE | string |
String length: inclusive between 0 and 5 |
|
AgentContact | string |
String length: inclusive between 0 and 50 |
|
AgentPhone | string |
String length: inclusive between 0 and 25 |
|
AgentEmail | string |
String length: inclusive between 0 and 50 |
|
AgentRef | string |
String length: inclusive between 0 and 1000 |
|
CarrierName | string |
String length: inclusive between 0 and 50 |
|
CarrierAccNum | string |
String length: inclusive between 0 and 8 |
|
CarrierCode | string |
String length: inclusive between 0 and 3 |
|
CarrierContact | string |
String length: inclusive between 0 and 50 |
|
CarrierNationality | string |
String length: inclusive between 0 and 50 |
|
UCR | string |
String length: inclusive between 0 and 50 |
|
ArrivalStatus | date |
None. |
|
DocsReceived | date |
None. |
|
EntryNumber | string |
String length: inclusive between 0 and 50 |
|
EntryDate | date |
None. |
|
UCN | string |
String length: inclusive between 0 and 50 |
|
NatureQuantity | string |
String length: inclusive between 0 and 1000 |
|
Commodity | string |
String length: inclusive between 0 and 1000 |
|
DepartureDate | date |
None. |
|
ArrivalDate | date |
None. |
|
ETA | date |
None. |
|
Shed | string |
String length: inclusive between 0 and 50 |
|
BLNumber | string |
String length: inclusive between 0 and 50 |
|
Conveyance | string |
String length: inclusive between 0 and 50 |
|
UnitNumber | string |
String length: inclusive between 0 and 1000 |
|
BookingRef | string |
String length: inclusive between 0 and 50 |
|
VoyageNumber | string |
String length: inclusive between 0 and 50 |
|
ClosingDate | date |
None. |
|
DeliveryDate | date |
None. |
|
StorageLocation | string |
String length: inclusive between 0 and 50 |
|
ValueCarriage | decimal number |
None. |
|
ValueCustoms | decimal number |
None. |
|
ValueCurrency | string |
String length: inclusive between 0 and 3 |
|
Flight1 | string |
String length: inclusive between 0 and 10 |
|
FlightDate | date |
None. |
|
Flight2 | string |
String length: inclusive between 0 and 10 |
|
AWBMaster | string |
String length: inclusive between 0 and 50 |
|
CustomsClearance | date |
None. |
|
SpecialInstructions | string |
String length: inclusive between 0 and 1000 |
|
Template | string |
String length: inclusive between 0 and 50 |
|
NotifyAddress | string |
String length: inclusive between 0 and 1000 |
|
NotifyAccNum | string |
String length: inclusive between 0 and 8 |
|
NotifyRef | string |
String length: inclusive between 0 and 1000 |
|
MarksNumbers | string |
String length: inclusive between 0 and 5000 |
|
Description | string |
String length: inclusive between 0 and 5000 |
|
Terms | string |
String length: inclusive between 0 and 50 |
|
PayableAt | string |
String length: inclusive between 0 and 30 |
|
ForDelivery | string |
String length: inclusive between 0 and 1000 |
|
VesselExchRate | decimal number |
None. |
|
VesselCurrency | string |
String length: inclusive between 0 and 3 |
|
ContainerType | string |
String length: inclusive between 0 and 50 |
|
NumberOfContainers | integer |
None. |
|
ContainerSize | string |
String length: inclusive between 0 and 50 |
|
Hazardous | integer |
None. |
|
HazardousClass | string |
String length: inclusive between 0 and 50 |
|
ShipperComments | string |
String length: inclusive between 0 and 4000 |
|
HaulierComments | string |
String length: inclusive between 0 and 4000 |
|
ShippingLineComments | string |
String length: inclusive between 0 and 4000 |
|
OtherComments | string |
String length: inclusive between 0 and 4000 |
|
Insurance | integer |
None. |
|
TrailerNumber | string |
String length: inclusive between 0 and 50 |
|
CollectionName | string |
String length: inclusive between 0 and 50 |
|
CollectAddress | string |
String length: inclusive between 0 and 1000 |
|
CollectPostCode | string |
String length: inclusive between 0 and 50 |
|
CollectContact | string |
String length: inclusive between 0 and 50 |
|
CollectDate | date |
None. |
|
CollectTime | string |
String length: inclusive between 0 and 50 |
|
DeliveryName | string |
String length: inclusive between 0 and 50 |
|
DeliverAddress | string |
String length: inclusive between 0 and 1000 |
|
DeliverPostCode | string |
String length: inclusive between 0 and 50 |
|
DeliverContact | string |
String length: inclusive between 0 and 50 |
|
DeliverDate | date |
None. |
|
DeliverTime | string |
String length: inclusive between 0 and 50 |
|
Haulier | string |
String length: inclusive between 0 and 50 |
|
ReportingDate | date |
None. |
|
TranShipPort | string |
String length: inclusive between 0 and 50 |
|
TranShipPortLOCODE | string |
String length: inclusive between 0 and 5 |
|
Packing | string |
String length: inclusive between 0 and 50 |
|
Dims | string |
String length: inclusive between 0 and 1000 |
|
StorageDays | decimal number |
None. |
|
ServiceType | string |
String length: inclusive between 0 and 50 |
|
OrderPlaced | date |
None. |
|
EstimatedPickup | date |
None. |
|
ActualPickup | date |
None. |
|
EstimatedClosing | date |
None. |
|
EstimatedDeparture | date |
None. |
|
EstimatedClearance | date |
None. |
|
EstAvailableDelivery | date |
None. |
|
AvailableDelivery | date |
None. |
|
EstimatedDelivery | date |
None. |
|
VesselExchRateBuying | decimal number |
None. |
|
VoyageID | integer |
None. |
|
PrincipalAccNum | string |
String length: inclusive between 0 and 8 |
|
SenderJobID | integer |
None. |
|
SenderID | integer |
None. |
|
UnitOfMeasure | string |
String length: inclusive between 0 and 10 |
|
JobAddrs | Collection of JobAddr |
None. |
|
Dimensions | Collection of Dimension |
None. |
|
ContainerBookings | Collection of ContainerBooking |
None. |
Response Formats
application/json, text/json
{ "ID": 0, "JobNumber": null, "JobType": "Export", "Mode": "AIR", "JobDate": null, "HouseNumber": null, "OriginLOCODE": null, "OriginName": null, "OriginIATA": null, "OriginPort": null, "OriginPortLOCODE": null, "DestinationLOCODE": null, "DestinationName": null, "DestinationIATA": null, "DestinationPort": null, "DestinationPortLOCODE": null, "CustAccNum": null, "CustomerName": "BoxTop Freight Limited", "Principal": null, "RoutedTariff": null, "CreditHold": null, "CustRef": "Customer Ref", "CompletedBy": "Online Booking", "Complete": null, "SalesPerson": null, "WebTrack": null, "Consol": null, "ConsolMaster": null, "Comments": null, "Problem": null, "Cube": null, "TEU": null, "NOP": 1, "Weight": 100.0, "VolWeight": null, "WeightType": "Kgs", "CubeType": null, "ChargeableWeight": 216.0, "LCL": null, "ShipperAccNum": null, "ShipperName": null, "ShipperAddress": null, "ShipperCity": null, "ShipperCountry": null, "ShipperPostCode": null, "ShipperLOCODE": null, "ShipperContact": null, "ShipperPhone": null, "ShipperEmail": null, "ShipperRef": "My Shipment Ref", "ConsigneeAccNum": null, "ConsigneeName": null, "ConsigneeAddress": null, "ConsigneeCity": null, "ConsigneeCountry": null, "ConsigneePostCode": null, "ConsigneeLOCODE": null, "ConsigneeContact": null, "ConsigneePhone": null, "ConsigneeEmail": null, "ConsigneeRef": null, "AgentAccNum": null, "AgentName": null, "AgentAddress": null, "AgentCity": null, "AgentCountry": null, "AgentPostCode": null, "AgentLOCODE": null, "AgentContact": null, "AgentPhone": null, "AgentEmail": null, "AgentRef": null, "CarrierName": null, "CarrierAccNum": null, "CarrierCode": null, "CarrierContact": null, "CarrierNationality": null, "UCR": null, "ArrivalStatus": null, "DocsReceived": null, "EntryNumber": null, "EntryDate": null, "UCN": null, "NatureQuantity": "A big wooden crate with reasonably heavy stuff in it", "Commodity": "A big wooden crate with reasonably heavy stuff in it", "DepartureDate": null, "ArrivalDate": null, "ETA": null, "Shed": null, "BLNumber": null, "Conveyance": null, "UnitNumber": null, "BookingRef": null, "VoyageNumber": null, "ClosingDate": null, "DeliveryDate": null, "StorageLocation": null, "ValueCarriage": 12345.0, "ValueCustoms": null, "ValueCurrency": "USD", "Flight1": null, "FlightDate": null, "Flight2": null, "AWBMaster": null, "CustomsClearance": null, "SpecialInstructions": null, "Template": null, "NotifyAddress": null, "NotifyAccNum": null, "NotifyRef": "My other Consignment Ref/NotifyRef", "MarksNumbers": null, "Description": "A big wooden crate with reasonably heavy stuff in it", "Terms": "CFR", "PayableAt": null, "ForDelivery": null, "VesselExchRate": null, "VesselCurrency": null, "ContainerType": null, "NumberOfContainers": null, "ContainerSize": null, "Hazardous": null, "HazardousClass": null, "ShipperComments": null, "HaulierComments": null, "ShippingLineComments": null, "OtherComments": null, "Insurance": null, "TrailerNumber": null, "CollectionName": null, "CollectAddress": null, "CollectPostCode": null, "CollectContact": null, "CollectDate": null, "CollectTime": null, "DeliveryName": null, "DeliverAddress": null, "DeliverPostCode": null, "DeliverContact": null, "DeliverDate": null, "DeliverTime": null, "Haulier": null, "ReportingDate": null, "TranShipPort": null, "TranShipPortLOCODE": null, "Packing": null, "Dims": null, "StorageDays": null, "ServiceType": "Express", "OrderPlaced": null, "EstimatedPickup": "2014-07-04T00:00:00", "ActualPickup": null, "EstimatedClosing": null, "EstimatedDeparture": null, "EstimatedClearance": null, "EstAvailableDelivery": null, "AvailableDelivery": null, "EstimatedDelivery": "2014-07-08T00:00:00", "VesselExchRateBuying": null, "VoyageID": null, "PrincipalAccNum": null, "SenderJobID": null, "SenderID": null, "UnitOfMeasure": "Metric", "JobAddrs": [ { "AccountNumber": null, "CompanyName": "Consignee Name Inc.", "Address1": "Consignee Address Line 1", "Address2": "Consignee Address Line 2", "City": "Consignee City", "State": "Consignee County/State", "PostalCode": "ZIP", "CountryCode": "US", "TaxNumber": null, "Title": "Mr", "FirstName": "Consignee", "LastName": "Contact", "Phone": "00155555555555", "Email": "emailAddress@ConsigneeCompany.com", "Shipper": null, "Consignee": -1, "Agent": null, "Notify": null }, { "AccountNumber": null, "CompanyName": "Shipper Name Ltd.", "Address1": "Shipper Address Line 1", "Address2": "Shipper Address Line 2", "City": "Shipper City", "State": "Shipper County/State", "PostalCode": "PCode", "CountryCode": "GB", "TaxNumber": null, "Title": "Mr", "FirstName": "Shipper", "LastName": "Contact", "Phone": "01 811 8181", "Email": "emailAddress@ShipperCompany.com", "Shipper": -1, "Consignee": null, "Agent": null, "Notify": null } ], "Dimensions": [], "ContainerBookings": [] }
application/xml, text/xml
<JobData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ID>0</ID> <JobType>Export</JobType> <Mode>AIR</Mode> <JobDate xsi:nil="true" /> <CustomerName>BoxTop Freight Limited</CustomerName> <CreditHold xsi:nil="true" /> <CustRef>Customer Ref</CustRef> <CompletedBy>Online Booking</CompletedBy> <Complete xsi:nil="true" /> <WebTrack xsi:nil="true" /> <Consol xsi:nil="true" /> <Problem xsi:nil="true" /> <Cube xsi:nil="true" /> <TEU xsi:nil="true" /> <NOP>1</NOP> <Weight>100</Weight> <VolWeight xsi:nil="true" /> <WeightType>Kgs</WeightType> <ChargeableWeight>216</ChargeableWeight> <LCL xsi:nil="true" /> <ShipperRef>My Shipment Ref</ShipperRef> <ArrivalStatus xsi:nil="true" /> <DocsReceived xsi:nil="true" /> <EntryDate xsi:nil="true" /> <NatureQuantity>A big wooden crate with reasonably heavy stuff in it</NatureQuantity> <Commodity>A big wooden crate with reasonably heavy stuff in it</Commodity> <DepartureDate xsi:nil="true" /> <ArrivalDate xsi:nil="true" /> <ETA xsi:nil="true" /> <ClosingDate xsi:nil="true" /> <DeliveryDate xsi:nil="true" /> <ValueCarriage>12345</ValueCarriage> <ValueCustoms xsi:nil="true" /> <ValueCurrency>USD</ValueCurrency> <FlightDate xsi:nil="true" /> <CustomsClearance xsi:nil="true" /> <NotifyRef>My other Consignment Ref/NotifyRef</NotifyRef> <Description>A big wooden crate with reasonably heavy stuff in it</Description> <Terms>CFR</Terms> <VesselExchRate xsi:nil="true" /> <NumberOfContainers xsi:nil="true" /> <Hazardous xsi:nil="true" /> <Insurance xsi:nil="true" /> <CollectDate xsi:nil="true" /> <DeliverDate xsi:nil="true" /> <ReportingDate xsi:nil="true" /> <StorageDays xsi:nil="true" /> <ServiceType>Express</ServiceType> <OrderPlaced xsi:nil="true" /> <EstimatedPickup>2014-07-04T00:00:00</EstimatedPickup> <ActualPickup xsi:nil="true" /> <EstimatedClosing xsi:nil="true" /> <EstimatedDeparture xsi:nil="true" /> <EstimatedClearance xsi:nil="true" /> <EstAvailableDelivery xsi:nil="true" /> <AvailableDelivery xsi:nil="true" /> <EstimatedDelivery>2014-07-08T00:00:00</EstimatedDelivery> <VesselExchRateBuying xsi:nil="true" /> <VoyageID xsi:nil="true" /> <SenderJobID xsi:nil="true" /> <SenderID xsi:nil="true" /> <UnitOfMeasure>Metric</UnitOfMeasure> <JobAddrs> <JobAddr> <ID>0</ID> <AddressID xsi:nil="true" /> <JobDataID xsi:nil="true" /> <CompanyName>Consignee Name Inc.</CompanyName> <Address1>Consignee Address Line 1</Address1> <Address2>Consignee Address Line 2</Address2> <City>Consignee City</City> <State>Consignee County/State</State> <PostalCode>ZIP</PostalCode> <CountryCode>US</CountryCode> <Title>Mr</Title> <FirstName>Consignee</FirstName> <LastName>Contact</LastName> <Phone>00155555555555</Phone> <Email>emailAddress@ConsigneeCompany.com</Email> <Shipper xsi:nil="true" /> <Consignee>-1</Consignee> <Agent xsi:nil="true" /> <Notify xsi:nil="true" /> </JobAddr> <JobAddr> <ID>0</ID> <AddressID xsi:nil="true" /> <JobDataID xsi:nil="true" /> <CompanyName>Shipper Name Ltd.</CompanyName> <Address1>Shipper Address Line 1</Address1> <Address2>Shipper Address Line 2</Address2> <City>Shipper City</City> <State>Shipper County/State</State> <PostalCode>PCode</PostalCode> <CountryCode>GB</CountryCode> <Title>Mr</Title> <FirstName>Shipper</FirstName> <LastName>Contact</LastName> <Phone>01 811 8181</Phone> <Email>emailAddress@ShipperCompany.com</Email> <Shipper>-1</Shipper> <Consignee xsi:nil="true" /> <Agent xsi:nil="true" /> <Notify xsi:nil="true" /> </JobAddr> </JobAddrs> <Dimensions /> <ContainerBookings /> </JobData>