...

...

...

...

...

Purpose

This WS is designed to return Substance detail.

APIary

get-substance-by-id

Input parameters (filters)

• id 

Logic WS

...

Purpose

This WS is designed to return Innm detail.

Specification

Logic

Method returns innms details by ID.

Input parameters

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:

• Content-Type:application/json

• Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate PK Medication

Purpose validation: Check on existing

...

Innm record 

1. Check exist

...

1. Innm by $.id.

   1. if invalid - return 404 error (message: "

...

1. 1. Innm is not found!")

...

Validate status

Purpose validation:  Substance should be active (is_active == TRUE)

1. Validate `is_active` == TRUE

1. 1. if invalid  - return 409 eror (message: "Substance is not active !")

Prepare & return response data structure

...

Processing

Logic WS

1. Verify the validity of access token

2. Check user scopes in order to perform this action (scope = 'innm:read')

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "c7d52544-0bd4-4129-97b0-2d72633e0490",
    "sctid": "52574003",
    "name": "Аміодарон",
    "name_original": "Amiodarone",
    "is_active": true,
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

HTTP status codes