ЕСОЗ - публічна документація

RC_(GraphQL) Deactivate Employee (DMS)

Owned by Anna Popelysheva (SoE eHealth)

Last updated: Sep 30, 2024

1 min read

1 Purpose
2 Key points
3 Specification
- 3.1 Authorization
4 Service logic

Purpose

This WS is designed to allow NHS employees with appropriate scopes to deactivate Employee records with two options - defining death date and without.

Key points

This is a graphQl query method used in Administration panel only.
Only authenticated and authorized employee with appropriate scope can create employee request.

Specification

 "Deactivates a single `Employee` using its globally unique ID."
  deactivateEmployee(input: DeactivateEmployeeInput!): DeactivateEmployeePayload

"""
Input for `deactivateEmployee` mutation.

User must have scope `employee:deactivate`
"""
input DeactivateEmployeeInput {
  "Globally unique ID of the `Employee` which should be deactivated."
  id: ID!
}

"""
Return type for `deactivateEmployee` mutation.
"""
type DeactivateEmployeePayload {
  "Payload for Employee"
  employee: Employee
}

Authorization

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 = 'employee:deactivate')
- return 403 (“Your scope does not allow to access this resource. Missing allowances: 'employee:deactivate') in case of invalid scope(s)

Validate legal entity

employee_belongs to related legal entity

Service logic

Set fields in employees table (prm database)

status = DISMISSED
status_reason = $.status_reason

ЕСОЗ - публічна документація