Skip to main content

Get all the consent and subscription requests with given filters

Retrieve all consent and subscription requests based on specified filters.

GET/api/hiecm/subscription-requests/v3/patients/requests

By invoking this API, users can obtain a comprehensive list of requests that match the given criteria, including details about their status, scope, and any associated conditions. This functionality is essential for managing and tracking consent and subscription requests efficiently, ensuring that users have access to accurate and up-to-date information.

Authorizations

Authorizationbearer tokenRequired

Query parameters

consentLimitstringRequired

The consent limit - to limit records being fetched

consentOffsetstringRequired

The consent offset - to skip the records before fetching the first record

subscriptionLimitstringRequired

The subscription limit - to limit records being fetched

subscriptionOffsetstringRequired

The subscription offset - to skip the records before fetching the first record

statusstringRequired

The status of the subscription and consent

Headers

REQUEST-IDstringRequired

Unique UUID for tracking the end-to-end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds, and milliseconds

X-CM-IDstringRequired

Suffix of the consent manager to which the request was intended

X-AUTH-TOKENstringRequired

JWT Authentication token which was issued by ABDM after successful validation of username and password

Responses

200

OK

400

Bad Request

401

Unauthorized

Everything returns 401

403

Forbidden

404

server cannot find the requested resource

500

Internal Server Error

503

Internal Server Error -> It is just one example, for every api the path will be changed.