Trip
Namespace: CCPEntities
Summary
A Trip describes how it's underlying Movements should be executed, by specifyingthe Vehicle, Driver and/or the AssignedTransporter. The underlying Movements describe
the planned transport of the individual Travelers. At least one Movement should be present.
Multiple Trips could be combined using a TripCombination.
Syncable
This object is syncableProperties
| Name | Type | FixedLength | MaxLength/Range | Identity | Summary | Value | |
|---|---|---|---|---|---|---|---|
|
TripId* | Edm.Int32 | False | true | Gets or sets the trip id. | The trip id. | |
| NoCalculation* | Edm.Boolean | False | |||||
| RouteNumber | Edm.String | False | 15 | Gets or sets the route number. | The route number. | ||
| Description | Edm.String | False | 2048 | Gets or sets the description. | The description. | ||
| PlannedDistance* | Edm.Double | False | Gets or sets the planned distance. | The planned distance. | |||
| TravelerCount* | Edm.Int32 | False | Gets or sets the traveler count. | The traveler count. | |||
| WheelchairCount* | Edm.Int32 | False | Gets or sets the wheelchair count. | The wheelchair count. | |||
| AttendantCount* | Edm.Int32 | False | Gets or sets the attendant count. | The attendant count. | |||
| StatusName* | TripStatus | False | Gets or sets the name of the status. | Text of CCPEntities.TripStatus | |||
| CancelReasonName | TripCancelReason | False | |||||
| TripScopeName* | TripScope | False | 15 | Gets or sets the trip scope. |
|
||
| DayCode | Edm.String | False | 20 | Gets or sets the day code. | The day code. | ||
| Remark | Edm.String | False | 250 | Gets or sets the remark. | The remark. | ||
| InternalRemark | Edm.String | False | 250 | ||||
| Reference | Edm.String | False | 150 | Gets or sets the reference. | The reference. | ||
| EmailAddress | Edm.String | False | 150 | Email address of the requester. It can be used to send an email to the requester for after sales. | A valid email address | ||
| PaymentTypeName | PaymentType | False | 50 | Gets or sets the name of the payment type. | The name of the payment type. | ||
| VehicleKindName | VehicleKind | False | Gets or sets the name of the vehicle kind. | The name of the vehicle kind. | |||
| DatacommunicationTripId | Edm.Int32 | False | Gets or sets the datacommunication trip id. | The datacommunication trip id. | |||
| TransporterTripId | Edm.Int32 | False | Gets or sets the transporter trip id. | The transporter trip id. | |||
| LastUpdated | Edm.DateTime | False | Gets or sets the last updated. | The last updated. | |||
| ShiftId | Edm.Int32 | False | Gets or sets the shift id. | The shift id. | |||
| VehicleId | Edm.Int32 | False | Gets or sets the vehicle id. | The vehicle id. | |||
| DriverId | Edm.Int32 | False | Gets or sets the driver id. | The driver id. | |||
| ContractorId | Edm.Int32 | False | Gets or sets the contractor id. | The contractor id. | |||
| TransporterId* | Edm.Int32 | False | Gets or sets the transporter id. | The transporter id. | |||
| AssignedTransporterId | Edm.Int32 | False | Gets or sets the assigned transporter id. | The assigned transporter id. | |||
| ReferencedTripId | Edm.Int32 | False | The id of the trip that this trip refers to. This is usaly used in combination with TripScope. | The previous trip id. | |||
| VehicleTypeId | Edm.Int32 | False | |||||
| Deleted* | Edm.Boolean | False | Gets or sets a value indicating whether this CCPEntities.Trip is logically deleted. |
|
|||
| ExecutingTransporterId | Edm.Int32 | False | The Transporter that is actually executing the Trip | This column is automatically filled based on Trip.Driver.AssignedTransporterId and Trip.Vehicle.AssignedTransporterId | |||
| TravelerId | Edm.Int32 | False | |||||
| TravelerDescription | Edm.String | False | |||||
| PickUpLocationId | Edm.Int32 | False | |||||
| PickupDescription | Edm.String | False | |||||
| DropOffLocationId | Edm.Int32 | False | |||||
| DropOffDescription | Edm.String | False | |||||
| PlannedPickupTime* | Edm.DateTime | False | |||||
| PlannedDropoffTime | Edm.DateTime | False | |||||
| TravelerName | Edm.String | False | The full name of the traveler if the traveler is unknown as a CCPEntities.Traveler entity. | Can be used in any format. | |||
| PhoneNumber | Edm.String | False | The phone number of the requester. | Can be used in any format. | |||
| CallBackService* | Edm.Boolean | False | A bool telling wether the traveler wants to use a callback service | ||||
| NotifyTraveler* | Edm.Boolean | False | Indicates whether the requester will be notified by email of the status of the booking | True or False | |||
| NotificationLanguage | Edm.String | False | When set, the user will receive an email of any changes to the booking. | Language code based on ISO 639-1 | |||
| FlightNumber | Edm.String | False | Links the trip to a flight. | The flight number. | |||
| FlightDateTime | Edm.DateTime | False | Time of the flight. | Time of the flight. | |||
| FlightOrigin | Edm.String | False | |||||
| PlannedDuration | Edm.Int32 | False | The planned duration between the pick up and drop off. | Total seconds. | |||
| TripDateTimeTypeName | TripDateTimeType | False | With this the trip datetime can be specified as pickup time or drop off time. Use Immediately to the TripDateTimeType to pick up now. | CCPEntities.TripDateTimeType | |||
| AgentId | Edm.Int32 | False | |||||
| PickUpAddress | AddressFragment | False | In order to create a booking without a pickup address, set an CCPEntities.AddressFragment without any of the properties set. | The pick up address. | |||
| DropOffAddress | AddressFragment | False | In order to create a booking without a drop of address, set an CCPEntities.AddressFragement without any of the properties set. | The drop off address. |
Navigation Properties
| Name | Type | Multiplicity | Summary | |
|---|---|---|---|---|
| AssignedTransporter | Transporter | 0..1 | Gets or sets the assigned transporter. | |
| Transporter | Transporter | 0..1 | Gets or sets the transporter. | |
| Agent | Agent | 0..1 | ||
| Amounts | Amount | * | Gets or sets the amounts. | |
| Contractor | Contractor | 0..1 | Gets or sets the contractor. | |
| Driver | Driver | 0..1 | Gets or sets the driver. | |
| Dispatches | Dispatch | * | Gets or sets the dispatches. | |
| Complaints | Complaint | 0..1 | ||
| DropOffLocation | Location | * | Reference to the drop off location. | |
| ExecutingTransporter | Transporter | * | The Transporter that is actually executing the Trip | |
| Indications | Indication | 0..1 | Gets or sets the indications. | |
| Payments | Payment | 0..1 | ||
| PickUpLocation | Location | * | Reference to the pick up location. | |
| RatingValues | RatingValue | 0..1 | ||
| Receipt | Receipt | 0..1 | ||
| ReferencedByTrips | Trip | 0..1 | The Trips that refer to this trip. This is usaly used in combination with TripScope. | |
| ReferencedTrip | Trip | 0..1 | The trip that this trip refers to. This is usaly used in combination with TripScope. | |
| Shift | Shift | * | Gets or sets the shift. | |
| Traveler | Traveler | * | ||
| Travelers | Traveler | * | A collection of the travelers that will travel with the booking. | |
| Vehicle | Vehicle | * | Gets or sets the vehicle. | |
| VehicleType | VehicleType | * |
Additional Information
Notable information when adding a recordChecks if the user has sufficient rights to add/change/delete a trip and performs the desired operation
Referenced by Function imports:
Trip.Accept
Trip.Reject
Trip.CancelTrip
Trip.EmailTrip
Trip.Withdraw
Trip.Modify
Trip.InTransit
Trip.Start
Trip.Stop
Trip.SetNoShow
Trip.RequestNoShow
Trip.Cancel
Trip.RequestCancel
Trip.SyncWithUnit