Purpose

...

This web service is designed to change service request status to `In progress`.

Specification

...

Page Properties

Link https://medicaleventsmisapi.docs.apiary.io/#reference/service-requests/manage-service-requests/change-service-request-status-to-in-progress Resource /api/service_requests/{{service_request_id}}/actions/process Scope service_request:makeinprogress Components Service request Microservices API paragraph not found Protocol type REST Request type PATCH Sync/Async Async Public/Private/Internal Public

Logic

...

This web service is designed to change service request status to `In progress`.

Input parameters

Request structure

...

API paragraph not found

Authorize

...

Request to process the request using a token in the headers

Headers*

Наприклад:

...

Content-Type:application/json

...

...

api-key:aFBLVTZ6Z2dON1V

Request data validation*

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case of error return 401 

Validate scopes

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

  1. Return 403 in case invalid scope(s)

Headers

• Content-Type:application/json

• Authorization:Bearer {{access_token}}

• api-key: {{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 leagal entity"

...

Qualify service request

1. invoke qualify

Validate used_by_legal_entity

1. Service request must be used by the same legal entity that current user is from 

   1. ME.service_request.used_by_legal_entity=token.legal_entity_id

Processing

...

1. Change service_request.program_processing_status to "in_progress"

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 422 Validation failed