Introduction

This Web API is can be used to access data (resources) from one or more paratransit applications such as PASS, MT, or NOVUS using HTTP GET, PUT, POST or DELETE calls. Include a "Tenant" HTTP header in the request to specify which tenant to access resources for.

Authentication

Most calls require the caller to be authenticated with a token. The token can be generated by submitting valid credentials through a POST request to https://testondemandapi.lethbridge.ca/token. You must specify the tenant that you are accessing by including the Tenant header.

POST https://testondemandapi.lethbridge.ca/token
Content-Type: application/x-www-form-urlencoded
Tenant: tenantName

grant_type=password&username=clientId&password=clientPassword&credentials_type=client&ssoClientId=ssoClientId

The form submitted in the POST request contains the authentication details of the user who is logging in. A number of different users are supported by the system, which must be indicated through the credentials_type field of the form. The following table contains the details of the supported types. Please also note the the ssoClientId field is optional, and only needs to be included for the ClientSso credential type.

Credentials Type	Username	Password
Client	The ID of the client from the PASS/NOVUS database.	The client's password. Depending on the ClientPasswordSource setting for the tenant, this may either correspond to the client's IVR password or their Web password from PASS/NOVUS.
ClientCode	The Client Code from PASS/NOVUS that can be used to identify the client.	The client's password. Depending on the ClientPasswordSource setting for the tenant, this may either correspond to the client's IVR password or their Web password from PASS/NOVUS.
User	The username of a user who can log in to PASS/NOVUS.	The password of the user.
Delegate	The username of the delegate user who may manage trips on behalf of one or more clients. Delegate accounts are created and managed through the API.	The password of the delegate user.
Application	The ID of the application that has been configured for access to the API.	The API Key for the application.
ClientSso	The ID of the application that has been configured for access to the API. The clientID mapped from the SSO provider must also be provided via the optional ssoClientId field.	The API Key for the application.

If you are successfully authenticated, you will receive a 200 response with the following JSON content. Note that the token included here is shortened for illustrative purposes.

{
    "access_token":"gidROdn8NOgBdUy1lmyUqVqxXIxoDf2dAMd2N",
    "token_type":"bearer",
    "expires_in":1209599,
    "userName":"clientId",
    "userId":"clientId",
    "userType":"Client",
    ".issued":"Mon, 23 Dec 2024 08:12:19 GMT",
    ".expires":"Mon, 06 Jan 2025 08:12:18 GMT"
}

The token is only valid for the time specified in the response. You must include the token in an Authorization header for all future requests that require authentication.

GET https://testondemandapi.lethbridge.ca/api/clients/35
Tenant: tenantName
Authorization: bearer gidROdn8NOgBdUy1lmyUqVqxXIxoDf2dAMd2N

Resources

AddressTypes

This controller provides access the different types of addresses in the system.

API	Description
GET api/AddressTypes	Gets the codes and names of each available address type in the system.

Agency

Controller for Agencies

API	Description
GET api/agencies?agencyIds[0]={agencyIds[0]}&agencyIds[1]={agencyIds[1]}	Gets all the available agencies for the current tenant. Results will be filtered based on provided agency Ids.

BookingPurposes

This controller provides access the different types of Booking Purposes that a client may choose from when booking their trip.

API	Description
GET api/BookingPurposes?serviceTypeId={serviceTypeId}	Gets the list of different predefined reasons that a client may be booking a trip for.

BookingSubtypes

This controller provides access the different types of Booking Subtypes that are available in the system.

API	Description
GET api/BookingSubtypes	Gets the list of different possible booking subtypes.

CancelCode

This controller provides access the different types of cancellation codes (system codes as well as user defined codes) in the system.

API	Description
GET api/cancelcodes	Gets the available system and user defined cancellation codes.

ClientDefaults

This controller is used to get the default additional passengers and mobility aids for a client.

API	Description
GET api/clients/{clientID}/defaultPassengers	Gets the list of the client's default passengers when booking a new trip.
GET api/clients/{clientID}/defaultMobilityAids	Gets the list of the default mobility aids that a client will bring with them on their trip.
GET api/clients/{clientID}/defaultAncillary	Gets the list of the default fare, space, and passenger types for a client.

