Sending the schedule for a fixed-route, scheduled mobility service provider (example: Metro and Buses) (Node.js)
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
BPP receives protocol search
/*
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"
}
}
}
}
}
}
*/
// Auth middleware authenticates the digital signature of the incoming request
router.post('/mobility/search', auth, search);
function search({ headers, body }, res) {
try {
const message = _.get(body, "message");
const context = _.get(body, "context");
if (!context) {
return res.status(400).send(httpResponse("NACK", "Missing Context"));
}
if (!message) {
return res.status(400).send(httpResponse("NACK", "Missing Message"));
}
// ... Returns the ack immediately and continue the processing after validation
res.status(200).send(httpResponse("ACK"));
processSearch(headers, body)
} catch (error) {
res.status(500).send(httpResponse("NACK", error));
}
};BPP processes the search
function processSearch(requestHeaders, searchRequestBody) {
// Execute business logic here
let searchResponse = {
}
generateResponse(requestHeaders, searchResponse)
}BPP generates response
async function generateResponse(requestHeaders, rawResponse){
/*
Example Request 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
}
]
}
]
}
}
}
*/
//The below code generates the above example JSON.
let onSearchResponseBody = { }
//call protocol on_search
await callOnSearch(requestHeaders, onSearchResponseBody);
}
BPP calls protocol on_search
async function callOnSearch(requestHeaders, onSearchResponseBody) {
// Take the subscriber Id from the header and calls the registry to get the url. If already cached it need not to call again
const uri = await lookup(requestHeaders);
// Construct Header
const headers = constructAuthHeader(); // Auth Header with digital Signature
return axios({ url: `${uri}/mobility/on_search`, method: "POST", headers, data: onRatingResponseBody });
}