Required parameters are marked with "*"

...

Purpose*

API paragraph not found

...

Purpose

This method to remove a service request from a reservation.

Specification

Logic

...

...

Input parameters

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{{access_token}}

• api-key: aFBLVTZ6Z2dON1V{{secret}}

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"

...

Only active and used service request can be released

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
title Response 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  202202     401 Unauthorized 403 Invalid scopes 409 Validation failed