1 Purpose
- 1.1 Key points
2 Specification
3 Logic
4 Request structure
5 Authorize
6 Headers
7 Request data validation
- 7.1 Validate legal entity
8 Processing
9 Response structure
10 Post-processing processes*
11 HTTP status codes

Purpose

This WS allows to find Legal Entity Reorganization Jobs in Admin panel using search params.

Key points

This is a graphQl query method used in Administration panel only
Only authenticated and authorized NHS employee with appropriate scope can search LE Reorganization Jobs
Query returns a list of LE Reorganization Jobs filtered by search params

Specification

Link	API paragraph not found
Resource	API paragraph not found
Scope	legal_entity_merge_job:read
Components	API paragraph not found
Microservices	API paragraph not found
Protocol type	API paragraph not found
Request type	API paragraph not found
Sync/Async	API paragraph not found
Public/Private/Internal	Private

  "Reads and enables pagination through a set of `LegalEntityReorganizationJob`."
  legalEntityReorganizationJobs(
    "A condition to be used in determining which values should be returned by the collection."
    filter: LegalEntityReorganizationJobFilter
    "The method to use when ordering collection items."
    orderBy: LegalEntityReorganizationJobOrderBy
    "Read all values in the set after (below) this cursor."
    after: String
    "Read all values in the set before (above) this cursor."
    before: String
    "Only read the first _n_ values of the set."
    first: Int
    "Only read the last _n_ values of the set."
    last: Int
  ): LegalEntityReorganizationJobConnection!
"""
Filter for Legal entity reorganization job.
"""
input LegalEntityReorganizationJobFilter {
  "Legal entity reorganization job status filters."
  status: JobStatus
  "Legal entity reorganization job type filters."
  type: LegalEntityReorganizationJobType
  "Reorganized Legal entity data filters."
  reorganizedLegalEntity: ReorganizedLegalEntityFilter 
}

Logic

Get list of all LE Reorganization Jobs filtered by
1. submitted search params
2. job types merge_legal_entities and reorganize_legal_entities
Render list with LE Reorganization Jobs data according to schema
Return number of total entries found in PageInfo block

Request structure

See on Apiary

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 = '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

Request data validation

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')

Processing

Search with a few params performs according to the logical AND rule.

status. Search by jobs.status
legalEntityReorganizationJobType. Search by jobs.meta.type (LE Reorganization Type)
reorganizedLegalEntity. Search by jobs.meta.merged_from_legal_entity.edrpou (Reorganized Legal Entity Edrpou)

Response structure

See on Apiary

Post-processing processes*

API paragraph not found

HTTP status codes

API paragraph not found

E-Health

(GraphQL) Search LE Reorganization Jobs

Analytics

Purpose

Key points

Specification

Logic

Request structure

Authorize

Headers

Request data validation

Validate legal entity

Processing

Response structure

Post-processing processes*

HTTP status codes

Related content