Booking

Namespace: CCPEntities

Summary

Bookings are used to request the transport of one or more CCPEntities.Travelers.
The CCPEntities.Transporter at which the booking is addressed (using TransporterId) has
the responsibility to respond to the booking, either by rejecting it (StatusName = CCPEntities.BookingStatus.Declined) or
by accepting it (StatusName = CCPEntities.BookingStatus.Confirmed). In the latter case a CCPEntities.Trip will
be created and the booking will be linked to the Trip.

Syncable

This object is syncable

Properties

Name Type FixedLength MaxLength/Range Identity Summary Value
key BookingId* Edm.Int32 False true The key identifier of the booking The booking id.
BookingDateTime* Edm.DateTime False The datetime of the booking. Depending on the CCPEntities.BookingDateTimeType it's the pickup datetime or dropoff datetime. UTC datetime
PickUpDescription Edm.String False 100 When the pick up address or location can't be specified, fill in a description. Example: Rijksmuseum
PickUpLocationTypeName Edm.String False 50 When this is a pickup location only defined by its description this field may be used to specify the type
DropOffDescription Edm.String False 100 When the drop off address or location can't be specified, fill in a description. Example: Rijksmuseum
DropOffLocationTypeName Edm.String False 50 When this is a dropoff location only defined by its description this field may be used to specify the type
BookingDateTimeTypeName* BookingDateTimeType False With this the booking datetime can be specified as pickup time or drop off time. Use Immediately to the BookingDateTime to pick up now. CCPEntities.BookingDateTimeType
StatusName* BookingStatus False The status of the booking. Usually folows the next flow: New ->     Confirmed or Declined or -> Cancelled CCPEntities.BookingStatus
BookingScopeName* BookingScope False 15 The scope of the booking CCPEntities.BookingScope
LastUpdated Edm.DateTime False
TravelerCount* Edm.Int32 False The amount of travelers that apply to this booking.
Before CCPServiceVersion 33, this field must be set manually
Since CCPServiceVersion 33, this is a calculated field that cannot be set. Instead it is a sum of all 'REIZIGER' and 'MEDEREIZIGER' indications.
The traveler count.
Deleted* Edm.Boolean False
TravelerName Edm.String False 100 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 20 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
EmailAddress Edm.String False 150 Email address of the requester. Is required when NotificationLanguage is set or in versions prior to 9 when NotifyTraveler is set. Any valid email address.
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
InternalRemark Edm.String False 150
Remark Edm.String False 150 A remark for the receiver of the booking. The remark.
TravelerDescription Edm.String False Description as shown in the Travelers Description column at the time of creation of the booking.
Reference Edm.String False 150 A reference to specify the booking. Example: BH100.
FlightNumberPickUp Edm.String False 50 Links the pick up to a flight. The flight number pick up.
FlightDateTimePickUp Edm.DateTime False Time of the flight of the pick up. Time of the flight.
FlightNumberDropOff Edm.String False 50 Links the drop off to a flight. The flight number drop off.
FlightDateTimeDropOff Edm.DateTime False Time of the flight of the drop off. Time of the flight.
FlightDestinationPickUp Edm.String False 150 Destination of the flight of the pick up. Destination of the flight.
FlightDestinationDropOff Edm.String False 150 Destination of the flight of the drop off. Destination of the flight.
FlightIntercontinentalPickUp Edm.Boolean False Indicates if the flight of the pick up is an intercontinental flight. True or False
FlightIntercontinentalDropOff Edm.Boolean False Indicates if the flight of the drop off is an intercontinental flight. True or False
PaymentTypeName PaymentType False 50 The payment type of the booking. See CCPEntities.PaymentType Can be any of the following: Unknown, Cash, Bill, Creditcard, ChipKnip, OvChipCard, Pin
DayCode Edm.String False A reference for the booking. Gets set automaticly by CCP.
The prefix can be set by specifing it in CCPEntities.ContractorTransporter.
Starts per day and per Contractor, Transporter or Network at 1.
ReferencedBookingId Edm.Int32 False The id of the booking that this booking refers to. This is usaly used in combination with BookingScope. The referenced booking id.
PlannedDistance Edm.Double False The planned distance between the pick up and drop off. Can be in kilometers of miles.
PlannedDuration Edm.Int32 False The planned duration between the pick up and drop off. Total seconds.
VehicleKindName* VehicleKind False 50 The VehicleKind. Can be Taxi or Van.
TravelerId Edm.Int32 False
ContractorId Edm.Int32 False
AgentId Edm.Int32 False
TransporterId* Edm.Int32 False
AssignedTransporterId Edm.Int32 False
PickUpLocationId Edm.Int32 False
DropOffLocationId Edm.Int32 False
SetId 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.
Properties marked with a * are required

Navigation Properties

Name Type Multiplicity Summary
Transporter Transporter 0..1
Agent Agent 0..1
Amounts Amount 0..1
AssignedTransporter Transporter *
Contractor Contractor *
DropOffLocation Location * Reference to the drop off location.
Indications Indication 0..1 Gets or sets the indications.
PickUpLocation Location * Reference to the pick up location.
ReferencedBooking Booking * The booking that this booking refers to. This is usaly used in combination with BookingScope.
ReferencedByBookings Booking * The Bookings that refer to this booking. This is usaly used in combination with BookingScope.
Traveler Traveler *
Travelers Traveler * A collection of the travelers that will travel with the booking.
Trips Trip 0..1
TripsSummary TripSummary 0..1

Additional Information

Notable information when adding a record
Checks if the user has sufficient rights to add/change/delete a booking and performs the desired operation
Referenced by Function imports:
Booking.Accept
Booking.Reject

Example

https://ccp.dispatchconnect.nl/CCPService/DataServiceCCP.svc/Bookings