Schemas Postman

Message. Prepare data POST

prepare data model

# ENDPOINT
/model/clientMessage/prepare
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: clientMessage
Type: object
Variable Name Type Format Usage Description
action Action string
allocation Allocation string
attachments attachments string Attachments
body body string Body
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
delivery_date delivery_date string DATETIME Delivery date
direction direction string Direction
List of allowed values in field (value=>name):
  • 0
    A2A
  • 1
    A2C
  • 2
    C2A
  • 3
    C2C
error_description Error Description string Description of error
expires expires string Expires
form_title form_title string Service field
from_client_code from_client_code string From client code
from_country_calling_code from_country_calling_code string From country calling code
from_mail from_mail string From mail
from_name from_name string From name
from_phone from_phone string From phone
from_url from_url string From url
id id integer INT64 Record's sequence number generated in the system.
importance importance string Importance
List of allowed values in field (value=>name):
  • 0
    Nothing
  • 1
    URGENT
language language string The language user has specified as the language of service
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
processing_response processing_response string Processing response
processing_status Processing Status string Status of remote client data processing received from the external system
protocol protocol string Protocol
List of allowed values in field (value=>name):
  • 0
    AUTO
  • 1
    email
  • 2
    http
  • 3
    ib
  • 4
    mobile_application
  • 5
    phone
  • 6
    stomp
  • 7
    totp
provider provider string Provider
read_status read_status string Read status
reference_model Reference model string
reference_type reference_type string Reference type
reference_value Reference value string
reply_message_id Reply message id integer
send_date send_date string DATETIME Send date
state state integer INT64 Record state for replication
subject subject string Subject
template_id template_id integer INT64 Template id
to_client_code to_client_code string To client code
to_country_calling_code to_country_calling_code string To country calling code
to_mail to_mail string To mail
to_mail_cc to_mail_cc string To mail cc
to_name to_name string To name
to_phone to_phone string To phone
to_url to_url string To url
uid uid string Unique record identifier which is used to distinguish between existing records
UrlEndpoint UrlEndpoint string UrlEndpoint
version version integer INT64 Record version for replication
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

200 - Response successfully when status is OK

Schema: clientMessage
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
allocation Allocation string
attachments attachments string Attachments
body body string Body
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
delivery_date delivery_date string DATETIME Delivery date
direction direction string Direction
error_description Error Description string Description of error
expires expires string Expires
form_title form_title string Service field
from_client_code from_client_code string From client code
from_country_calling_code from_country_calling_code string From country calling code
from_mail from_mail string From mail
from_name from_name string From name
from_phone from_phone string From phone
from_url from_url string From url
id id integer INT64 Record's sequence number generated in the system.
importance importance string Importance
language language string The language user has specified as the language of service
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
processing_response processing_response string Processing response
processing_status Processing Status string Status of remote client data processing received from the external system
protocol protocol string Protocol
provider provider string Provider
read_status read_status string Read status
reference_model Reference model string
reference_type reference_type string Reference type
reference_value Reference value string
reply_message_id Reply message id integer
send_date send_date string DATETIME Send date
state state integer INT64 Record state for replication
subject subject string Subject
template_id template_id integer INT64 Template id
to_client_code to_client_code string To client code
to_country_calling_code to_country_calling_code string To country calling code
to_mail to_mail string To mail
to_mail_cc to_mail_cc string To mail cc
to_name to_name string To name
to_phone to_phone string To phone
to_url to_url string To url
uid uid string Unique record identifier which is used to distinguish between existing records
UrlEndpoint UrlEndpoint string UrlEndpoint
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

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
Message. Fetch data by request /api/clientMessage/getData/clientMessageSearchRequest
Message. Fetch data by ID /model/clientMessage/getDb/{id}
Message. Validate data /model/clientMessage/validate
Message. Create/update data /model/clientMessage/putDb
Message. Delete item by ID /api/clientMessage/deleteItem/{id}
Notification. Fetch data by request /api/notificationTemplate/getData/notificationTemplateSearchRequest
Notification. Fetch data by ID /model/notificationTemplate/getDb/{id}
Notification. Validate data /model/notificationTemplate/validate
Notification. Prepare data /model/notificationTemplate/prepare
Notification. Create/update data /model/notificationTemplate/putDb
Notification. Delete item by ID /api/notificationTemplate/deleteItem/{id}