Versions Compared

Key

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

Purpose

...

API paragraph not found

Specification

...

Page Properties

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/service-requests/manage-service-requests/release-service-request

Resource

/api/service_requests/{{service_request_id}}/actions/release

Scope

service_request:use

Components

Service request

Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private/Internal

Public

Logic

...

...

Input parameters

Input parameter

Values

Type

Description

Example

service_request_id

String

Unique service request identifier

aff00bf6-68bf-4b49-b66d-f031d48922b3

Request structure

...

API paragraph not found

Authorize

...

  • Verify the validity of access token

    • Return (401, 'unauthorized') in case of validation fails

  • Verify that token is not expired

    • in case of error - return (401, 'unauthorized')

  • Check user scopes in order to perform this action (scope = 'service_request:use')

    1. Return (403, 'invalid scopes') in case of invalid scope(s)

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

  • api-key:aFBLVTZ6Z2dON1V

Request data validation

...

Validate legal entity

  • Check legal entity type: it has to be in me_allowed_transactions_le_types config parameter, has status = active 

    • in case of error return 409 "Action is not allowed for the legal entity"

...

  1. Get service request by ID

  2. Service request must be active

    1. ME.status == "active"

      1. in case of error return 409 "Invalid service request status"

  3. Program_processing_status must be "in_queue"

    1. ME.program_processing_status == "in_queue"

      1. in case of error return 409 "Invalid program processing status"

Processing

...

Service logic

  1. Update service request attributes. Erase used_by_employee

    1. Set Medical Events DB: service_requests[<id>].used_by_legal_entity to NULL

  2. Update service request attributes. Erase used_by_legal_entity

    1. Set Medical Events DB: service_requests[<id>].used_by_legal_entity to NULL

  3. Change program_processing_status to new

Response structure

...

See on Apiary

Example:

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

...

Page Properties

HTTP status code

Message

What caused the error

 202

 

 

...