...
...
...
...
Table of Contents |
---|
Purpose
This WS allows to get single medication program participant.
Key points
This is a graphQl method used in Administration panel only
Only authenticated and authorized NHS employee with an appropriate scope can get a Program medication.
Specification
Page Properties | |||
---|---|---|---|
|
...
...
Purpose
This WS is designed to return Program medication detail.
...
|
Logic
Get program medication by id.
Render detailed program medication data according to schema.
Preconditions
API paragraph not found
Global and configurable parameters
API paragraph not found
Input parameters
API paragraph not found
Filters
API paragraph not found
Dictionaries
API paragraph not found
GraphQl Specification
Expand | ||
---|---|---|
|
Authorize
Verify the validity of access token
...
in case of error - return 401 (“Invalid access token”) in case of validation fails.
Verify that token is not expired
in case of error -
...
return 401 (“Invalid access token”).
Check user
...
scopes in order to perform this action (scope = 'program_medication:read'
...
)
return 403 (“Your scope does not allow to access this resource. Missing allowances: program_medication:read”) in case of invalid scope(s).
Headers
API paragraph not found
Request data validation
Validate legal entity
Extract client_id from token.
Check client scopes in order to perform this action
...
(scope = 'program_medication:read')
in case of error -
...
Validate PK Program Brands
Check the Medication brand within the Medical program ($.id) exists in PRM.program_medications
...
return 403 (“Your scope does not allow to access this resource. Missing allowances: program_medication:read”).
Validate params
Validate program medication id exists in DB
in case of error - return 404 ('not_found').
Processing
API paragraph not found
Response structure
API paragraph not found
Post-processing processes
API paragraph not found
HTTP status codes
Page Properties | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Backward compatibility
API paragraph not found