Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

...

This web service is designed to obtain full information about capitation or reimbursement contract by NHS employee(private API) or MSP/PHARMACY employee (public API). Contract type should be declared in the URL.

Specification

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contracts/public.-get-contract-details

Resource

/api/contracts/{{contract_type}}/{{id}}

Scope

contract:read

Components

Contracts

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

Public

...

This method is designed to get full information of contract by id.

Contract type (capitation or reimbursement) should be declared in the URL.

Input parameters

Input parameter

Values

Type

Description

Example

contract_type

capitation

reimbursement

String

contract type

id

String

contract identifier

d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

  • Validate contract id. Check contract.id = $.id

    • in case error return 404 ("Contract with id=$id doesn't exist")

Processing

API paragraph not found

Response structure

See on Apiary

...

In response show ops.contracts.id+ops.contractor_employees.id and end_date is null

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code

Message

What caused the error

 200