...

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

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

Specification

...

Apiary

...

*

Logic*

API paragraph not found

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

• Authorization:Bearer mF_9.B5f-4.1JqM

• 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)

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"

Validate transition

1. Service request must be active

   1. ME.service_request.status  == "active"

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

2. Program processing status should be in_queue

   1. ME.service_request.program_processing_status  == "in_queue"

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

Validate program

1. Validate program according to Pre-Qualify rules.

   1. it is an existing service program (type=service)

      1. in case not found or is_active==false return 422  "Program not found"

      2. in case type!= service return 422 "Invalid program type"

   2.  service(or service_group) is an active member of the program

      1. Select request_allowed, is_active from PRM.program_services where service_id(or group_id) == $.signed_content.code.identifier.value and program_id=$.program.identifier.value

         1. if not found or is_active==false return 422 "Service is not included in the program"

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:

{
  "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*