| Table of Contents |
|---|
Purpose
This WS allows to get detailed LE Reorganization Job info from Admin panel.
Key points
This is a graphQl query used in Administration panel only
Only authenticated and authorized NHS employee with appropriate scope can get LE Reorganization Job details.
Query returns single LE Reorganization Job by job identifier.
Specification
| Page Properties | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Logic
Get LE reorganization job by id
Render detailed LE reorganization job data according to schema
Request structure
API paragraph not found
Authorization
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 = 'legal_entity_merge_job:read')
return 403 (“Your scope does not allow to access this resource. Missing allowances: legal_entity_merge_job:read”) in case of invalid scope(s)
Headers
API paragraph not found
Validate legal entity
Extract client_id from token.
Check client scopes in order to perform this action (scope = 'legal_entity_merge_job:read')
in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: legal_entity_merge_job:read”)
Check legal entity status (status = ACTIVE)
In case of error - return 409 ('client_id refers to legal entity that is not active')
Service logic
...
Get LE reorganization job by id
...
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
API paragraph not found
Post-processing processes
API paragraph not found
HTTP status codes
API paragraph not found