Get latest trip updates (Java)
In this use case, the user receives the various updates of an ongoing trip
Code snippets
Client calls the BAP server to trigger status:
@PostMapping("/mobility/order_status")
public ResponseEntity orderStatus(
@RequestHeader HttpHeaders headers,
@RequestBody ClientOrderRequest request) {
var response = bapApplicationService.orderStatus(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": "status",
"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": "123412423423",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"order_id": "trip_1"
}
}
*/
public ClientResponse orderStatus(ClientOrderRequest request, HttpHeaders headers) {
// Generate message id
var messageId = UUID.randomUUID().toString();
// Check if transaction id exists in the request.
// Generate if not exists
var txnId = StringUtils.hasText(request.getTransactionId())
? request.getTransactionId()
: UUID.randomUUID().toString();
// Construct the Context based on the request parameters
var context = Context.builder().domain(request.getDomain())
.action(Context.ActionEnum.status)
.messageId(messageId)
.transactionId(txnId)
.transactionId(UUID.randomUUID().toString())
.timestamp(new Date().toString())
.build();
// Construct the protocol specific object to be passed to the BPP
// to get the status of the given order id
var statusRequest = StatusRequest.builder()
.context(context)
.message(StatusMessage.builder()
.orderId(request.getOrderId())
.build())
.build();
return invokeStatus(statusRequest, headers);
}
}
BAP server calls protocol status to the network
public Response invokeStatus(StatusRequest request, HttpHeaders headers) {
// Call to look up function which returns the the public key and BPP Endpoint to be called
var url = lookUp(headers);
// Call BPP Status api from the returned endpoint.
// Construct request headers with the public key
var responseEntity = apiClient.post(url[0] + Context.ActionEnum.status,
constructRequestHeaders(),
statusRequest,
Response.class);
// Validate the received response
if (responseEntity.getBody() == null || responseEntity.getBody().getError() != null ||
"NACK".equals(responseEntity.getBody().getMessage().getAck().getStatus())) {
// Return custom error to the client
return null;
}
return Response.of("ACK", null);
}
BAP receives protocol on_status
/*
Example Response JSON:
{
"context": {
"domain": "nic2004:60221",
"country": "IND",
"city": "std:080",
"action": "on_status",
"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": {
"order": {
"id":"trip_1",
"state":"Waiting for passenger",
"items":[
{
"id": "sedan_spot",
"quantity": {
"count": 1
}
}
],
"billing": {
"name": "John Doe",
"address": {
"door": "21A",
"name": "ABC Apartments",
"locality": "HSR Layout",
"city": "Bengaluru",
"state": "Karnataka",
"country": "India",
"area_code": "560102"
},
"email": "[email protected]",
"phone": "+919876543210"
},
"fulfillment": {
"tracking": true,
"start": {
"location": {
"id": "user-location",
"descriptor": {
"name": "Current user location"
},
"gps": "12.9349377,77.6055586"
},
"instructions": {
"name": "pick up instructions",
"short_desc": "Ask doorman to ring 21A"
},
"time": {
"label": "ETA",
"duration": "P12M"
},
"contact": {
"phone": "+919999999999",
"email": "[email protected]"
}
},
"end": {
"location": {
"gps": "12.914028, 77.638698"
}
},
"agent": {
"name": "Joe",
"image": "string",
"dob": "1990-08-17",
"gender": "Male",
"phone": "9876543210"
}
},
"quote": {
"price": {
"currency": "INR",
"value": "180"
},
"breakup": [
{
"title": "Sedan Spot Booking",
"price": {
"currency": "INR",
"value": "170"
}
},
{
"title": "Service Charge",
"price": {
"currency": "INR",
"value": "10"
}
}
]
},
"payment": {
"uri": "https://api.bpp.com/pay?amt=$180&mode=upi&vpa=bpp@upi",
"tl_method": "http/get",
"params": {
"amount": "180",
"mode": "upi",
"vpa": "bpp@upi"
},
"type": "ON-FULFILLMENT",
"status": "NOT-PAID"
}
}
}
}
*/
@PostMapping("/bap/on_status")
public ResponseEntity onStatus(
@RequestHeader HttpHeaders headers,
@RequestBody OnStatusRequest request) {
var response = bapCallbackApplicationService.onStatus(request, headers);
return ResponseEntity.ok(response);
}
public Response onStatus(OnStatusRequest 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_status results
// Endpoint for the client to poll the order status based on the message id
@GetMapping("/mobility/on_order_status")
public ResponseEntity onOrderStatus(
@PathVariable(ClientRoutes.PARAM_MESSAGE_ID) String messageId,
@RequestHeader HttpHeaders headers) {
var data = bapApplicationService.get(messageId);
return ResponseEntity.ok(data);
}