pmjay_panel_facility_discovery

Search

Searches PM-JAY empanelled facilities. Beckn search action; results arrive at on_search.

POST/v1/search

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

contextobjectRequired

context.domainstringRequired

context.countrystringRequired

context.citystringRequired

context.actionstringRequired

context.core_versionstringRequired

context.consumer_idstringRequired

context.consumer_uristringRequired

context.message_idstringRequired

context.timestampstringRequired

context.transaction_idstringRequired

messageobjectRequired

message.intentobjectRequired

message.intent.fulfillmentobjectRequired

message.intent.fulfillment.startobjectRequired

message.intent.fulfillment.endobjectRequired

message.intent.fulfillment.typestringRequired

message.intent.itemobjectRequired

message.intent.item.descriptorobjectRequired

message.intent.locationobjectRequired

message.intent.location.stateobjectRequired

Responses

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

curl --request POST \
  --url https://phrsbx.abdm.gov.in/v1/search \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {
    "domain": "nic2004:85112",
    "country": "IND",
    "city": "std:011",
    "action": "search",
    "core_version": "0.7.1",
    "consumer_id": "aarogyaSetu.eua",
    "consumer_uri": "https://aarogyasetu.abdm.gov.in/aarogyasetu/api/v3/app/api/hem",
    "message_id": "<GENERATED>",
    "timestamp": "<ISO_8601_TIMESTAMP>",
    "transaction_id": "<GENERATED>"
  },
  "message": {
    "intent": {
      "fulfillment": {
        "start": {
          "time": {
            "timestamp": "2022-07-22T13:21:41"
          }
        },
        "end": {
          "time": {
            "timestamp": "2022-07-22T23:59:59"
          }
        },
        "type": "PMJAYHEM"
      },
      "item": {
        "descriptor": {
          "code": "PMJAY",
          "name": "<NAME>",
          "flag": false
        }
      },
      "location": {
        "state": {
          "name": "<NAME>",
          "code": "27"
        }
      }
    }
  }
}'

{
  "code": "900902",
  "message": "Missing Credentials",
  "description": "Invalid Credentials. Make sure your API invocation call has a header: 'Authorization : Bearer ACCESS_TOKEN' or 'Authorization : Basic ACCESS_TOKEN' or 'apikey: API_KEY'"
}

Generated from the schema. The values are placeholders, not a captured response.