1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Filters
6 Global and configuration parameters
7 Preconditions
8 Request structure
9 Authorize
10 Headers
11 Validate request
12 Request data validation
13 Processing
14 Response structure
15 Post-processing processes
16 HTTP status codes
17 Backward compatibility

Purpose

Specification

Link	https://uaehealthapi.docs.apiary.io/#reference/internal.-ops-db/declarations/get-declaration-details-by-id
Resource
Scope
Components	Declarations
Using Microservices
Protocol type
Request type	GET
Sync/Async
Public/Private/Internal	Internal

Logic

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
id		string		`b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`

Filters

Global and configuration parameters

Preconditions

Request structure

Example:

Authorize

Headers

Content-Type:application/json

Validate request

Request data validation

Processing

Response structure

See on Apiary

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
    "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "employee_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "division_id": "`d290f1ee-6c54-4b01-90e6-d701748f0851`m",
    "legal_entity_id": "`d290f1ee-6c54-4b01-90e6-d701748f0851`m",
    "scope": "family_doctor",
    "start_date": "2017-03-02",
    "end_date": "2017-03-02",
    "signed_at": "2017-03-02T10:45:16.000Z",
    "inserted_at": "1991-08-19T00:00:00.000Z",
    "inserted_by": "userid",
    "updated_at": "1991-08-19T00:00:00.000Z",
    "updated_by": "userid"
  }
}

Post-processing processes

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response

E-Health

Get declaration details by id (Internal method)

Purpose

Specification

Logic

Input parameters

Filters

Global and configuration parameters

Preconditions

Request structure

Authorize

Headers

Validate request

Request data validation

Processing

Response structure

Post-processing processes

HTTP status codes

Backward compatibility