...

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 ConfluenceUpdate global parameters for declarations.

Logic

Method updates global parameters for declarations.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

...

...

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

...

...

Key

...

Value

...

Mandatory

...

Description

...

Example

{
  "declaration_term": "30",
  "declaration_request_expiration": "30",
  "employ_request_expiration": "30",
  "verification_request_expiration": "30",
  "adult_age": "18",
  "billing_date": "2"
}

Headers

Headers

Request data validation

Authorize

Request to process the request using a token in the headersI

Processing

N/A

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "declaration_term": "30",
    "declaration_request_expiration": "30",
    "employ_request_expiration": "30",
    "verification_request_expiration": "30",
    "adult_age": "18",
    "billing_date": "2"
  }
}

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

...