Contact. Fetch data by request POST

Get Contact data by request

# ENDPOINT
/api/contact/getData/contactSearchRequest
# 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: contactSearchRequest
Type: object
Variable Name Type Format Usage Description
client_code client_code string Unique customer ID in external system
contact_type contact_type string Type of contact data
List of allowed values in field (value=>name):
  • 0
    email
  • 1
    phone
  • 2
    skype
  • 3
    website
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
description description string Description of a given record
# REQUEST BODY EXAMPLE
													
# 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 array data of Response
attribute: data
Variable Name Type Format Description
action Action string
client_code client_code string Unique customer ID in external system
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": "",
    "total_records": 2,
    "data": [
        {
            "id": 848,
            "uid": "dad6034b-8e0c-deae-7f14-a697f8b3a168",
            "version": 835373641,
            "state": 0,
            "modify_date": "2021-05-11T11:39:11.198",
            "modify_user": "root",
            "create_date": "2021-05-11T11:36:35.851",
            "create_user": "root",
            "client_code": "EN0000C7K",
            "counterparty_id": 924,
            "contact_type": "Phone",
            "contact_value": "+1 646 266 2535",
            "country_calling_code": "+1",
            "description": "",
            "use_device_for_login": true,
            "representative_type": "OWNER"
        },
        {
            "id": 849,
            "uid": "dad6034b-8e0c-deae-7f14-a69730d9ee68",
            "version": 835373298,
            "state": 0,
            "modify_date": "2021-05-11T11:36:38.957",
            "modify_user": "root",
            "create_date": "2021-05-11T11:36:35.875",
            "create_user": "root",
            "client_code": "EN0000C7K",
            "counterparty_id": 924,
            "contact_type": "Email",
            "contact_value": "pixopi6143@firmjam.com",
            "country_calling_code": "",
            "description": "",
            "use_device_for_login": true,
            "representative_type": "OWNER"
        }
    ]
}						
# 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": "[INVALID-SIGNATURE : Request signature is incorrect. invalid-authorization-token]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}