Variable | Name | Type | Format | Usage | Description |
---|---|---|---|---|---|
application_name | application_name | string | |||
application_name_like | Application name like | string | |||
application_scenario | Application scenario | string | |||
application_section | application_section | string | |||
application_type | application_type | string | application type | ||
client_code | Client code | string | Unique client identifier. Issued automatically by the System upon new Customer registration. | ||
date_from | date_from | string | DATE | The period of dates for which you need to receive an extract - date From | |
date_to | date_to | string | DATE | The period of dates for which you need to receive an extract - date To | |
id | id | integer | INT64 | Record's sequence number generated in the system. | |
limit | limit | integer | int64 | Count records for part data to get | |
link_id | Link id | integer | |||
offset_version | Offset version | INTEGER | |||
offsetid | Offsetid | integer | |||
page | page | integer | int64 | Part data with number of page | |
page_changes_version_offset | Page changes version offset | INTEGER | |||
processing_status | Processing Status | string | Status of remote client data processing received from the external system | ||
processing_step | Processing step | string | Step of remote client data processing received from the external system | ||
quantity_limit_in_package | Quantity limit in package | integer | |||
skip_total_records | Skip total records | boolean | List of allowed values in field (value=>name):
|
||
source_id | Source id | integer |
{ "client_code" : "EN0000FRM", "id" : "2225", "processing_status" : "REJECTED", "processing_step" : "ERROR" }
200 - Response with error when status is ERROR
Variable | Name | Type | Format | Description |
---|---|---|---|---|
status | status | string | Request execution status | |
error_description | Error Description | string | Description of error | |
error | Error Code | string | Error code | |
data_type | data_type | string | Type of data | |
total_records | total_records | string | Total count of records | |
data | data | object | Empty object |
200 - Response successfully when status is OK
Variable | Name | Type | Format | Description |
---|---|---|---|---|
status | status | string | Request execution status | |
error_description | Error Description | string | Description of error | |
error | Error Code | string | Error code | |
data_type | data_type | string | Type of data | |
total_records | total_records | string | Total count of records | |
data | data | object | Empty object |
{ "status": "ok", "error_description": "", "error": {}, "data_type": "", "total_records": -2, "data": {} }