Clients

This controller provides access to get, modify or delete a client from the system.

API	Description
GET api/clients/{clientID}/statuses	Gets information about the client's eligibilty status.
POST api/clients/{clientID}/ChangePassword	Changes a client's password. Requires the client's current password.
POST api/clients/{clientId}/AnonymousChangePassword	Changes a user's password without requiring their old password, or requiring them to be logged in.
GET api/clients/{clientId}/attachments?fileIds[0]={fileIds[0]}&fileIds[1]={fileIds[1]}&includeContent={includeContent}	Gets attachments for client
GET api/clients/{clientId}/contacts?filterCallerType={filterCallerType}	Gets the contacts for a client. This includes contacts that don't have an address
GET api/clients/{clientId}/contacts/preferred?useFallbackContact={useFallbackContact}	Gets the details of a client's preferred contact.
PUT api/clients/{clientId}/contacts/preferred	Updates the preferred contact details for a client.
GET api/clients/{clientId}/passengertypes	Gets the list of different types of passengers that may be part of the client's trips. However, this list will account for any passenger types that the client has been denied from bringing. Clients are always denied from bringing other clients.
GET api/clients/{clientId}/servicetypes?includeAllAvailable={includeAllAvailable}	Gets the list of different service types that a client can select for their trips.
GET api/clients/{clientId}/passengertype	Gets the client's passenger type code.
DELETE api/clients/{clientId}/servicetype/{serviceTypeId}	Removes a service type from a client
PUT api/clients/{clientId}/servicetype/{serviceTypeId}	Adds or updates a service type on a client
POST api/clientSearch	Searches for a client using multiple pieces of information.
POST api/clientsSearch?maxResults={maxResults}	Searches for clients that exactly match search criteria.
GET api/clients/{clientId}/serviceTypesLimits	Gets the list of service limits for the client.
GET api/clients/latestfeedbackmodifieddate?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}	Gets the most recent feedback modified date againt provided clientId(s)
GET api/clients/{clientId}/fundingPrograms?tripDate={tripDate}	Gets funding programs for client
PUT api/clients/{clientId}/address	Creates or updates an address for a client.
DELETE api/clients/{clientId}/address/delete/{addressTypeCode}	Deletes an address for a client.
GET api/clients/bulk?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&clientCodes[0]={clientCodes[0]}&clientCodes[1]={clientCodes[1]}	Gets basic information about a collection of clients in bulk by querying the parastransit database directly. DEPRECATED This call has been deprecated. Please use the bulk client POST request instead.
POST api/clients/bulk	Gets basic information about a collection of clients in bulk by querying the parastransit database directly.
POST api/clients/{clientId}/contact	Creates a contact for a client.
DELETE api/clients/{clientId}/contact/{contactId}	Deletes a client's contact.
PUT api/clients/{clientId}/contact	Updates an existing client contact.
GET api/Clients?firstName={firstName}&lastName={lastName}&clientCode={clientCode}&clientId={clientId}&identificationNumber={identificationNumber}&birthDate={birthDate}&offset={offset}&count={count}&phoneNumber={phoneNumber}&bookingId={bookingId}	Retrieves the details about clients in the system that match the specified search parameters.
GET api/Clients/{id}	Retrieves the details of a single client.
PUT api/Clients/{id}	Saves the details of an existing client. Note that the client's status information and funding sources cannot currently be saved.
DELETE api/Clients/{id}?softDelete={softDelete}	Deletes the client.
POST api/Clients	Creates a new client with the given arguments required in .

ContactTypes

Gets the list of contact types.

API	Description
GET api/contacttypes	Gets the list of all available contact types in the paratransit application.
GET api/clientcontacttypes	Gets the list of all available client contact types in the paratransit application. Refers to contact types in Para Transit Application.

DelegateClients

