...
...
Purpose
This WS is designed to return Program brand detail.
...
Table of Contents |
---|
Purpose
This WS allows to get single medication program participant.
Specification
Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
Get program medication by id.
Render detailed program medication data according to schema.
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.
Input parameters
Parameter | Value | Type | Description | Example |
---|---|---|---|---|
id | String |
|
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
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
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 Medications
Check the Medication brand within the Medical program ($.id) exists in PRM.program_brands
...
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').
Response structure
See on Apiary
Expand | ||
---|---|---|
| ||
|
HTTP status codes
Page Properties | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|