Table of Contents

Status

...

Purpose

This WS is designed to return INNM detail.

APIary

get-innm-by-id

Input parameters (filters)

• id 

Logic WS

...

Purpose

This WS is designed to return INNM Dosage detail.

Specification

Logic

Method returns INNM Dosage 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 Dosage record 

1. Check exist Medication by $.id with type=INNM

...

1. _Dosage

   1. if invalid - return 404 error (message: "INNM Dosage is not found!")

Prepare & return response data structure

...

Validate type

Purpose validation:  Medication should be necessary type 

Validate `type` == INNM_Dosage

1. if invalid  - return 409 error (message: "Type of record by id is not INNM Dosage!")

Processing

Logic WS

1. Verify the validity of access token

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

3. Render the NNM Dosage detail in response

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "09b2bffb-699a-43c0-bc9a-5066d9b9b5a8",
    "name": "Амідарон",
    "form": "PILL",
    "ingredients": [
      {
        "id": "1349a693-4db1-4a3f-9ac6-8c2f9e541982",
        "name": "Амідарон",
        "dosage": {
          "numerator_unit": "MG",
          "numerator_value": 200,
          "denumerator_unit": "PILL",
          "denumerator_value": 1
        },
        "is_primary": true
      }
    ],
    "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