Boarding Point Details
This method gives the list of boarding and their respective boarding times, landmark, complete address and contact numbers for the specified route. Boarding point is mandatory for all the buses.
Note: Dropping point is mandatory or not will be define by the ‘IsDropPointMandatory’ node of search response. If value of this node is true, then dropping point is mandatory and has to pass in book request.
Service URL (REST) to be used:
Boarding Point Details Request
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | ClientId | String | Unique client identifier assigned to the agency during registration and API onboarding. Used for request authentication and tracking. | Mandatory |
| 2 | UserName | String | Authorized API username issued to the agency for authentication and access to bus booking services. | Mandatory |
| 3 | Password | String | Secure API password associated with the registered username. Required for request validation and authorization | Mandatory |
| 4 | TraceId | String | Unique identifier for identifying every unique search Required for audit purpose from Search Response. | Mandatory |
| 5 | SrdvIndex | String | Unique internal identifier assigned to the bus result by the API. Required for subsequent booking-related operations. | Mandatory |
| 6 | ResultIndex | String | Unique reference identifier for the specific bus search result. Used to identify the selected bus during the booking flow | Mandatory |
Boarding Point Details Response
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | Error{} | Object | Contains error information related to the request processing. This object is returned in both successful and failed responses. | Mandatory |
| 1.1 | ErrorCode | Integer | Numeric error code indicating the status of the request. A value of 0 typically indicates successful processing. | Mandatory |
| 1.2 | ErrorMessage | String | Contains error description corresponding to ErrorCode. Error Message would be blank in case ErrorCode = 0. | Mandatory |
| 2 | TraceId | String | Unique identifier for identifying every unique search Required for audit purpose. | Mandatory |
| 3 | SrdvIndex | Integer | Unique internal identifier assigned to the bus result by the API. Required for subsequent booking-related operations. | Mandatory |
| 4 | ResultIndex | Integer | Unique reference identifier for the specific bus search result. Used to identify the selected bus during the booking flow. | Mandatory |
| 5 | BoardingPoints[] | Array | Collection of available boarding points for the selected bus service. | Mandatory |
| 5.1 | Id | String | Unique identifier of the boarding point. | Mandatory |
| 5.2 | MasterId | String | Reference ID linked with operator’s master boarding data. | Mandatory |
| 5.3 | Name | String | Name of the boarding point (e.g., “A.S Raonagar 2”). | Mandatory |
| 5.4 | Location | String | Local area or neighborhood where the boarding point is located. | Mandatory |
| 5.5 | Address | String | Street or full address for the boarding point. | Mandatory |
| 5.6 | Landmark | String | Nearby landmark to help users find the location easily (e.g., “Bank, Hotel”). | Mandatory |
| 5.7 | ContactNumber | String | Contact number for assistance at the boarding point. | Mandatory |
| 5.8 | Time | String | Reporting time at the boarding point (24-hour format). | Mandatory |
| 6 | DroppingPoints[] | Array | Details of the Dropping Points | Mandatory |
| 6.1 | Id | String | Unique identifier of the Dropping point. | Mandatory |
| 6.2 | MasterId | String | Reference ID linked with operator’s master Dropping data. | Mandatory |
| 6.3 | Name | String | Name of the dropping point (e.g., “A.S Raonagar 2”). | Mandatory |
| 6.4 | Location | String | Local area or neighborhood where the dropping point is located. | Mandatory |
| 6.5 | Address | String | Street or full address for the dropping point. | Mandatory |
| 6.6 | Landmark | String | Nearby landmark to help users find the location easily (e.g., “Bank, Hotel”). | Mandatory |
| 6.7 | ContactNumber | String | Contact number for assistance at the dropping point. | Mandatory |
| 6.8 | Time | String | Reporting time at the dropping point (24-hour format). | Mandatory |