Receiving a search intent based on location for consultation options nearby and sending a list of consultaion options (Java)
In this use case, the user simply searches for doctors, clinics and hospitals around his location.
Code snippets
BPP receives protocol search
/*
Example Request JSON:
{
"context": {
"domain": "nic2004:85121",
"country": "IND",
"city": "std:080",
"action": "search",
"core_version": "0.9.2",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"transaction_id": "1239890342",
"message_id": "123793824",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"intent": {
"fulfillment": {
"end": {
"location": {
"gps": "12.4535445,77.9283792"
}
}
}
}
}
}
*/
// BPP Search endpoint
@PostMapping("/bpp/search")
public ResponseEntity search(
@RequestHeader HttpHeaders headers,
@RequestBody SearchRequest request) {
var response = bppApplicationService.search(request, headers);
return ResponseEntity.ok(response);
}
BPP processes the search
public Response search(SearchRequest request, HttpHeaders headers) {
var searchResponse = new OnSearchRequest();
// Validate the headers
var isHeadersValid = validateHeaders(headers);
// Construct and return error
if (!isHeadersValid) return null;
// Fetch the data based on the request
var requestIntent = request.getMessage().getIntent();
// Execute business logic here
// Generate the response
searchResponse = generateSearchResponse(searchResult);
//invoke on_search api
return invokeOnSearch(searchResponse, headers);
}
}
BPP generates response
/*
Example Response JSON:
{
"context": {
"domain": "nic2004:85121",
"country": "IND",
"city": "std:080",
"action": "on_search",
"core_version": "0.9.2",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"transaction_id": "1239890342",
"message_id": "123793824",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"catalog": {
"bpp/descriptor": {
"name": "Clinic Chains BPP"
},
"bpp/providers": [
{
"id": "good-health-clinic",
"descriptor": {
"name": "Good Health Clinic"
},
"locations": [
{
"id": "good-health-koramangala",
"gps": "12.9349377,77.6055586"
}
],
"categories": [
{
"id": "dermatology",
"descriptor": {
"name": "Dermatology"
}
},
{
"id": "family-medicine",
"descriptor": {
"name": "Family medicine"
}
}
],
"items": [
{
"id": "dr_veena",
"descriptor": {
"name": "Dr.Veena in person consultation"
},
"category_id": "dermatology",
"location_id": "good-health-koramangala",
"matched": true
},
{
"id": "dr_veena_slot_1",
"parent_item_id": "dr_veena",
"descriptor": {
"name": "Dr.Veena in person morning slot 1"
},
"time": {
"range": {
"start": "2021-08-11T04:30:00.000Z",
"end": "2021-08-11T05:30:00.000Z"
}
},
"price": {
"currency": "INR",
"value": "1000"
}
},
{
"id": "dr_veena_slot_2",
"parent_item_id": "dr_veena",
"descriptor": {
"name": "Dr.Veena in person morning slot 2"
},
"time": {
"range": {
"start": "2021-08-11T05:30:00.000Z",
"end": "2021-08-11T06:30:00.000Z"
}
},
"price": {
"currency": "INR",
"value": "1000"
}
},
{
"id": "dr_tony",
"descriptor": {
"name": "Dr.Tony online consultation"
},
"category_id": "family-medicine",
"matched": true
},
{
"id": "dr_tony_slot_1",
"parent_item_id": "dr_tony",
"descriptor": {
"name": "Dr.Tony online slot 1"
},
"time": {
"range": {
"start": "2021-08-11T07:30:00.000Z",
"end": "2021-08-11T08:30:00.000Z"
}
},
"price": {
"currency": "INR",
"value": "1000"
}
},
{
"id": "dr_tony_slot_2",
"parent_item_id": "dr_tony",
"descriptor": {
"name": "Dr.Tony online slot 1"
},
"time": {
"range": {
"start": "2021-08-11T08:30:00.000Z",
"end": "2021-08-11T09:30:00.000Z"
}
},
"price": {
"currency": "INR",
"value": "1000"
}
}
]
},
{
"id": "healthy-clinic",
"descriptor": {
"name": "Healthy Clinic"
},
"locations": [
{
"id": "healthy-skin-clinic-koramangala",
"gps": "12.9349377,77.6055586"
}
],
"categories": [
{
"id": "dermatology",
"descriptor": {
"name": "Dermatology"
}
}
],
"items": [
{
"id": "dr_noor",
"descriptor": {
"name": "Dr.Noor online consultation"
},
"category_id": "dermatology",
"matched": true
},
{
"id": "dr_noor_slot_1",
"parent_item_id": "dr_noor",
"descriptor": {
"name": "Dr.Noor online slot 1"
},
"time": {
"range": {
"start": "2021-08-11T07:30:00.000Z",
"end": "2021-08-11T08:30:00.000Z"
}
},
"price": {
"currency": "INR",
"value": "1000"
}
},
{
"id": "dr_noor_slot_2",
"parent_item_id": "dr_noor",
"descriptor": {
"name": "Dr.Noor online slot 1"
},
"time": {
"range": {
"start": "2021-08-11T08:30:00.000Z",
"end": "2021-08-11T09:30:00.000Z"
}
},
"price": {
"currency": "INR",
"value": "1000"
}
}
]
}
]
}
}
}
*/
public OnSearchRequest generateSearchResponse(List searchResult) {
var searchResult = SearchResponseBuilder.builder.result(searchResult).build();
// Convert response into protocol object similar to example above
return searchResult;
}
BPP calls protocol on_search
public Response invokeOnSearch(OnSearchRequest searchResponse, HttpHeaders headers) {
if(searchResponse.getError() == null) {
// Call BAP on_search api with the search response
// Call to look up function which returns the the public key and BAP/BG Endpoint to be called
var url = lookUp(headers);
var response = apiClient.post(url[0] + Context.ActionEnum.on_search,
constructResponseHeaders(),
searchResponse,
OnSearchRequest.class);
return Response.of("ACK", null);
} else {
return Response.of("NACK", null);
}
}