Job Class

Car Delivery Network API DocumentationCar Delivery Network
A Car Delivery Network Job entity.
Inheritance Hierarchy

SystemObject
  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

public class Job : ApiEntityBase<Job>

The Job type exposes the following members.

Constructors

  NameDescription
Public methodJob
Initializes a new instance of the Job class.
Top
Properties

  NameDescription
Public propertyAdvertiseType
Optional - Should it be advertised for carriers to claim at a fixed price, to quote or both
Public propertyAllocatedCarrierId
Optional - The CDN Id of the allocated carrier
Public propertyAllocatedCarrierScac
Optional - The SCAC of the allocated carrier
Public propertyAssignedAppId
Readonly - The Id of the device used by the assigned driver
Public propertyAssignedDriverId
Optional - The Id of the assigned driver
Public propertyAssignedDriverName
ReadOnly - The Name of the assigned driver
Public propertyAssignedDriverRemoteId
Optional - The RemoteId of the assigned driver
Public propertyAssignedTruckRemoteId
Optional - The RemoteId of the assigned truck
Public propertyBuyPrice
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.
Public propertyCdxExchangeId
Readonly - A unique identifier for the CdnExchange this job is part of
Public propertyContractedCarrierId
Optional - The CDN Id of the entity contracted by the shipper.
Public propertyContractedCarrierScac
Optional - The SCAC of the entity contracted by the shipper.
Public propertyCreatedDate
Readonly - The time in UTC that the job was created
Public propertyCustomer
Mandatory - The customer details for this job.
Public propertyCustomerReference
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).
Public propertyDocuments
Readonly - A list of documents associated with this job
Public propertyDriverPay
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.
Public propertyDropoff
Mandatory - The drop-off details for this job.
Public propertyFunderCode
Optional (Reach Community Only) (50) - Code for the request's funder/sponsor
Public propertyHistory
Readonly - A list of history records associated with this job
Public propertyImportDisplayString
String to display after importing this object
Public propertyInvoiceFleetId
Readonly - The id of the fleet that needs to be invoiced
Public propertyIsArchived
Is Job Archived
Public propertyIsVinDispatchJob
Does the job originate from the vinDispatch marketplace
Public propertyJobInitiator
Mandatory (40) - Name of person/system initiating this job.
Public propertyJobNumber
Readonly (50) - The job's unique job number generated by Car Delivery Network.
Public propertyJobNumberSuffix
Optional (API2) - A suffix to apply to the generated job number
Public propertyLastJourneyId
Optional - The Id of the Last or Default Journey
Public propertyLoadboardLookupId
Optional - Identifier of the Loadboard to advertise job to. Can be either integer ID or RemoteID
Public propertyLoadId
Optional (40) - A unique identifier for this job, generated by the client system.
Public propertyMileage
Optional - The estimated mileage of the job. If not specified system will try to calculate the mileage based on google mapping.
Public propertyNotes
Optional (ntext) - The job notes. These notes will be sent to the Driver.
Public propertyPaymentTerm
Optional - Payment term for this job.
Public propertyPickup
Mandatory - The pick-up details for this job.
Public propertyReferrerCode
Optional (Reach Community Only) (50) - Code for the request's referrer
Public propertyRequestReferenceId
Readonly (25) - The job's associated Request Reference Id from vinDISPATCH, if applicable
Public propertySellPrice
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.
Public propertyServiceRequired
Mandatory - The service required for this job (Driven, Transported, Either or Auto). Cannot be Either if job is allocated to a network or carrier.
Public propertyShipperId
Optional - The CDN Id of the shipper to whom this job belongs
Public propertyShipperScac
Optional - The SCAC of the shipper to whom this job belongs
Public propertySource
Optional - Where the job was created
Public propertyStatus
Readonly - The job's current status
Public propertyStatusDeviceTime
Readonly - The time the current status occurred
Public propertyTranships
Optional - A list of tranships associated with this job.
Public propertyTravelTimeMinutes
Optional - The estimated travel time of the job.
Public propertyTripId
Optional (20) - An id representing the trip this job is part of
Public propertyVehicleCount
Readonly - The number of vehicles on this job
Public propertyVehicles
Mandatory - A collection of vehicles associated with this job.
Public propertyVehiclesCollected
Readonly - The number of vehicles collected
Public propertyVehiclesDelivered
Readonly - The number of vehicles delievered
Top
Methods

  NameDescription
Public methodToHookString
Returns a serial representation of the job in the specified format and schema.
Public methodToShipmentHookString
Returns a serial representation of the job in the specified format and schema.
Public methodToVehicleHookString
Returns a serial representation of the job in the specified format and schema.
Top
See Also

Reference