...

...

...

...

Purpose

This WS is designed to create new Substance (post).

APIary 

create-substance

Input parameters

• name
• name_original
• sctid

Purpose

This WS is designed to create new Innm (post).

Specification

Logic

This method is used to create new innm. Fields descriptions are listed in request Example view.

Request structure

See on Apiary

Example:

{
  "sctid": "52574003",
  "name": "Аміодарон",
  "name_original": "Amiodarone"
}

Authorize

1. Verify the validity of access token

2. Check user

...

1. scope (scope = '

...

1. innm:write') in order to perform this action

   1. In case error - generate 401 response

Validate request (JSON schema)

Validate request using JSON schema (link !!! TBD)

Create new Substance

...

Request to process the request using a token in the headers

Headers

Наприклад:

• Content-Type:application/json

• Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

API paragraph not found

Processing

Create new Innm

1. Create new record in `innms`

2. Fill data

Prepare & return response data structure

...

...

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 201,
    "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"
  }
}

{
  "meta": {
    "code": "409",
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "error": {
    "type": "duplicate",
    "message": "innm duplicate"
  }
}

HTTP status codes