Viewing the fare products of a mobility service (Java)

In this use case, the user views the various fare products a mobility service provider offers. Fare products are various offerings on a particular service like "Monthly Pass", "Single Journey Adult Ticket", "Return Ticket", "Day Pass" etc. These fare products are usually represented as items of a mobility service catalog. Other examples include products like "Uber Go", "Uber X" etc

Code snippets

Client calls the BAP server to trigger search:

    @PostMapping("/mobility/view_by_fare")
    public ResponseEntity viewByFare(
            @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" : "12.9349377,77.6055586"
                    }
                },
                "end" : {
                    "location" : {
                        "gps" : "12.4535445,77.9283792"
                    }
                }
            }
        }
    }
}
*/

    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 fare
        intentBuilder = intentBuilder.fulfillment(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": "Mock BPP"
            },
            "bpp/providers": [
                {
                    "id": "metro-one",
                    "descriptor" : {
                        "name": "Metro One"
                    },
                    "categories": [
                        {
                            "id": "monthly",
                            "descriptor": {
                                "name": "Monthly Pass"
                            }
                        },
                        {
                            "id": "day",
                            "descriptor": {
                                "name": "Day Pass"
                            }
                        }
                    ],
                    "items": [
                        {
                            "id": "monthly_one_way",
                            "descriptor" : {
                                "name" : "One way monthly pass",
                                "images" : [
                                    "https://mock_bpp.com/images/m1.jpg"
                                ]
                            },
                            "category_id": "monthly",
                            "price" : {
                                "currency": "INR",
                                "value": "500"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-09-17T05:22:34.861Z"
                                }
                            },
                            "matched": true
                        },
                        {
                            "id": "monthly_two_way",
                            "descriptor" : {
                                "name" : "Two way monthly pass",
                                "images" : [
                                    "https://mock_bpp.com/images/m2.jpg"
                                ]
                            },
                            "category_id": "monthly",
                            "price" : {
                                "currency": "INR",
                                "value": "1000"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-09-17T05:22:34.861Z"
                                }
                            },
                            "matched": true
                        },
                        {
                            "id": "unlimited_day",
                            "descriptor" : {
                                "name" : "Unlimited Day Pass",
                                "images" : [
                                    "https://mock_bpp.com/images/du.jpg"
                                ]
                            },
                            "category_id": "day",
                            "price" : {
                                "currency": "INR",
                                "value": "200"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-08-18T05:22:34.861Z"
                                }
                            },
                            "matched": true
                        },
                        {
                            "id": "day_two_way",
                            "descriptor" : {
                                "name" : "Two way day pass",
                                "images" : [
                                    "https://mock_bpp.com/images/d2.jpg"
                                ]
                            },
                            "category_id": "day",
                            "price" : {
                                "currency": "INR",
                                "value": "50"
                            },
                            "time": {
                                "range": {
                                    "start": "2021-08-17T05:22:34.861Z",
                                    "end": "2021-08-18T05:22:34.861Z"
                                }
                            },
                            "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);
    }