Click or drag to resize

OpenApiPOST_Jobs

Car Delivery Network
Creates jobs on Car Delivery Network.

Namespace: CarDeliveryNetwork.Api
Assembly: CarDeliveryNetwork.Api (in CarDeliveryNetwork.Api.dll) Version: 3.2.3107.0 (3.2.3107)
Syntax
C#
Copy
public Jobs POST /Jobs(
	Jobs jobs
)

Parameters

jobs  Jobs
The collection of jobs to create.

Return Value

Jobs
A collection of the successfully created jobs.
Remarks

Headers

HeaderRequiredDescription
Authorization: Basic <credentials>NoThe basic authorization header. Not required when using API key.
Content-Type: application/jsonYesIndicates that the request and response bodies are in JSON format.

URL Parameters

ParameterRequiredUsageDescription
regionYesus|uk|trainingus|trainingukThe target CDN API.
apikeyNoapikey=[Your API Key]The API key for this call. Not required when using Authorization header.
allowupdateNoallowupdate=trueWhen true, calls with a recognized LoadId will update.

Body

Jobs

Example
URL
Copy
https://vincarrier.cardeliverynetwork.com/<region>/vind2/openapi/jobs?apikey=299bde73-d4d0-4684-9e51
Body
Copy
[
   {
      "Notes":"These notes are sent to the driver",
      "ServiceRequired":1,
      "JobInitiator":"Katie Finch(Car Delivery Network)",
      "Customer":{
         "AddressLines":"7280 NW 87th Terr.",
         "City":"Kansas City",
         "Contact":"Car Delivery Network",
         "OrganisationName":"Car Delivery Network, Inc.",
         "QuickCode":"AB12345",
         "StateRegion":"MO",
         "ZipPostCode":"64153"
      },
      "Pickup":{
         "Destination":{
            "AddressLines":"7280 NW 87th Terr.",
            "City":"Kansas City",
            "Contact":"Car Delivery Network",
            "OrganisationName":"Car Delivery Network, Inc.",
            "QuickCode":"XY12345",
            "StateRegion":"MO",
            "ZipPostCode":"64153"
         },
         "RequestedDate":"\/Date(1369872000000)\/"
      },
      "Dropoff":{
         "Destination":{
            "AddressLines":"9211 Forney Rd",
            "City":"Mesquite",
            "OrganisationName":"Mesquite Auto Ramp",
            "QuickCode":"DE12345",
            "StateRegion":"TX",
            "ZipPostCode":"75227"
         },
         "RequestedDate":"\/Date(1369872000000)\/",
         "RequestedDateIsExact":true
      },
      "Vehicles":[
         {
            "Make":"Benz",
            "Model":"Velo",
            "Registration":"1894",
            "Vin":"JFJGIZB7JK6HLBIIO"
         }
      ]
   }
]
Response
Copy
[
   {
      "Id":17,
      "AllocatedCarrierScac":null,
      "AssignedDriverRemoteId":null,
      "BuyPrice":0,
      "ContractedCarrierScac":null,
      "Customer":{
         "Id":73,
         "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":72,
            "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":"SAC10005",
      "LoadId":null,
      "Mileage":0,
      "Notes":"These notes are sent to the driver",
      "Pickup":{
         "Destination":{
            "Id":71,
            "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":23,
            "DamageAtDropoff":[
            ],
            "DamageAtPickup":[

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