/
[DRAFT] Get clients [API-009-001-005-0335]

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

[DRAFT] Get clients [API-009-001-005-0335]

Owned by Serhii Boldin (SoE eHealth) (Unlicensed)
Last updated: Dec 18, 2024 by Anzhela Kovalenko (SoE eHealth)
2 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

 

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

Document type

Метод REST API

Document title

[DRAFT] Get clients [API-009-001-005-0335]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-009-001-005-0335

Microservices (namespace)

Mithril

Component

Mithril

Component ID

COM-009-001

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-clients

Resource

{{host}}/api/clients

Scope

client:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This service returns a list of clients filtered by context depending on client type:

  • Mithril Admin - receives all client records without context

  • MSP - receives only its own client

  • MIS - receives only its own client

Logic

This service must return a list of clients filtered by context depending on client type

  1. Extract client_type from token

  2. Filter response:

    1. Mithril Admin - receives all client records without context

    2. MSP, MIS, PHARMACY - receives only its own client

Prepare response

  1. Query data from mithril.clients using context

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

  1. Verify the validity of access token

    1. in case of error return 401 ('Access denied')

  2. Check user scope client:read in order to perform this action

    1. in case of error generate 403 response ('Invalid scopes')

Processing

N/A

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": "df9f70ee-4b12-4740-b0f5-bb5aea116863", "name": "eHealth portal", "settings": {}, "user_id": "user-1380df72-275a-11e7-93ae-92361f002671", "client_type_id": "261d52f9-b355-4029-863d-8fc52e9d0b81", "is_blocked": "false", "block_reason": "MSP has fakes doctors", "inserted_at": "2017-04-20T19:14:13Z", "updated_at": "2017-04-20T19:14:13Z" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 Response

 

 

3

 

401

Access denied

 

 

4

 

403

Invalid scope

 

 

5

Специфічні

6

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

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