https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Purpose

This method allows to receive details of declarations by identifier and person_id from token

Logic

Service logic

1. Get person_id from token (x-person-id header)

2. Get declaration’s details from ops.declarations table using id and person_id

3. Get signed content from media storage and generate a link for it

4. Render response according to specification.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorization

• Verify the validity of access token

  • 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 = 'declaration:details_pis')

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: declaration:details_pis') in case of invalid scope(s)

Validate Person

• Get person_id from token (x-person-id header)

• Validate patient status is active (status = ‘active' & is_active = 'true’)

  • in case of error - return 404 ('not found')

Validate Declaration

• Check that declaration with such ID:

  • exists in the system (ops DB)

  • belongs to patient

    • in case of error - return 404 ('not found')

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used