Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input N/A

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

Description of the REST API response structure, example

...

...

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case of error return 401 

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

See on API-specification

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

HTTP status codes

Post-processing processes

Description of actions performed on data after processingN/A

Technical modules where the method is used

List of pages describing technical modules where the method is used

...