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

RC_Rx_Get healthcare service by ID (modified - EN)

Purpose

This WS is designed to return healthcare service details.

Key points

  1. Only authenticated and authorized user with appropriate scope can get healthcare services list.

  2. WS returns only details of healthcare service related to the same legal entity as the user.

Specification

Apiary

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 = 'healthcare_service:read')

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

Validations

Validate healthcare service

  • Get healthcare service by $.id. Check that healthcare service exists in PRM DB

    • in case of error - return 404 (“not_found”)

  • Get healthcare service by $.id. Check that healthcare service belongs to legal entity id from access token

    • in case of error - return 403 (“forbidden”)

Search params

  • healthcare service ID

Service logic

  1. Get data from healthcare_services by id (PRM DB)

  2. Render a response according to specification

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