API	Description
GET api/delegategroups/{delegateGroupId}/clients?includeExpired={includeExpired}&offset={offset}&count={count}&searchTerm={searchTerm}&searchColumns[0]={searchColumns[0]}&searchColumns[1]={searchColumns[1]}&userDefinedFields[0]={userDefinedFields[0]}&userDefinedFields[1]={userDefinedFields[1]}	Gets the clients that are associated with a delegate group.
GET api/delegategroups/{delegateGroupId}/clientsgroup?includeExpired={includeExpired}&offset={offset}&count={count}&searchTerm={searchTerm}&searchColumns[0]={searchColumns[0]}&searchColumns[1]={searchColumns[1]}&userDefinedFields[0]={userDefinedFields[0]}&userDefinedFields[1]={userDefinedFields[1]}	Gets the delegate client group information
GET api/delegategroups/{delegateGroupId}/clients/count?includeExpired={includeExpired}&searchTerm={searchTerm}	Gets the clients that are associated with a delegate group.
DELETE api/delegategroups/{delegateGroupId}/clients/{clientId}	Removes a client from a delegate group.
POST api/delegategroups/{delegateGroupId}/clients	Adds a client to a delegate group, or updates an existing association with a new expiry date.
POST api/delegategroups/{delegateGroupId}/clientrule	Adds or updates a ruleset for a delegate group which defines which clients are dynamically added to the group
GET api/delegategroups/{delegateGroupId}/clients/{clientId}	No documentation available.
GET api/delegategroups/{delegateGroupId}/clientrule	Gets the set of rules that define which clients are dynamically added to a delegate group
DELETE api/delegategroups/{delegateGroupId}/clientrule	Deletes a dynamic client ruleset for a delegate group.
GET api/delegategroups/{delegateGroupId}/dynamicclients?offset={offset}&count={count}&searchTerm={searchTerm}	Gets the clients that are dynamically associated with a delegate group via a
POST api/dynamicclients/preview?offset={offset}&count={count}&searchTerm={searchTerm}	Gets the clients that match the conditions of a given ruleset that has not been persisted to the database.
POST api/dynamicclients/preview/count?searchTerm={searchTerm}	Gets the clients that match the conditions of a given ruleset that has not been persisted to the database.
GET api/DynamicClientFilterTypes	Gets a list of the supported DynamicClientFilters used for setting up dynamic client rules for delegate groups

DelegateGroups

This controller provides access to get, modify or delete a delegate group from the system.

API	Description
GET api/delegategroups/{id}?includeDeleted={includeDeleted}&includeClientCount={includeClientCount}	Gets a delegate group by id.
DELETE api/delegategroups/{id}	Deletes a delegate group.
PUT api/delegategroups/{id}	Updates the values of a delegate group.
GET api/delegategroups/search?query={query}&groupType={groupType}&includeMatchedObjects={includeMatchedObjects}	Searches through delegate groups for a name, client or delegate that matches the specified search string. If a group type is provided, then only delegate groups matching the filter criteria will be included.
GET api/DelegateGroups?groupType={groupType}	Gets all delegate groups. If a group type is provided, then only delegate groups matching the filter criteria will be included.
POST api/DelegateGroups	Saves a new delegate group.

Delegates

This controller provides access to get, modify or delete a delegate from the system. Also allows delegates to change their passwords.

API	Description
POST api/delegates/{delegateId}/ChangePassword	Changes a delegate user's password. Requires the user's current password.
POST api/delegates/{delegateId}/AnonymousChangePassword	Changes a delegate user's password without requiring their old password, or requiring them to be logged in.
GET api/delegates/{delegateId}?includeDeleted={includeDeleted}	Gets a delegate by id.
GET api/delegates/find?username={username}	Finds a delegate using their username.
GET api/delegategroups/{delegateGroupId}/delegates	Gets all delegates in a delegate group by id.
GET api/delegategroups/{delegateGroupId}/delegates/{offset}?count={count}&searchTerm={searchTerm}	Gets a paginated list of all delegates in a delegate group by id.
DELETE api/delegates/{delegateId}	Deletes a delegate by id.
PUT api/delegates/{delegateId}	Updates a delegate.
POST api/delegates	Creates a new delegate.

DelegateSecurity

API	Description
GET api/delegates/{delegateId}/security	Gets the final resolved security settings for a delegate, combining the delegate's individual and group security settings (if the delegate inherits from the group)

Diagnostics

