Purpose

This method is designed to stop previously created Device dispense

Key points

1. Only authenticated and authorized users of legal entity who has created Device dispense can stop Device dispense

2. Device dispense can be rejected only from ‘IN_PROGRESS' status.

Specification

Logic

1. Update Device dispense data in device_dispenses (MongoDB):

   1. set status  =  ‘stopped’

   2. updated_by = user_id

   3. updated_at = now()

2. Send StatusChangeEvent to Event Manager

Input parameters

Request structure

API paragraph not found

Authorize

1. Verify the validity of access token

   • in case of error - return 401 (“Invalid access token”) in case of validation fails

2. Verify that token is not expired

   • in case of error - return 401 (“Invalid access token”)

3. Check user scopes in order to perform this action (scope = 'device_dispense:stop')

   • return 403 (“Your scope does not allow to access this resource. Missing allowances: device_dispense:stop”) in case of invalid scope(s)

Headers

API paragraph not found

Request data validation

Validate Legal entity

1. Extract client_id from token

2. Check legal entity exists and its status is ACTIVE

   • In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate Device dispense

• Get Device dispense identifier from the URL

  • Check Device dispense exists in device_dispenses (MongoDB)

    • Return 404 ('not_found') in case of error

  • Check Device dispense belongs to legal entity

    • Return 404 ('not_found') in case of error

Validate transition

Only device dispense in in_progress status can be stopped

1. Get current device dispense status

   1. Check that status in ('in_progress')

      1. in case of error - return 409 error ('Device dispense in status %status% cannot be stopped')

For more information look at https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/17492805190 .

Processing

API paragraph not found

Response structure

See on Apiary

Example:

{
  "data": {
    "status": "pending",
    "eta": "2018-08-02T10:45:16.000Z",
    "links": [
      {
        "entity": "job",
        "href": "/Jobs/NBXk9EyErUZv1RhXgyvgg"
      }
    ]
  },
  "meta": {
    "code": 202,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Post-processing processes

API paragraph not found

HTTP status codes