Getting the schedule for a fixed-route, scheduled mobility service provider (example: Metro and Buses) (Java)
In this use case, the user views the schedule or time-table for a fixed route mobility service provider like a bus service, or a metro service
Code snippets
Client calls the BAP server to trigger search:
@PostMapping("/mobility/calculate_fare")
public ResponseEntity calculateFare(
@RequestHeader HttpHeaders headers,
@RequestBody ClientSearchRequest request) {
var response = bapApplicationService.generateSearchRequest(request, headers);
return ResponseEntity.ok(response);
}BAP server generates the protocol request body
/*
Example Request JSON:
{
"context": {
"domain": "nic2004:60221",
"country": "IND",
"city": "std:080",
"action": "search",
"core_version": "0.9.1",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"transaction_id": "1209849124",
"message_id": "12341242342",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"intent" : {
"fulfillment": {
"start" : {
"location" : {
"gps" : "10.109289, 76.349601"
}
},
"end" : {
"location" : {
"gps" : "10.087307, 76.342809"
}
}
}
}
}
}
*/
public Response generateSearchRequest(ClientSearchRequest request, HttpHeaders headers) {
var messageId = UUID.randomUUID().toString();
// Check and create transaction id if not passed
var txnId = StringUtils.hasText(request.getTransactionId())
? request.getTransactionId()
: UUID.randomUUID().toString();
// Construct the request similar to the example given above
var context = Context.builder().domain(request.getDomain())
.action(Context.ActionEnum.search)
.messageId(messageId)
.transactionId(txnId)
.transactionId(UUID.randomUUID().toString())
.timestamp(new Date().toString())
.build();
var intentBuilder = Intent.builder();
// Construct fulfilment object for the request from ride details
intentBuilder = intentBuilder.fulfilment(ClientAssembler.of(request.getFulfilment()));
var searchRequest = SearchRequest.builder()
.context(context)
.message(SearchMessage.builder()
.intent(intentBuilder.build()).build()).build();
return invokeSearch(searchRequest, headers);
}
}BAP server calls protocol search to the network
public Response invokeSearch(SearchRequest request, HttpHeaders headers) {
// Call to look up function which returns the the public key and BPP/BG Endpoint to be called
var url = lookUp(headers);
//Call BPP Search api
var searchResponse = apiClient.post(url[0] + Context.ActionEnum.search,
constructRequestHeaders(),
request,
Response.class);
if (responseEntity.getBody() == null || responseEntity.getBody().getError() != null ||
"NACK".equals(responseEntity.getBody().getMessage().getAck().getStatus())) {
// Return custom error to the client
return null;
}
return searchResponse.getBody();
}BAP receives protocol on_search
/*
Example Response JSON:
{
"context": {
"domain": "nic2004:60221",
"country": "IND",
"city": "std:080",
"action": "on_search",
"core_version": "0.9.1",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"bpp_id": "https://mock_bpp.com/",
"bpp_uri": "https://mock_bpp.com/beckn/",
"transaction_id": "1209849124",
"message_id": "12341242343",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"catalog": {
"bpp/descriptor": {
"name": "Metro Corp"
},
"bpp/providers": [
{
"id": "metro",
"descriptor" : {
"name": "Metro"
},
"locations": [
{
"id": "stop-1",
"station_code":"Aluva",
"gps": "10.109289, 76.349601",
"time":{
"schedule":{
"times":[
"2021-08-19T01:30:00.000Z",
"2021-08-19T01:50:00.000Z",
"2021-08-19T02:10:00.000Z",
"2021-08-19T02:30:00.000Z",
"2021-08-19T02:50:00.000Z",
"2021-08-19T03:10:00.000Z",
"2021-08-19T03:30:00.000Z",
"2021-08-19T03:50:00.000Z",
"2021-08-19T04:10:00.000Z",
"2021-08-19T04:30:00.000Z",
"2021-08-19T04:50:00.000Z"
]
}
}
},
{
"id": "stop-2",
"station_code":"Pulinchodu",
"gps": "10.095094, 76.346629",
"time":{
"schedule":{
"times":[
"2021-08-19T01:34:00.000Z",
"2021-08-19T01:54:00.000Z",
"2021-08-19T02:14:00.000Z",
"2021-08-19T02:34:00.000Z",
"2021-08-19T02:54:00.000Z",
"2021-08-19T03:14:00.000Z",
"2021-08-19T03:34:00.000Z",
"2021-08-19T03:54:00.000Z",
"2021-08-19T04:14:00.000Z",
"2021-08-19T04:34:00.000Z",
"2021-08-19T04:54:00.000Z"
]
}
}
},
{
"id": "stop-3",
"station_code":"Companypady",
"gps": "10.087307, 76.342809",
"time":{
"schedule":{
"times":[
"2021-08-19T01:38:00.000Z",
"2021-08-19T01:58:00.000Z",
"2021-08-19T02:18:00.000Z",
"2021-08-19T02:38:00.000Z",
"2021-08-19T02:58:00.000Z",
"2021-08-19T03:18:00.000Z",
"2021-08-19T03:38:00.000Z",
"2021-08-19T03:58:00.000Z",
"2021-08-19T04:18:00.000Z",
"2021-08-19T04:38:00.000Z",
"2021-08-19T04:58:00.000Z"
]
}
}
}
],
"items": [
{
"id": "1-2",
"descriptor" : {
"name" : "Aluva to Pulinchodu"
},
"price" : {
"currency": "INR",
"value": "10"
},
"matched": true
},
{
"id": "1-3",
"descriptor" : {
"name" : "Aluva to Companypady"
},
"price" : {
"currency": "INR",
"value": "20"
},
"matched": true
}
]
}
]
}
}
}
*/
@PostMapping("/bap/on_search")
public ResponseEntity onSearch(
@RequestHeader HttpHeaders headers,
@RequestBody OnSearchRequest request) {
var response = bapCallbackApplicationService.onSearch(request, headers);
return ResponseEntity.ok(response);
}
public Response onSearch(OnSearchRequest request, HttpHeaders headers) {
// Validate the headers received
var isHeadersValid = validateHeaders(headers);
// Construct and return error if the received headers are invalid
if (!isHeadersValid) return null;
// Store the data received based on message id for the client to poll
saveToDB(request);
return Response.of("ACK", null);
}Client polls BAP to get the on_search results
// Endpoint for the client to poll the search data based on the message id
@GetMapping("/mobility/on_search")
public ResponseEntity searchByMessageId(
@PathVariable(ClientRoutes.PARAM_MESSAGE_ID) String messageId,
@RequestHeader HttpHeaders headers) {
var data = bapApplicationService.getSearchData(messageId);
return ResponseEntity.ok(data);
}