Provides access to the logs files generated by log4net.

API	Description
GET api/Diagnostics/logs/{fileCount}	No documentation available.

Echo

Allows a client to ping the server and verify that it is still authorized correctly. Returns the original posted content.

API	Description
POST api/Echo	Allows a client to ping the server and verify that it is still authorized correctly.

FareTypes

Provides access to the different fare types that are available in the system.

API	Description
GET api/FareTypes	Gets the list of the different available fare types.

Features

Gets which features the paratransit app supports

API	Description
GET api/Features	Gets which features are available

Feedback

API	Description
GET api/feedbacktypes	Returns feedback types from server
GET api/feedback/{feedbackTypeId}/categories	Returns feedback categories from server against provided feedback type Id
GET api/feedback/{referenceNo}/history	Return feedback history against provided reference no.
POST api/feedback/{referenceNo}/attachments	Saves attachment against reference no provided in attachment request
GET api/feedback/{clientId}?startDate={startDate}&endDate={endDate}	Returns feedback list against provided client id
GET api/feedback/{referenceNo}/attachments?fileIds[0]={fileIds[0]}&fileIds[1]={fileIds[1]}&includeContent={includeContent}	Gets attachments for feedback
DELETE api/feedback/{referenceNo}/attachments?fileIds[0]={fileIds[0]}&fileIds[1]={fileIds[1]}	Removes attachment for client
POST api/Feedback	Returns saved feedback object with mandatory filled in details from server

Funding

Controller for FundingPrograms and FundingSources

API	Description
GET api/fundingprograms	Gets all the available funding programs that are accessible for the current tenant.
GET api/fundingprograms/{programId}	Gets a funding program by id.
GET api/fundingsources	Gets all the available funding sources for the current tenant.
GET api/fundingsources/{fundingSourceId}	Gets a funding source by id.

Genders

Provides access to the list of genders.

API	Description
GET api/Genders	Gets the list of genders.

History

Gets audit history information

API	Description
GET api/history?bookingId={bookingId}&clientId={clientId}&delegateId={delegateId}&delegateGroupId={delegateGroupId}&tenantId={tenantId}&action[0]={action[0]}&action[1]={action[1]}	Gets audit history entries

IVRContactInfo

API	Description
GET api/IVRContactInfo?clientId={clientId}	Gets the contact information for each device type for a client.

IVRStatus

Determines the current status of the IVR system.

API	Description
GET api/IVRStatus	Gets the current status and configuration of the IVR system.

Locations

Gets information about registered locations in the system.

API	Description
GET api/Locations/SuggestLocation?search={search}&maxLocations={maxLocations}&groupResultsByCategory={groupResultsByCategory}&excludeNonGeocoded={excludeNonGeocoded}	Searches through the list of locations that have been registered with the system for a location that best matches a search string.
GET api/Locations/SuggestClient?clientId={clientId}&search={search}&maxRecent={maxRecent}&maxRegistered={maxRegistered}&excludeNonGeocoded={excludeNonGeocoded}	Searches through a client's frequent and registered addresses to provide a location that best matches a search string.
GET api/Locations/SuggestStop?search={search}&maxStops={maxStops}&excludeNonGeocoded={excludeNonGeocoded}	Searches through the list of locations that have been registered with the system for a location that best matches a search string.
GET api/Locations/Suggest?search={search}&clientId={clientId}&includeRegistered={includeRegistered}&includeLocations={includeLocations}&includeStops={includeStops}&includeAddresses={includeAddresses}&maxRecent={maxRecent}&maxRegistered={maxRegistered}&maxLocations={maxLocations}&maxStops={maxStops}&groupLocationsByCategory={groupLocationsByCategory}&excludeNonGeocoded={excludeNonGeocoded}	Suggests locations, including both standard locations and client-specific locations.
GET api/Locations/FindLocation?streetNumber={streetNumber}&onStreet={onStreet}&unit={unit}&zip={zip}&city={city}&siteName={siteName}	No documentation available.
POST api/Locations	Adds a new location
PUT api/Locations/{locationId}	Adds a new location
GET api/Locations?categories[0]={categories[0]}&categories[1]={categories[1]}	Gets locations
GET api/Locations/{locationId}	Gets a location by ID
GET api/Locations/Stops?polygonId={polygonId}&stopNameFilter={stopNameFilter}	Gets bus stops
POST api/Locations/TimeZone	Gets a location time zone info.
GET api/Locations/BaseTimeZone	Gets the para transit base time zone info.
GET api/Locations/PMCode?placeType={placeType}&locationId={locationId}&locationItemType={locationItemType}	Gets a location's procedure modifier code.

