Properties of a REST API method document

Purpose

This WS is designed to search (get list) of Employee roles.

Logic

1. Only authenticated and authorized user can use this service

2. Service returns only employee roles related to the same legal entity as the user

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Request structure

See on API-specification

Headers

Request data validation

Authorize

1. Verify the validity of access token

   1. Return 401 in case validation fails

2. Check scopes in order to perform this action (scope = 'employee_role:read')

   1. Return 403 in case invalid scope(s)

Processing

1. Extract client_id from token

2. Return entries filtered by client_id and query params

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
      "healthcare_service_id": "98b6ed10-17b4-44f1-892c-7514f66bf505",
      "employee_id": "9d229fcb-6a77-4574-99a5-30729aa518fd",
      "start_date": "2019-04-20T19:14:13Z",
      "end_date": "2017-12-20T19:14:13Z",
      "status": "ACTIVE",
      "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"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used