Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Purpose

This WS is designed to return Innm detail.

Specification

Page Properties

Link

API paragraph not found

Resource

/innms/{{id}}

Scope

innm:read

Components

Drugs and Program medications

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

Internal. NHS Admin

Logic

Method returns innms details by ID.

Input parameters

Input parameter

Values

Type

Description

Example

id

String

d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure

...

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 Innm by $.id.

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

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:

Expand
titleResponse example
Code Block
{
  "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"
  }
}

Post-processing processes

...

HTTP status codes

Page Properties

HTTP status code

Message

What caused the error

 202

 

 

...