Schemas Postman

Country. Prepare data POST

Prepare Country data

# ENDPOINT
/model/country/prepare
# 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: country
Type: object
Variable Name Type Format Usage Description
action Action string
alpha3_code alpha3_code string ISO Alpha-3 code of a given country
country_code country_code string M Two-letter ISO 3166-2 code of a given country
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
description description string Description of a given record
form_title form_title string Service field
id id integer INT64 M 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
numeric_code numeric_code integer INTEGER ISO numeric code of a given country
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
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

<p style="color:green;font-size:16px;">200 - Response successfully when status is OK</p>

Schema: country
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 data of Response
attribute: data
Variable Name Type Format Description
action Action string
alpha3_code alpha3_code string ISO Alpha-3 code of a given country
country_code country_code string Two-letter ISO 3166-2 code of a given country
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
description description string Description of a given record
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
numeric_code numeric_code integer INTEGER ISO numeric code of a given country
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

<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>

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
Country. Fetch data by request /api/country/getData/countrySearchRequest
Country. Fetch data by ID /model/country/getDb/{id}
Country. Validate data /model/country/validate
Country. Create/update data /model/country/putDb
Country. Delete item by ID /api/country/deleteItem/{id}