Table of Contents

minLevel	1
maxLevel	3

Purpose

...

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system

Specification

...

Page Properties
Link
https://ehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-divisions/private.-update-contract-division
Resource
/api/admin/contract_divisions/{{id}}
Scope
private_contracts:write
Components
Contracts
Microservices
API paragraph not found
Protocol type
REST
Request type
PUT
Sync/Async
Sync
Public/Private/Internal
Private

Logic

...

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system
...
Input parameter
Values
Type
Description
Example
id
String
`01f37f5-52c8-477e-aba5-a1d01876d210`

Request structure

...

See on Apiary

Example:

Expand

title	Request example

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

Authorize

...

Verify the validity of api-key
Return 401 in case validation fails
Verify the validity of token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'private_contracts:write')
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
...
Only authenticated and authorized user can use this service
Contract division must be valid and consistent, i.e. all "foreign keys" must be valid

Processing

...

Update system attributes
Attribute
Value
updated_at
now() timastamp
updated_by
User from token
...
3. Audit log (trigger logic)

Response structure

...

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "8be63914-a278-470b-b868-1af5b9087332",
    "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3",
    "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c",
    "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"
  }
}

Versions Compared

Old Version 19

New Version 20

Key

Purpose

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system

Specification

Logic

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system
...
Input parameter
Values
Type
Description
Example
id
String
`01f37f5-52c8-477e-aba5-a1d01876d210`

Request structure

See on Apiary
Example:
Expand
title Request example
Code Block
{ "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3", "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c" }

Authorize

Headers

Наприклад:
Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9

Request data validation

The following attributes must be validated
...
Only authenticated and authorized user can use this service
Contract division must be valid and consistent, i.e. all "foreign keys" must be valid

Processing

Update system attributes
Attribute
Value
updated_at
now() timastamp
updated_by
User from token
...
3. Audit log (trigger logic)

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code
Message
What caused the error
200

...

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

Purpose

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system

Specification

Logic

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system...Input parameterValuesTypeDescriptionExampleidString01f37f5-52c8-477e-aba5-a1d01876d210

Request structure

See on ApiaryExample: ExpandtitleRequest example Code Block{ "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3", "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c" }

Authorize

Headers

Наприклад:Content-Type:application/jsonapi-key:c2778f3064753ea70de870a53795f5c9

Request data validation

The following attributes must be validated...Only authenticated and authorized user can use this serviceContract division must be valid and consistent, i.e. all "foreign keys" must be valid

Processing

Update system attributesAttributeValueupdated_atnow() timastampupdated_byUser from token...3. Audit log (trigger logic)

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status codeMessageWhat caused the error 200 ...

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system
...
Input parameter
Values
Type
Description
Example
id
String
`01f37f5-52c8-477e-aba5-a1d01876d210`

See on Apiary
Example:
Expand
title Request example
Code Block
{ "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3", "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c" }

Наприклад:
Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9

The following attributes must be validated
...
Only authenticated and authorized user can use this service
Contract division must be valid and consistent, i.e. all "foreign keys" must be valid

Update system attributes
Attribute
Value
updated_at
now() timastamp
updated_by
User from token
...
3. Audit log (trigger logic)

HTTP status code
Message
What caused the error
200

...