Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

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

...

Specification*

...

{
  "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3",
  "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c"
}

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

...

The following attributes must be validated

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

2. 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 division must be valid and consistent, i.e. all "foreign keys" must be valid

Processing*

1. Set system attributes

...