Purpose
This WS allows to get declaration by its human readable unique number in Admin panel.
Key points
This is a graphQl method used in Administration panel only.
Only authenticated and authorized NHS employee with appropriate scope can get declaration by its human readable unique number.
Specification
Logic
Get data from ops DB:
declarations by declaration_number
Render a response according to specification.
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 = 'declaration:read')
return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration:read”) in case of invalid scope(s)
Request data validation*
Validate legal entity
Extract client_id from token.
Check client scopes in order to perform this action (scope = 'declaration:read')
in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration:read”)
Check client type (type = NHS)
In case of error - return 403 ('You don't have permission to access this resource')
Validate request
Check
declaration_number
submittedin case not submitted - return 422 ('required property declaration_id was not present')
in case does not exist in OPS db - return 404 ('Declaration not found')
Processing*
API paraagraph not found
Response structure*
API paraagraph not found
Post-processing processes*
API paraagraph not found
HTTP status codes*
API paraagraph not found