Purpose

This method allows to create new contract employee record for existing contract with GB_CBP type through the NHS IT system

Specification

Logic

WS creating new contract employee

Request structure

See on Apiary

Example:

Authorize

1. Verify the validity of api-key

   1. Return 401 in case validation fails

2. Verify the validity of token

   1. Return 401 in case validation fails

3. Check scopes in order to perform this action (scope = 'private_contracts:write')

   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

The following attributes must be validated

1. Validate employee_id

   1. Check that employee exist and is_active = true

      1. in case of error return 404 error $.employee_id ('Employee is not found')

   2. Check that employee_id correspond to contractor legal entity through employees.legal_entity_id=contracts.contractor_legal_entity_id

      1. in case of error return 422 error $.employee_id ('Employee is not correspond to contractor legal entity')

2. Validate division_id

   1. Check that division exist and is_active = true

      1. in case of error return 404 error $.division_id ('Division is not found')

   2. Check that division_id correspond to contractor legal entity through divisions.legal_entity_id=contracts.contractor_legal_entity_id

      1. in case of error return 409 error $.division_id ('Division is not correspond to contractor legal entity')

3. Validate contract_id

   1. Check that contract exist and is_active = true and type = GB_CBP

      1. in case error return 409 error $.contract_id ('Contract must be an active and with GB_CBP type')

Validate request

1. Only authenticated and authorized user can use this service

2. Contract employee must be valid and consistent, i.e. all "foreign keys" must be valid

Processing

1. Set system attributes

2. Store to DB

3. Audit log (trigger logic)

Response structure

See on Apiary

Example:

HTTP status codes