LocationTypes

Gets the list of location types.

API	Description
GET api/LocationTypes	Gets the list of all available location types in the paratransit application.

MobilityAids

This controller provides access the different types of Mobility Aids that can be assigned to a client.

API	Description
GET api/MobilityAids	Gets the list of mobility aids that a client can bring on a trip.

NoShowCodes

This controller provides access the different types of no show codes (system codes as well as user defined codes) in the system.

API	Description
GET api/noshowcodes	Gets the available system and user defined no show codes.

NotificationTypes

Provides information about the available notification types in the connected IVR system.

API	Description
GET api/NotificationTypes	Gets the list of Notfication Types that are available in the IVR System, if configured.

Operations

Controller for managing operations in current version of DR WEB API

API	Description
GET api/Operations?controller={controller}	Gets a list of available operations along with the product version

ParaAppSettings

API	Description
GET api/ParaAppSettings	Gets all the readonly settings for the current Tenant.

PassengerTypes

This controller provides access the different types of passengers that can be brought in a trip.

API	Description
GET api/passengertypes	Gets the list of different types of passengers in the system, including the client passenger type.
GET api/PassengerTypes/PassengerTypesForServiceType?serviceTypeId={serviceTypeId}	Gets the list of passenger types configured against service type

Password

Provides methods for password validation.

API	Description
POST api/password/ValidatePasswordRules	Validates a password with the password rules
POST api/password/CheckPasswordExpiry	Checks to see if a password for a given user has expired. Note that this method assumes the password passed into the request has been authenticated successfully.

Polygons

This controller provides Polygon Types and Polygons for Map rendering

API	Description
GET api/polygontypes?includePolygonIds={includePolygonIds}	Fetches Polygon Types from Database
GET api/polygons?typeId={typeId}&polyIds[0]={polyIds[0]}&polyIds[1]={polyIds[1]}&includeVertexInfo={includeVertexInfo}	Fetches Polygon data against provided polygonTypeId
GET api/polygonsByStop?stopId={stopId}&typeId={typeId}&includeVertexInfo={includeVertexInfo}	Fetches all the polygons of a given type that a stop is contained in

PrePaidFaring

This controller provides access pre-paid faring related calls

API	Description
GET api/clients/{clientId}/Faring/AccountInfo	Gets client's pre-paid fare information.
GET api/clients/{clientId}/Faring/TransactionHistory?startDate={startDate}&endDate={endDate}&transactionType={transactionType}	Gets client's account transaction history.
POST api/clients/{clientId}/Faring/TopUp	Adds funds to a client's account
POST api/clients/{clientId}/Faring/Adjustment	Adjusts a client's account balance

Provider

Controller for Providers

API	Description
GET api/providers	Gets all the available providers for the current tenant.

Registration

Gets which registration fields are required for this paratransit app

API	Description
GET api/Registration/requiredFields	Gets which user registration fields are required

Run

Responsible for finding scheduling solutions for trips, applying them, and dropping unused solutions.

API	Description
GET api/runs?startDate={startDate}&endDate={endDate}&serviceTypeId[0]={serviceTypeId[0]}&serviceTypeId[1]={serviceTypeId[1]}	Gets runs
GET api/runs?date={date}&serviceTypeId[0]={serviceTypeId[0]}&serviceTypeId[1]={serviceTypeId[1]}	Gets runs

ScheduleTrips

Responsible for finding scheduling solutions for trips, applying them, and dropping unused solutions.

