| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [Document status] REST API [Назва методу] [ID методу] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-004-001-001-0014 |
|---|
Microservices (namespace) | Gitlab |
|---|
Component | Configuration |
|---|
Component ID | COM-004-001 |
|---|
Link на API-специфікацію | |
|---|
Resource | {{host}}/global_parameters |
|---|
Scope | |
|---|
Protocol type | REST |
|---|
Request type | PUT |
|---|
Sync/Async | Sync |
|---|
Public/Private | Private |
|---|
|
Purpose
Update global parameters for declarations.
Logic
Method updates global parameters for declarations.
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | | | | | |
| 2 | | | | | |
Request structure
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
| {
"declaration_term": "30",
"declaration_request_expiration": "30",
"employ_request_expiration": "30",
"verification_request_expiration": "30",
"adult_age": "18",
"billing_date": "2"
} |
|
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
| Expand |
|---|
|
| Code Block |
|---|
| {
"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
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | | | |
| 3 | Специфічні |
| 4 | | | | | |
Post-processing processes
N/A
Technical modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...