Booking

Name: Booking

Type: Application

Modules: Booking, Scheduling, Faring, Reporting

Description: Contains the top level description of all individual passenger trips. Includes cross-referencing for specific details.

Field Documentation
BookingId Numeric identifier of each booking created.
SubscriptionId Numeric identifier of each Subscription booking created.
LDate Booking date as an integer in YYYYMMDD format.
WeekDay Numeric value from 1-7 indicating what day of the week a booking is for.
SchTypeId Numeric identifier of the booking Schedule Type (Live or Template) (from the ScheduleType table).
SchId Numeric identifier of the schedule date of the booking (from the Schedules table).
ClientId Numeric identifier of the client (from the Clients table).
FromDate Date from which subscription bookings can be activated.
ToDate Date after which subscription bookings cannot be activated.
WeekTemplate 7-digit flag for the days of the week a booking is for (e.g., a value of 0011010 indicates trips on Monday, Tuesday, and Thursday).
SuspFromDate Start date from which the client has been suspended. Bookings cannot be activated until after the SuspToDate.
SuspToDate End date after which the client is no longer suspended. Bookings cannot be activated for this client until after this date.
Comments Comments about the record.
BookingType Hard-coded value for the booking type (S = Subscription, A = Activated, C = Casual).
FundingSourceId Deprecated. (Numeric identifier of the funding source for the booking.)
FareTypeId Numeric identifier of the fare type for the booking (from the FareType table).
FareAmount Dollar value of the fare amount for the booking.
ProviderId Numeric identifier of the provider for the booking (from the Providers table).
PurposeId Numeric identifier of the purpose for the booking (from the Purpose table).
CreBy Name of the entity that created the booking (either the username or the application).
CreTime Time when the booking was created. Value is in seconds from midnight.
CreDate Date when the booking was created.
ModBy User who last modified the booking (either the username or the application).
ModTime Time when the booking was last modified. Value is in seconds from midnight.
ModDate Date when the booking was last modified.
SchedStatus Hard-coded, numeric identifier of the status of the booking at CreTime or ModTime (e.g., Scheduled, Canceled).
TimeSort ReqTime value used by the Schedule Server to order the times of trips when scheduling.
GeoStatus Numeric value of the status of the geocoding for the longitude and latitude coordinates of the booking.
MobAids List of mobility aids needed for the booking.
DirectDistance Direct distance in meters for the booking from its pick-up location to its drop-off location.
SubtypeAbbr Abbreviation of the subtype for the booking (from the BookingSubTypes table).
FundingSourceId1 Numeric identifier of the first funding source for the booking.
FundingSourceId2 Numeric identifier of the second funding source for the booking.
FundingSourceId3 Numeric identifier of the third funding source for the booking.
CoDriver Scheduling flag that indicates whether the booking requires a Co-Driver.
GroupCode Group code that a booking belongs to.
Priority Number that assigns order and importance to a booking during batch scheduling.
ParaServiceId Numeric identifier of the paraservice of the booking (from the ParaService table).
ExclusiveGroup Flag that indicates whether the booking belongs to a group that will not accept additional riders.
MaxOBT Maximum allowable On Board Time (time that a client can be on the vehicle during the trip). Value is in seconds from midnight.
Excuse Indicates whether the trip has been excused (e.g., the bus was late and the client complained so the trip was free of charge).
FareDeducted Dollar amount deducted from the client's account balance for the booking.
FareToCollect Dollar amount to be collected from the rider when he or she boards the vehicle.
FareCollected Dollar amount collected from the rider when he or she boarded the vehicle.
UserDouble1 Client supplementary data.
UserDouble2 Client supplementary data.
UserLong1 Client supplementary data.
UserLong2 Client supplementary data.
UserLong3 Client supplementary data.
UserLong4 Client supplementary data.
UserLong5 Client supplementary data.
UserString1 Client supplementary data.
UserString2 Client supplementary data.
UserString3 Client supplementary data.
UserString4 Client supplementary data.
UserString5 Client supplementary data.
ProviderCost Dollar amount charged to the provider for the trip.
CallClient Flag that indicates whether the client will receive an IVR call for this booking.
Bed Flag that indicates that the client will be picked up for the trip from his or her bed.
Curb Flag that indicates that the client will be picked up for the trip at the curb.
Door Flag that indicates that the client will be picked up for the trip at the door.
FundingSourceId4 Numeric identifier of the fourth funding source for the booking.
FundingSourceId5 Numeric identifier of the fifth funding source for the booking.
NoShowNumber Number of times the client has not shown up for pick-ups.
SentProviderDate Date that the trip provider was notified of the trip booking.
SentProviderStatus Deprecated.
SentProviderTime Deprecated.
AmountAdjusted Flag that indicates that the fare for the trip was adjusted.
WaitOnTransfer Flag that indicates that the client for this booking will transfer vehicles somewhere during the trip.
SmartCardId Numeric identifier of the smart card the client is using to pay for the booking.
UseSmartCard Flag that indicates whether the client will be using a smart card for the trip.
GroupKey Numeric identifier of the group booking (from the GroupBooking table).
ApplyDOLogic Flag that indicates whether the booking will use drop-off logic to calculate pick-up and drop-off times.
BookingStatus Current status identifier of the booking (e.g., Scheduled, Activated, Completed).
ModeOfTransport Numeric value for the transportation method used for the trip (e.g., Taxi, Bus) (from the VehicleTypes table).
MaxTransfer Maximum number of transfers that the client can make to complete the scheduled trip.
DirectDistanceLimit Maximum number of meters bookings can have between pick-up and drop-off locations.
ClientEligCondId Numeric identifier of the client eligibility conditions associated with the booking.
SchedulePeriodId Numeric identifier of the schedule period for the booking (from the SchedulePeriod table).
IsLocked If true, the booking cannot be rescheduled or moved to another run.
IVRCallBackDate Date when the client should be called to remind him or her of the scheduled trip.
IVRCallBackTime Time when the client should be called to remind him or her of the scheduled trip. Value is in seconds from midnight.
IVRCallBackClient Flag that indicates the client should be called through the IVR system.
IVRSendReminderSameDay Flag that indicates the client should be called through the IVR system on the day of the scheduled trip.
IVRSendReminderPreviousDay Flag that indicates the client should be called through the IVR system the day before the scheduled trip.
IVRAlternateCallbackPhone Phone number used to call the client for IVR notifications.
IVRCallBackStatus Status of the IVR call made to the client (e.g., Unsent, Sent).
IVRCallBackETime Time the IVR call was made. Value is in seconds from midnight.
Suppressed If true, additional bookings cannot be created from this booking.
AuthorizationNo Authorization number provided for the scheduled trip.
MaxWalkingDistance Maximum distance in meters that a client can walk between the pick-up and drop-off locations.
DeviceAbbr Abbreviation of the IVR device used for calling clients to notify them about the trip (from the DeviceTypes table).
CCSecGroup Call center security group associated with the booking.
TransferModeSummary String of events listing the pick-up, transfers, and drop-offs of the trip.
WorkerId Numeric identifier of the certification case worker.
ServiceParameterId Numeric identifier of the service parameters (from the ServiceParameters table).
ServiceAreaRuleId Numeric identifier of the service area rule (from the ParaService table).
ContactInfoId Numeric identifier of the contact information for the client (from the ContactInfo table).
BookingTagId Numeric identifier of the booking tag (from the BookingTag table).
NegCount Number of times the booking was negotiated with the client.
ItineraryId Numeric identifier of the itinerary that the booking may belong to.
VehicleTypeExclusions List of vehicle types that the booking cannot be scheduled to (from the VehicleTypes table).
MinStay Minimum length of time in seconds that the client wishes to stay at the drop-off location.
MaxStay Maximum length of time in seconds that the client wishes to stay at the drop-off location.
NotificationId Numeric identifier of the client notification via IVR, phone, or text message to the client about the trip (from the NotifiForPASS table).
BookingNum Sequence number of where the booking falls in a multi-legged itinerary.
CancelRefCode Code that identifies the reason for the canceled trip (e.g., NoShow, Missed Trip) (from the CancelCodes table).
MedicaidAuthNumber Field used in the PASSBilling application that contains the Medicaid Authorization Number used to bill for the trip.
MedicaidEligDate PASSBilling field that contains the date from when Medicaid Authorization Number is valid.
MedicaidNursingHome PASSBilling field that contains the Medicaid ID number of the nursing home to which the client belongs.
MedicaidNursingHomeFlag PASSBilling field that indicates whether the home address of the client is a nursing home.
MedicaidOver21Flag PASSBilling field that indicates whether the client is over 21 years of age.
MedicaidProgramCode PASSBilling field that contains the Medicaid program code used for the trip.
MedicaidProviderNumber PASSBilling field that contains the ID of the Medicaid provider used for the trip.
PlanProvider PASSBilling field that contains the health care plan provider ID of the client.
HMO PASSBilling field that contains the Healthcare Management Organization ID for the client.
ClientTypeCode Client type code of the trip (from the ClientType table).
GroupCommonLeg Group booking leg that contains the common address (1 = Pickup, 2 = DropOff, 3 = Both).
IVRSendUpdateSameDay Flag that indicates whether the client should be called on the day of the trip with updates.
OrderNo Internal use only.
FareCalcMethod Numeric identifier of the method used to calculate the fare amount (e.g., Third Party, Calculated by Distance, Manually-Entered).
EntitlementID Numeric identifier (from the Entitlements table).
NegotiatedFare Flag that indicates whether the fare for the trip was negotiated or adjusted from the original fare.
AccessibilityMask AccessibilityMask ID (from the AccessibilityTypes table).
FeedbackId Numeric identifier of the complaint, suggestion, or comment (from the Complaints module).
MeterCollected Currency amount collected from the client when he or she boarded the vehicle.
PaymentTypeId Numeric identifier of the payment type for the booking (from the PaymentTypes table).
SignatureFile Name of the file that contains a copy of the client signature for verification of the booking.
TrackerUserComment Flag that indicates whether there is a Tracker User comment attached to the booking.
IsPending Flag that indicates whether the trip will be activated by during the batching process by the Schedule Server. Used for subscription bookings.
EndDate Date a subscription booking will end.
TCCFundingAmount Amount funded by a funding provider belonging to Trapeze Community Connect (TCC).
PrepaidReq Flag that indicates whether the client must use prepaid faring.
TransactionId Deprecated.
PaymentAuthorizationNumber Authorization number of the credit card payment transaction.
ClientStatus Client status of the booking (0 = unknown, 1 = ready, 2 = late, 3 = won't show up).
DirectTravelTime Time taken to travel directly from the pick-up location to the drop-off location. Value is in seconds.
UseSearchWindow Flag that indicates whether or not the trip should by default use a search window when being scheduled.
MaxObtDirectTravelTime The amount of time it takes to travel from the pickup leg to the dropoff leg - it is stamped when ScheduleServer is determining this for MaxOBT Calculations.
FaringInterfaceStatus A flag indicating to call FaringInterface.