A Car Delivery Network Job entity.
Inheritance Hierarchy
ApiEntityBase
ApiEntityBaseJob
CarDeliveryNetwork.Api.DataJob
Namespace: CarDeliveryNetwork.Api.Data
Assembly: CarDeliveryNetwork.Api.Data (in CarDeliveryNetwork.Api.Data.dll) Version: 3.2.3081.0 (3.2.3081)
Syntax
C#
public class Job : ApiEntityBase<Job>
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
|
| AllocatedCarrierDOTNumber |
Optional - The D.O.T number of the allocated carrier
|
| AllocatedCarrierScac |
Optional - The SCAC of the allocated carrier
|
| 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.
|
| ContractedCarrierDOTNumber |
Optional - The D.O.T number of the entity contracted carrier
|
| ContractedCarrierScac |
Optional - The SCAC of the entity contracted by the shipper.
|
| 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
|
| Dropoff |
Mandatory - The drop-off details for this job.
|
| FrequentDamage |
Optional - Collection of frequent damage
|
| FunctionalityFlags |
Optional - Determines app behaviour for this job. NULL enables default behaviour. 0 deactivates all.
|
| History |
Readonly - A list of history records associated with this job
|
| IsRelay |
Optional - flag to indicate relay status
|
| JobInitiator |
Mandatory (40) - Name of person/system initiating this job.
|
| JobNumber |
Readonly (50) - The job's unique job number generated by Car Delivery Network.
|
| 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.
|
| LoadSequenceNumber |
Optional - The sequnce number of this load
|
| Mileage |
Optional - The estimated mileage of the job. If not specified system will try to calculate the mileage based on google mapping.
|
| NIRNumber |
Optional (10) - Registration number required to own and administer heavy vehicles within province of Quebec
|
| 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
|
| 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.
|
| ShipperScac |
Optional - The SCAC of the shipper to whom this job belongs
|
| Status |
Readonly - The job's current status
|
| StatusDeviceTime |
Readonly - The time the current status occurred
|
| TerminalContact |
Optional
|
| TravelTimeMinutes |
Optional - The estimated travel time of the job.
|
| TripId |
Optional (20) - An id representing the trip this job is part of
|
| Vehicles |
Mandatory - A collection of vehicles associated with this job.
|
Methods
| Name | Description | |
|---|---|---|
| ToVehicleDamageHookString |
Returns a serial representation of the job in the specified format and schema.
|
See Also