Schemas Postman

Add Info. Fetch data by request POST

get data of currency by parametrs

# ENDPOINT
/api/additionalInformation/getData/additionalInformationSearchRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
# REQUEST BODY
Schema: additionalInformationSearchRequest
Type: object
Variable Name Type Format Usage Description
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
field_name field_name string
field_tag field_tag string Tag
field_value field_value string Value
limit limit integer int64 Count records for part data to get
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
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
source_table Source table string
source_uid Source uid string
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: additionalInformation
Type: application/json
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 array data of Response
attribute: data
Variable Name Type Format Description
action Action string
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
field_description field_description string Description
field_helpbox field_helpbox string Helpbox
field_name field_name string
field_tag field_tag string Tag
field_type field_type string Data type
field_value field_value string Value
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
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
parent_id Parent ID integer INT64 Parent record ID of a given record
source_table Source table string
source_uid Source uid string
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
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
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
# Other endpoints
Name Endpoint
Add Info. Fetch data by ID /model/additionalInformation/getDb/{id}
Add Info. Validate data /model/additionalInformation/validate
Add Info. Prepare data /model/additionalInformation/prepare
Add Info. Create/update data /model/additionalInformation/putDb
Add Info. Delete item by ID /api/additionalInformation/deleteItem/{id}