API	Description
POST api/clients/{clientId}/solutionsets?searchWindow={searchWindow}&overrideClientTripLimits={overrideClientTripLimits}	Tries to find solutions for scheduling one or more trips.
POST api/schedules/{scheduleId}/tripsolutions?failOnWarnings={failOnWarnings}	Schedules one or more trips using a scheduling solution that was previously found.
DELETE api/clients/{clientId}/solutionsets/{solutionSetId}?scheduleId={scheduleId}	Removes one or more previously found solution sets for scheduling an itinerary or trip.

Security

Controller for security information (users, groups)

API	Description
GET api/security/groups	Gets the security groups for the paratransit application
GET api/security/users	Gets the users for the paratransit application
GET api/security/users/{username}/groups	Gets the groups that a user is a member of
GET api/security/users/groups	Gets the security groups that the current logged in user is a member of.
GET api/security/user/identity?username={username}	Gets user's identity info based on the user name.

ServiceTypes

Provides access to the different service types that are available in the system.

API	Description
GET api/ServiceTypes?includeHidden={includeHidden}	Gets the list of different service types that are available.

Settings

API	Description
POST api/tenants/{tenantId}/settings	Updates tenant settings.
GET api/tenants/{tenantId}/settings	Gets the list of different possible booking subtypes.
GET api/tenants/{tenantId}/settingsjs	Gets the list of different possible booking subtypes.

SpaceTypes

Provides access to the different space types that are available in the system.

API	Description
GET api/SpaceTypes	Gets the list of different type of space requirements that a client may reserve for their trip.

SystemStatus

API	Description
POST api/SystemStatus	No documentation available.

TenantDefaults

Gets default configurations for the tenant (usually values configured in PASS/Novus)

API	Description
GET api/defaultEscort	Gets the tenant-wide default escort config

TenantHosts

Used to map host headers with a respective tenant. This is used for multi-tenant applications to determine which tenant their site is currently being accessed for.

API	Description
GET api/TenantHosts	Gets the list of all configured host headers for each tenant that is in the system.

TenantInfo

Provides basic information about the configuration of a tenant.

API	Description
GET api/tenantinfo	Gets information about the current tenant.
GET api/tenantinfo/utcoffset	Gets the offset from the current time to UTC.

Tenants

Allows tenants to be added, modified, or deleted.

API	Description
GET api/tenants/{id}	Gets information about a tenant with a specific name.
GET api/tenants?name={name}&includeDisabled={includeDisabled}	Gets information about all tenants.
PUT api/tenants/{id}	Saves an existing tenant.
POST api/tenants	Saves a new tenant.
DELETE api/tenants/{id}	Deletes an existing tenant.
GET api/tenants/isDemo?name={name}	Gets whether a tenant is a demo tenant or not.
PUT api/tenants/{id}/status	Update's a tenant's status between enabled/disabled

Titles

Provides access to the list of titles.

API	Description
GET api/Titles	Gets the list of titles.

Trips

Provides the ability to view and book trips for a client, as well as monitoring a vehicle's current location for a trip.

