OpenApiGET_Jobs__id_ Method

Car Delivery Network API Documentation

Gets the job of the specified Id from Car Delivery Network.

Namespace: CarDeliveryNetwork.Api
Assembly: CarDeliveryNetwork.Api (in CarDeliveryNetwork.Api.dll) Version: 3.2.3017.0 (3.2.3017)

Syntax

C++

Copy

public Job GET_Jobs__id_(
	string id
)

Public Function GET_Jobs__id_ ( 
	id As String
) As Job

public:
Job^ GET_Jobs__id_(
	String^ id
)

Parameters

id: Type: SystemString
Id of the job to get.

Return Value

Type: Job
The datails of the specified job

Remarks

Headers

Header	Description
Content-Type: application/json	Indicates that the request and response bodies are in JSON format
Content-Type: application/xml	Indicates that the request and response bodies are in XML format

Request

Verb	URI
GET	/jobs/id?apikey=xxx-xxx-xxx

This operation does not require a request body.

Response

Normal Response Codes: 200, 203

Error Response Codes: computeFault (400, 500, …), badRequest (400), forbidden (403), itemNotFound (404)

This operation returns a response body, which contains details for the specified job.

Examples

URL

Copy

https://go.cardeliverynetwork.com/en/openapi/jobs/15?apikey=299bde73-d4d0-4684-9e51

JSON Response

Copy

{
   "Id":15,
   "AllocatedCarrierScac":null,
   "AssignedDriverRemoteId":null,
   "BuyPrice":0,
   "ContractedCarrierScac":null,
   "Customer":{
      "Id":67,
      "AddressLines":"7280 NW 87th Terr.",
      "City":"Kansas City",
      "Contact":"Car Delivery Network",
      "Email":null,
      "Fax":null,
      "MobilePhone":null,
      "Notes":null,
      "OrganisationName":"Car Delivery Network, Inc.",
      "OtherPhone":null,
      "Phone":null,
      "QuickCode":"AB12345",
      "StateRegion":"MO",
      "ZipPostCode":"64153"
   },
   "CustomerReference":null,
   "Documents":[

   ],
   "DriverPay":0,
   "Dropoff":{
      "Destination":{
         "Id":66,
         "AddressLines":"9211 Forney Rd",
         "City":"Mesquite",
         "Contact":null,
         "Email":null,
         "Fax":null,
         "MobilePhone":null,
         "Notes":null,
         "OrganisationName":"Mesquite Auto Ramp",
         "OtherPhone":null,
         "Phone":null,
         "QuickCode":"DE12345",
         "StateRegion":"TX",
         "ZipPostCode":"75227"
      },
      "RequestedDate":"\/Date(1369872000000)\/",
      "RequestedDateIsExact":true,
      "Signoff":{
         "NotSignedReason":"",
         "SignedBy":null,
         "Time":null,
         "Url":null
      }
   },
   "JobInitiator":"Katie Finch(Car Delivery Network)",
   "JobNumber":"SAC10003",
   "LoadId":null,
   "Mileage":567,
   "Notes":"These notes are sent to the driver",
   "Pickup":{
      "Destination":{
         "Id":65,
         "AddressLines":"7280 NW 87th Terr.",
         "City":"Kansas City",
         "Contact":"Car Delivery Network",
         "Email":null,
         "Fax":null,
         "MobilePhone":null,
         "Notes":null,
         "OrganisationName":"Car Delivery Network, Inc.",
         "OtherPhone":null,
         "Phone":null,
         "QuickCode":"XY12345",
         "StateRegion":"MO",
         "ZipPostCode":"64153"
      },
      "RequestedDate":"\/Date(1369872000000)\/",
      "RequestedDateIsExact":false,
      "Signoff":{
         "NotSignedReason":"",
         "SignedBy":null,
         "Time":null,
         "Url":null
      }
   },
   "SellPrice":0,
   "ServiceRequired":1,
   "ShipperScac":"SAC",
   "Status":1,
   "TripId":null,
   "Vehicles":[
      {
         "Id":21,
         "DamageAtDropoff":[

         ],
         "DamageAtPickup":[

         ],
         "Location":null,
         "Make":"Benz",
         "Model":"Velo",
         "MovementNumber":null,
         "Notes":null,
         "Registration":"1894",
         "Variant":null,
         "Vin":"JFJGIZB7JK6HLBIIO"
      }
   ]
}

XML Response

Copy

