Purpose

API paragraph not found

Specification

Logic

1. Only authenticated and authorized user can use this service

2. Only ACTIVE employee role can be deactivated

3. Legal entity can deactivate only its own employee roles

Request structure

API paragraph not found

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:write')

   1. Return 403 in case invalid scope(s)

Headers

API paragraph not found

Request data validation

Validate legal entity

Check that legal entity is active (status = ACTIVE, SUSPENDED)

1. Extract client_id from token (token.client_id == legal_entity_id)

2. Check legal entity status (status = ACTIVE, SUSPENDED)

   1. In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)

Validate employee role

1. Check that employee role with such ID exists in the system (is_active = true)

   1. In case of error - return 404

2. Check that employee role belongs to the same legal entity as the user

   1. In case of error - return 403

Validate transition

Only ACTIVE employee role can be deactivated

Available transitions

1. ACTIVE → INACTIVE

In other cases - return 409 error ('{current_status} employee role cannot be DEACTIVATED')

Processing

Update object in DB

Response structure

See on Apiary

Example:

{
  "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": "INACTIVE",
    "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"
  }
}

HTTP status codes