Purpose*
This method allows to get existing contract by its id with GB_CBP type through the NHS IT system
Specification*
Logic*
This method allows to get existing contract by its id with GB_CBP type through the NHS IT system
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id | String |
|
Request structure*
API paragraph not found
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:read')
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*
Show requested contract.
a. If requested contract type not GB_CBP, show 404 Not found instead
Response structure*
See on Apiary
Example:
Post-processing processes*
API paragraph not found
HTTP status codes*
HTTP status code | Message | What caused the error |
---|---|---|
200 |
|
|