API	Description
GET api/clients/{clientID}/trips?tripIds[0]={tripIds[0]}&tripIds[1]={tripIds[1]}&startDate={startDate}&endDate={endDate}&serviceTypeIds[0]={serviceTypeIds[0]}&serviceTypeIds[1]={serviceTypeIds[1]}&additionalPassengerMode={additionalPassengerMode}	Gets the trips for a client within a specific date range.
GET api/clients/{clientID}/tripsCount?startMonth={startMonth}&monthsCount={monthsCount}	Gets the trips count for a client within the given date range.
GET api/clients/{clientId}/trips/past?date={date}&numTrips={numTrips}&serviceTypeIds[0]={serviceTypeIds[0]}&serviceTypeIds[1]={serviceTypeIds[1]}&additionalPassengerMode={additionalPassengerMode}	Attempts to get a set number of past trips, starting at a given date and working backwards. Will always return all the trips for the dates it returns trips for, so more than the requested number of trips may be returned
GET api/trips/cancelled?startDate={startDate}&endDate={endDate}&serviceTypeIds[0]={serviceTypeIds[0]}&serviceTypeIds[1]={serviceTypeIds[1]}	Gets trips that have been cancelled
POST api/trips/search	Searches for a trip using multiple pieces of information.
GET api/clients/{clientID}/subscription?startDate={startDate}&endDate={endDate}&additionalPassengerMode={additionalPassengerMode}	Gets the recurring trips for a client within a specific date range.
GET api/clients/{clientId}/trip/{tripId}?additionalPassengerMode={additionalPassengerMode}	Gets information about a booked trip.
POST api/trips/fundingprograms	Get funding programs available for booking based on Itinerary data.
PUT api/clients/{clientID}/edittrip?failOnWarnings={failOnWarnings}&additionalPassengerMode={additionalPassengerMode}	Edits trip(s) for a client.
PUT api/clients/{clientID}/editsubscription?failOnWarnings={failOnWarnings}&additionalPassengerMode={additionalPassengerMode}	Books a recurring trip for a client.
POST api/clients/{clientID}/trip?failOnWarnings={failOnWarnings}&additionalPassengerMode={additionalPassengerMode}&setRequestedLateDropoffFromOBT={setRequestedLateDropoffFromOBT}&forceAllowImmediateBooking={forceAllowImmediateBooking}&overrideClientTripLimits={overrideClientTripLimits}&doDropOffTimeAdjustment={doDropOffTimeAdjustment}	Books a trip for a client.
POST api/clients/{clientId}/subscription?failOnWarnings={failOnWarnings}&doDropOffTimeAdjustment={doDropOffTimeAdjustment}&additionalPassengerMode={additionalPassengerMode}	Books a recurring trip for a client.
GET api/clients/{clientId}/trips/daterange	Returns the date of the first and last trips that the client has in the system.
GET api/clients/{clientID}/recenttrips?bookingsCount={bookingsCount}&additionalPassengerMode={additionalPassengerMode}	Gets the list of trips that a client has recently created or completed.
GET api/clients/{clientID}/upcomingtrips?maxResults={maxResults}&includePastMinutes={includePastMinutes}&scheduleStatuses[0]={scheduleStatuses[0]}&scheduleStatuses[1]={scheduleStatuses[1]}&bookingSubtypes[0]={bookingSubtypes[0]}&bookingSubtypes[1]={bookingSubtypes[1]}&additionalPassengerMode={additionalPassengerMode}	Gets the list of upcoming trips for a client.
GET api/clients/{clientId}/trips/{bookingId}/vehicleInfo	Gets location information about a vehicle that has been assigned to handle a trip.
PATCH api/clients/{clientId}/trips/{bookingId}	Updates an existing trip.
PUT api/clients/{clientId}/trips/{bookingId}/subtype	Updates the booking subtype of an existing trip.
POST api/clients/{clientId}/trips/fareEstimate	Calculate the fare for a client's trip.
DELETE api/clients/{clientId}/trips/{bookingId}/droptrip?isNew={isNew}	Removes trip from system
POST api/clients/{clientId}/trips/unschedule	Unshedules provided bookingIds against client
POST api/trips/{bookingId}/note	Creates a new booking note.
GET api/trips/{bookingId}/note	Gets notes associated with a booking.
DELETE api/trips/note/{noteId}	Deletes a note associated to a booking.
PUT api/trips/note/{noteId}	Updates an existing note in the database.
GET api/clients/{clientId}/trips/notifications?tripIds[0]={tripIds[0]}&tripIds[1]={tripIds[1]}	Gets notification about booked trips belonging to a client.

TripStatus

Gets or updates a trip's current status.

API	Description
GET api/clients/{clientID}/trips/{bookingId}/status	Gets the current status of a trip.
GET api/trips/status?startDate={startDate}&endDate={endDate}&serviceTypeId[0]={serviceTypeId[0]}&serviceTypeId[1]={serviceTypeId[1]}	No documentation available.
PUT api/clients/{clientId}/trips/{bookingId}/status	Updates the current status of the trip.

UnregisteredClient

This controller provides access to create unregistered clients.

API	Description
POST api/UnregisteredClient	Creates a new unregistered client with the specified name.

UserDefinedFields

This controller provides information about the user defined fields that are in the system.

API	Description
GET api/UserDefinedFields/{table}	Gets the list of all user defined fields that have been defined for a specific type of object.