...

Request structure

...

Authorize

• Verify the validity of access token

  • in case of error - return 401 “Invalid access token” in case of validation fails

• Verify that token is not expired

  • in case of error - return 401 “Invalid access token”

• Check user scopes in order to perform this action (scope = 'medical_program_provision:write')

  • return 403 “Your scope does not allow to access this resource. Missing allowances: medical_program_provision:write” in case of invalid scope(s)

Request to process the request using a token in the headers

Headers

Наприклад:

• Content-Type:application/json

• Authorization:Bearer F3GF124Df565FDS234SDF34

• api-key:aDGFDFGT46S5gFGD

...

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "3e34da3d-9b8c-4aaf-be8e-24a161279b6a",
    "contract_number": "0000-PAP5-M000",
    "medical_program_id": "04d5ea65-d6e7-44f8-9eef-f0d3c1121d2b",
    "division_id": "15caea3f-cac3-483c-a3da-5875eba96430",
    "is_active": false,
    "deactivate_reason": "MANUAL_DEACTIVATION",
    "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"
  }
}

Post-processing processes

...

HTTP status codes

...