A Car Delivery Network Job entity.
Inheritance Hierarchy
CarDeliveryNetwork.Api.DataApiEntityBase
CarDeliveryNetwork.Api.DataApiEntityBaseJob
CarDeliveryNetwork.Api.DataJob
Namespace: CarDeliveryNetwork.Api.Data
Assembly: CarDeliveryNetwork.Api.Data (in CarDeliveryNetwork.Api.Data.dll) Version: 3.2.3008.0 (3.2.3008)
Syntax
The Job type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | Job |
Initializes a new instance of the Job class.
|
Properties
Name | Description | |
---|---|---|
![]() | AdvertiseType |
Optional - Should it be advertised for carriers to claim at a fixed price, to quote or both
|
![]() | AllocatedCarrierId |
Optional - The CDN Id of the allocated carrier
|
![]() | AllocatedCarrierScac |
Optional - The SCAC of the allocated carrier
|
![]() | AssignedAppId |
Readonly - The Id of the device used by the assigned driver
|
![]() | AssignedDriverId |
Optional - The Id of the assigned driver
|
![]() | AssignedDriverName |
ReadOnly - The Name of the assigned driver
|
![]() | AssignedDriverRemoteId |
Optional - The RemoteId of the assigned driver
|
![]() | AssignedTruckRemoteId |
Optional - The RemoteId of the assigned truck
|
![]() | BuyPrice |
Optional - The price that the transport company will be paid, in the smallest denomination of the currency
(pennies, cents etc). Must be specified if you are putting the Job into a Fixed Price Network. If not specified will be set to 0.
|
![]() | CdxExchangeId |
Readonly - A unique identifier for the CdnExchange this job is part of
|
![]() | ContractedCarrierId |
Optional - The CDN Id of the entity contracted by the shipper.
|
![]() | ContractedCarrierScac |
Optional - The SCAC of the entity contracted by the shipper.
|
![]() | CreatedDate |
Readonly - The time in UTC that the job was created
|
![]() | Customer |
Mandatory - The customer details for this job.
|
![]() | CustomerReference |
Optional (50) - A customer reference for this job (Does not have to be unique to this job.
For a unique identifier see the Id and LoadId fields).
|
![]() | Documents |
Readonly - A list of documents associated with this job
|
![]() | DriverPay |
Optional - The price that the carrier pays the driver
(pennies, cents etc). Only used if you are the Carrier who pays the driver. If not specified will be set to 0.
|
![]() | Dropoff |
Mandatory - The drop-off details for this job.
|
![]() | FunderCode |
Optional (Reach Community Only) (50) - Code for the request's funder/sponsor
|
![]() | History |
Readonly - A list of history records associated with this job
|
![]() | ImportDisplayString |
String to display after importing this object
|
![]() | InvoiceFleetId |
Readonly - The id of the fleet that needs to be invoiced
|
![]() | IsArchived |
Is Job Archived
|
![]() | IsVinDispatchJob |
Does the job originate from the vinDispatch marketplace
|
![]() | JobInitiator |
Mandatory (40) - Name of person/system initiating this job.
|
![]() | JobNumber |
Readonly (50) - The job's unique job number generated by Car Delivery Network.
|
![]() | JobNumberSuffix |
Optional (API2) - A suffix to apply to the generated job number
|
![]() | LastJourneyId |
Optional - The Id of the Last or Default Journey
|
![]() | LoadboardLookupId |
Optional - Identifier of the Loadboard to advertise job to.
Can be either integer ID or RemoteID
|
![]() | LoadId |
Optional (40) - A unique identifier for this job, generated by the client system.
|
![]() | Mileage |
Optional - The estimated mileage of the job. If not specified system will try to calculate the mileage based on google mapping.
|
![]() | Notes |
Optional (ntext) - The job notes. These notes will be sent to the Driver.
|
![]() | PaymentTerm |
Optional - Payment term for this job.
|
![]() | Pickup |
Mandatory - The pick-up details for this job.
|
![]() | ReferrerCode |
Optional (Reach Community Only) (50) - Code for the request's referrer
|
![]() | RequestReferenceId |
Readonly (25) - The job's associated Request Reference Id from vinDISPATCH, if applicable
|
![]() | SellPrice |
Optional - The price that the customer will be charged, in the smallest denomination of the currency
(pennies, cents etc). If not specified will be set to 0.
|
![]() | ServiceRequired |
Mandatory - The service required for this job (Driven, Transported, Either or Auto). Cannot be Either if job is allocated to a network or carrier.
|
![]() | ShipperId |
Optional - The CDN Id of the shipper to whom this job belongs
|
![]() | ShipperScac |
Optional - The SCAC of the shipper to whom this job belongs
|
![]() | Source |
Optional - Where the job was created
|
![]() | Status |
Readonly - The job's current status
|
![]() | StatusDeviceTime |
Readonly - The time the current status occurred
|
![]() | Tranships |
Optional - A list of tranships associated with this job.
|
![]() | TravelTimeMinutes |
Optional - The estimated travel time of the job.
|
![]() | TripId |
Optional (20) - An id representing the trip this job is part of
|
![]() | VehicleCount |
Readonly - The number of vehicles on this job
|
![]() | Vehicles |
Mandatory - A collection of vehicles associated with this job.
|
![]() | VehiclesCollected |
Readonly - The number of vehicles collected
|
![]() | VehiclesDelivered |
Readonly - The number of vehicles delievered
|
Methods
Name | Description | |
---|---|---|
![]() | ToHookString |
Returns a serial representation of the job in the specified format and schema.
|
![]() | ToShipmentHookString |
Returns a serial representation of the job in the specified format and schema.
|
![]() | ToVehicleHookString |
Returns a serial representation of the job in the specified format and schema.
|
See Also