Schemas Postman

Contact. Prepare data POST

Prepare Contact data

# ENDPOINT
/model/contact/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: contact
Type: object
Variable Name Type Format Usage 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 M 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 M Data by type of contact
counterparty_id counterparty_id integer INT64 M 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 M
List of allowed values in field (value=>name):
  • 0
    OFFICE
  • 1
    OWNER
  • 2
    REPRESENTATIVE
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
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
version version integer INT64 Record version for replication
# 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 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
# 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
Contact. Fetch data by request /api/contact/getData/contactSearchRequest
Contact. Fetch data by ID /api/contact/getDb/{id}
Contact. Validate data /model/contact/validate
Contact. Create/update data /model/contact/putDb
Contact. Delete item by ID /api/contact/deleteItem/{id}