Properties of a REST API method document

Purpose

This method returns a list of all available already created capitation reports

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

1. Verify the validity of access token

   1. in case of error return 401 ('Access denied')

2. Check user scope capitation_report:read in order to perform this action

   1. in case of error generate 401 response ('Invalid scopes')

Verify role

Extract from token:

1. Validate client_id (is_blocked=false)

   1. in case of error return 403 Error ('Client is blocked')

2. In case WS was called by MSP check contractor_legal_entity is active

   • in case error return 403 - ('Client is not active')

Processing

N/A

Response structure examples

Return array of existing reports according to Apiary and Capitation Report Data Structure

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
      "billing_date": "2018-05-01",
      "inserted_at": "2018-05-22"
    }
  ]
}

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used

List of pages describing technical modules where the method is used