1 Purpose
2 Specification
3 Logic
4 Filters
5 Authorize
6 Headers
7 Request data validation
- 7.1 Validate request
8 Processing
9 Response structure
10 HTTP status codes

Purpose

This method allows to get all existing contract employees for contracts with GB_CBP type through the NHS IT system

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-get-contract-employees
Resource	/api/admin/contract_employees
Scope	private_contracts:read
Components	Contracts
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private/Internal	Private

Logic

WS returns list of contract employees

Filters

Filter	Values	Type	Description	Example

Filter	Type	Description	Example
id	String	Contract division identifier	`b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`
employee_id	String	Employee identifier	`da1c07c3-1104-45a3-9a8c-04ffd898da6a`
division_id	String	Division identifier	`f93ac873-b999-47d2-a945-32e7f582eed0`
contract_id	String	Contract identifier	`82286646-ee07-4d89-929d-29287c367e8a`
is_active	Boolean	wether contract employees is active	`true`
page	Number	Page number	`2`
page_size	Number	A limit on the number of objects to be returned. Maximum: 500	`50`

Authorize

Verify the validity of api-key
1. Return 401 in case validation fails
Verify the validity of token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'private_contracts:read')
1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9

Request data validation

Validate request

Only authenticated and authorized user can use this service
Deleted records won't be shown in response

Processing

Search contract employees for contracts with type = GB_CBP in DB according to requested query parameters
Render a response

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "8be63914-a278-470b-b868-1af5b9087332",
      "staff_units": 1,
      "declaration_limit": 2000,
      "employee_id": "ce050c01-f4a5-4d5f-85d6-7e41d41146bf",
      "division_id": "62d0a654-2e7f-40fb-b1bb-8a38cdc3f701",
      "contract_id": "6bb64748-7707-4be8-86e0-56cfb08e9b88",
      "start_date": "2018-04-20T19:14:13Z",
      "end_date": "2019-04-20T19:14:13Z",
      "is_active": true,
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200

E-Health

Private. Get contract employees