<Job xmlns="http://schemas.datacontract.org/2004/07/CarDeliveryNetwork.Api.Data" 
     xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Id>15</Id>
  <AllocatedCarrierScac i:nil="true" />
  <AssignedDriverRemoteId i:nil="true" />
  <BuyPrice>0</BuyPrice>
  <ContractedCarrierScac i:nil="true" />
  <Customer>
    <Id>67</Id>
    <AddressLines>7280 NW 87th Terr.</AddressLines>
    <City>Kansas City</City>
    <Contact>Car Delivery Network</Contact>
    <Email i:nil="true" />
    <Fax i:nil="true" />
    <MobilePhone i:nil="true" />
    <Notes i:nil="true" />
    <OrganisationName>Car Delivery Network, Inc.</OrganisationName>
    <OtherPhone i:nil="true" />
    <Phone i:nil="true" />
    <QuickCode>AB12345</QuickCode>
    <StateRegion>MO</StateRegion>
    <ZipPostCode>64153</ZipPostCode>
  </Customer>
  <CustomerReference i:nil="true" />
  <Documents />
  <DriverPay>0</DriverPay>
  <Dropoff>
    <Destination>
      <Id>66</Id>
      <AddressLines>9211 Forney Rd</AddressLines>
      <City>Mesquite</City>
      <Contact i:nil="true" />
      <Email i:nil="true" />
      <Fax i:nil="true" />
      <MobilePhone i:nil="true" />
      <Notes i:nil="true" />
      <OrganisationName>Mesquite Auto Ramp</OrganisationName>
      <OtherPhone i:nil="true" />
      <Phone i:nil="true" />
      <QuickCode>DE12345</QuickCode>
      <StateRegion>TX</StateRegion>
      <ZipPostCode>75227</ZipPostCode>
    </Destination>
    <RequestedDate>2013-05-30T00:00:00Z</RequestedDate>
    <RequestedDateIsExact>true</RequestedDateIsExact>
    <Signoff>
      <NotSignedReason />
      <SignedBy i:nil="true" />
      <Time i:nil="true" />
      <Url i:nil="true" />
    </Signoff>
  </Dropoff>
  <JobInitiator>Katie Finch(Car Delivery Network)</JobInitiator>
  <JobNumber>SAC10003</JobNumber>
  <LoadId i:nil="true" />
  <Mileage>567</Mileage>
  <Notes>These notes are sent to the driver</Notes>
  <Pickup>
    <Destination>
      <Id>65</Id>
      <AddressLines>7280 NW 87th Terr.</AddressLines>
      <City>Kansas City</City>
      <Contact>Car Delivery Network</Contact>
      <Email i:nil="true" />
      <Fax i:nil="true" />
      <MobilePhone i:nil="true" />
      <Notes i:nil="true" />
      <OrganisationName>Car Delivery Network, Inc.</OrganisationName>
      <OtherPhone i:nil="true" />
      <Phone i:nil="true" />
      <QuickCode>XY12345</QuickCode>
      <StateRegion>MO</StateRegion>
      <ZipPostCode>64153</ZipPostCode>
    </Destination>
    <RequestedDate>2013-05-30T00:00:00Z</RequestedDate>
    <RequestedDateIsExact>false</RequestedDateIsExact>
    <Signoff>
      <NotSignedReason />
      <SignedBy i:nil="true" />
      <Time i:nil="true" />
      <Url i:nil="true" />
    </Signoff>
  </Pickup>
  <SellPrice>0</SellPrice>
  <ServiceRequired>Transported</ServiceRequired>
  <ShipperScac>SAC</ShipperScac>
  <Status>Created</Status>
  <TripId i:nil="true"/>
  <Vehicles>
    <Vehicle>
      <Id>21</Id>
      <DamageAtDropoff />
      <DamageAtPickup />
      <Location i:nil="true" />
      <Make>Benz</Make>
      <Model>Velo</Model>
      <MovementNumber i:nil="true" />
      <Notes i:nil="true" />
      <Registration>1894</Registration>
      <Variant i:nil="true" />
      <Vin>JFJGIZB7JK6HLBIIO</Vin>
    </Vehicle>
  </Vehicles>
</Job>

Reference

OpenApi Class

CarDeliveryNetwork.Api Namespace

OpenApiAddLanguageSpecificTextSet("LSTF8B0ECF8_0?cpp=::|nu=.");GET_Jobs__id_ Method

Parameters

Return Value

Reference

OpenApiGET_Jobs__id_ Method