Schemas Postman

Contact. Fetch data by ID POST

Fetch Contact data by ID

# ENDPOINT
/api/contact/getDb/{id}
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
id
path
0 		M Id record
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
id id path integer M Id record
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: contact
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
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
contact_type contact_type string Type of contact data
contact_value contact_value string Data by type of contact
counterparty_id counterparty_id integer INT64 Counterparty id
country_calling_code country_calling_code string Calling code of 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
representative_type representative_type string
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
use_device_for_login Use device for login BOOLEAN
version version integer INT64 Record version for replication
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "system.api.contact.contactModel",
    "total_records": 1,
    "data": {
        "client_code": "EN0001Y4D",
        "counterparty_id": 3454,
        "contact_type": "Email",
        "representative_type": "OWNER",
        "contact_value": "xolelor982@pyrelle.com",
        "country_calling_code": "",
        "description": "",
        "use_device_for_login": true,
        "uid": "ff042690-29d0-4ba1-8d14-49605055603c",
        "id": 2206,
        "version": 1261204619,
        "state": 0,
        "create_user": "ib/EN0001Y3J/EN0001Y3J",
        "create_date": "2021-12-21T23:11:17.650",
        "modify_user": "root",
        "modify_date": "2021-12-21T23:11:19.764"
    }
}
# 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
# RESPONSE NEGATIVE EXAMPLE
							{
    "status": "error",
    "error_description": "[RECORD-NOT-FOUND : Object clientModel cannot find record client.uid with value ba85a7e5-0f1d-d4b7-7b141-007bf05b8fdd]",
    "error": {},
    "data_type": "system.api.clients.clientModel",
    "total_records": 1,
    "data": {}
}
# Other endpoints
Name Endpoint
Contact. Fetch data by request /api/contact/getData/contactSearchRequest
Contact. Validate data /model/contact/validate
Contact. Prepare data /model/contact/prepare
Contact. Create/update data /model/contact/putDb
Contact. Delete item by ID /api/contact/deleteItem/{id}