Click or drag to resize

OpenApiPUT_Jobs__id_

Car Delivery Network
Updates a job either by its CDN Job Id, or its LoadId.

The following updates are supported:

  • Reassign Driver (available up to and including job status AtPickup)
  • Unassign Driver (available up to and including job status AtPickup)
  • Add Vehicle(s) (available up to and including job status AtPickup)
  • Remove Vehicle(s): (available up to and including job status Assigned)

Namespace: CarDeliveryNetwork.Api
Assembly: CarDeliveryNetwork.Api (in CarDeliveryNetwork.Api.dll) Version: 0.0.1.0 (0.0.1.0)
Syntax
C#
Copy
public Job PUT /Jobs/{id}(
	string id,
	Job job
)

Parameters

id  String
The id of the job to update.
job  Job
The job updates to apply.

Return Value

Job
The successfully updated job.
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
idNo/jobs/123The CDN job ID to update. When omitted, an existing LoadId must be included in the request body
regionYesus|uk|trainingus|trainingukThe target CDN API.
apikeyNoapikey=[Your API Key]The API key for this call. Not required when using Authorization header.

Body

Job

Example
URL with CDN Job Id
Copy
https://vincarrier.cardeliverynetwork.com/<region>/vind2/openapi/jobs/123?apikey=299bde73-d4d0-4684-9e51
URL without CDN Job Id
Copy
https://vincarrier.cardeliverynetwork.com/<region>/vind2/openapi/jobs?apikey=299bde73-d4d0-4684-9e51
Body - update by LoadId
Copy
{
  ...

  "LoadId": "ExistingLoadId123",

  ...
}
See Also