Purpose
This WS is designed to allow NHS employee with assigned appropriate scopes to get DRACS Divorce Act details.
Key points
This is a graphQl query method used in Administration panel only.
Only authenticated and authorized NHS employee with appropriate scope can get DRACS Divorce Act details.
Specification
Authorize
Verify the validity of access token
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 = 'person:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: person:read') in case of invalid scope(s)
Validate legal entity
Extract client_id from token.
Check legal entity status (status = ACTIVE)
In case of error - return 409 ('client_id refers to legal entity that is not active')
Check client type (type = NHS)
In case of error - return 403 ('You don't have permission to access this resource')
Validate request
Validate $.id
Check id
is ID from mimir.dracs_divorce_acts
in case of error, return
404
, "Such Divorce Act doesn't exist"
Service logic
Get Divorce Act data from mimir.dracs_divorce_acts by id
Render a response according to specification.