prepare data model
Variable | Name | Type | Format | Usage | Description |
---|---|---|---|---|---|
X-App-Sig | X-App-Sig | header | string | M | Dev Authentication |
Variable | Name | Type | Format | Usage | Description |
---|---|---|---|---|---|
action | Action | string | |||
application_name | application_name | string | |||
application_scenario | Application scenario | string | |||
application_section | application_section | string | |||
application_type | application_type | string | application type | ||
attachments | attachments | string | Attachments | ||
client_code | Client code | string | Unique client identifier. Issued automatically by the System upon new Customer registration. | ||
create_date | Create Date | string | DATETIME | The date entry was created on | |
create_user | Create User | string | The username of ABS user who has created an entry | ||
error_description | Error Description | string | Description of error | ||
form_title | form_title | string | Service field | ||
id | id | integer | INT64 | Record's sequence number generated in the system. | |
link_id | Link id | integer | |||
modify_date | Modify Date | string | DATETIME | The date entry was last modified on | |
modify_user | Modify User | string | The username of ABS user who has made last changes to the entry | ||
oauth_access_token | Oauth access token | string | |||
overall_status | Overall status | string | |||
package_id | Package id | integer | |||
processing_status | Processing Status | string | Status of remote client data processing received from the external system List of allowed values in field (value=>name):
|
||
processing_step | Processing step | string | Step of remote client data processing received from the external system List of allowed values in field (value=>name):
|
||
source_id | Source id | integer | |||
state | state | integer | INT64 | Record state for replication | |
uid | uid | string | Unique record identifier which is used to distinguish between existing records | ||
version | version | integer | INT64 | Record version for replication |
{"application_type":"applicationContactBookEdit","application_data":{"address":"{\"country\":\"lv\",\"city\":\"\",\"area\":\"\",\"district\":\"\",\"street\":\"\",\"house\":\"\",\"postalcode\":\"\",\"flat\":\"\",\"latitude\":\"\",\"longitude\":\"\"}","bankCountry":"lv","companyId":"LV01","companyName":"TEST","entityType":"BUSINESS","language":"en","residence":"lv"},"source_system":"IB","client_code":"EN00000CY"}
200 - Response successfully when status is OK
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 | data of Response |
Variable | Name | Type | Format | Description |
---|---|---|---|---|
action | Action | string | ||
application_name | application_name | string | ||
application_scenario | Application scenario | string | ||
application_section | application_section | string | ||
application_type | application_type | string | application type | |
attachments | attachments | string | Attachments | |
client_code | Client code | string | Unique client identifier. Issued automatically by the System upon new Customer registration. | |
create_date | Create Date | string | DATETIME | The date entry was created on |
create_user | Create User | string | The username of ABS user who has created an entry | |
error_description | Error Description | string | Description of error | |
form_title | form_title | string | Service field | |
id | id | integer | INT64 | Record's sequence number generated in the system. |
link_id | Link id | integer | ||
modify_date | Modify Date | string | DATETIME | The date entry was last modified on |
modify_user | Modify User | string | The username of ABS user who has made last changes to the entry | |
oauth_access_token | Oauth access token | string | ||
overall_status | Overall status | string | ||
package_id | Package id | 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 | |
source_id | Source id | integer | ||
state | state | integer | INT64 | Record state for replication |
uid | uid | string | Unique record identifier which is used to distinguish between existing records | |
version | version | integer | INT64 | Record version for replication |
{"status": "ok","error_description": "","error": {},"data_type": "system.api.application.applicationModel","total_records": 1,"data": {"client_code": "EN00000CY","application_section": "","application_type": "applicationContactBookEdit","application_name": "","link_id": 0,"package_id": 0,"source_id": 0,"oauth_access_token": "","application_data": {"address": "{\"country\":\"lv\",\"city\":\"\",\"area\":\"\",\"district\":\"\",\"street\":\"\",\"house\":\"\",\"postalcode\":\"\",\"flat\":\"\",\"latitude\":\"\",\"longitude\":\"\"}","bankCountry": "lv","companyId": "LV01","companyName": "TEST","entityType": "BUSINESS","language": "en","residence": "lv"},"processing_status": "NEW","processing_step": "NORMAL","error_description": "","uid": "","id": 0,"version": 0,"state": 0,"create_user": "","create_date": null,"modify_user": "","modify_date": null}}
200 - Response with error when status is 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 |