Schemas Postman

Notification. Prepare data POST

prepare data model

# ENDPOINT
/model/notificationTemplate/prepare
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: notificationTemplate
Type: object
Variable Name Type Format Usage Description
action Action string
body_html Body html string
body_text Body text string
code code string Code of a given record
List of allowed values in field (value=>name):
  • 0
    ACCOUNT_BALANCE_CHANGE
  • 1
    DEBIT_MANDATE_ACTIVE
  • 2
    DEBIT_MANDATE_CANCELLED
  • 3
    DEBIT_MANDATE_REJECTED
  • 4
    DEBIT_PAYMENT_ACCEPTED
  • 5
    DEBIT_PAYMENT_DECLINED
  • 6
    DEBIT_PAYMENT_PENDING
  • 7
    PACKAGE_AUTHORIZATION
  • 8
    PAYMENT_CONVERSION_AUTHORIZATION
  • 9
    PAYMENT_CONVERSION_COMPLETE
  • 10
    PAYMENT_CONVERSION_DECLINE
  • 11
    PAYMENT_INTERNAL_AUTHORIZATION
  • 12
    PAYMENT_INTERNAL_COMPLETE
  • 13
    PAYMENT_INTERNAL_DECLINE
  • 14
    PAYMENT_INWARD_COMPLETE
  • 15
    PAYMENT_OUTWARD_AUTHORIZATION
  • 16
    PAYMENT_OUTWARD_COMPLETE
  • 17
    PAYMENT_OUTWARD_CONVERSION_AUTHORIZATION
  • 18
    PAYMENT_OUTWARD_CONVERSION_COMPLETE
  • 19
    PAYMENT_OUTWARD_CONVERSION_DECLINE
  • 20
    PAYMENT_OUTWARD_DECLINE
  • 21
    SECURITY_RESET_PASSWORD
  • 22
    SECURITY_WELLCOME_MAIL
  • 23
    SECURITY_WELLCOME_SMS
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
enabled Enabled boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
footer_template_code Footer template code string
form_title form_title string Service field
header_template_code Header template code string
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
state state integer INT64 Record state for replication
subject subject string Subject
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
view_body_html Body html string
# REQUEST BODY EXAMPLE
							{
            "id": 2,
            "uid": "cc022eb2-2d1f-5c89-7e14-280c5430bef1",
            "version": 1508057306,
            "state": 0,
            "modify_date": "2022-04-05T14:47:20.494",
            "modify_user": "jjakubova",
            "create_date": "2021-04-19T07:39:26.141",
            "create_user": "oizvekovs",
            "enabled": true,
            "code": "ACCOUNT_BALANCE_CHANGE",
            "description": "balance change template",
            "subject": "account balance change",
            "body_text": "Greetings! Don't worry, be happy! Your Account {ACCOUNT} balance changed for {CURRENCY} {AMOUNT} dated {DATE}. Available Account balance {CURRENCY} {AVAILABLE_BALANCE} . Best regards.",
            "header_template_code": "MAIN_HTML_HEADER",
            "footer_template_code": "MAIN_HTML_FOOTER"
        }
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: object
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
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
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: notificationTemplate
Type: object
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
body_html Body html string
body_text Body text string
code code string Code of a given record
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
enabled Enabled boolean
footer_template_code Footer template code string
form_title form_title string Service field
header_template_code Header template code string
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
state state integer INT64 Record state for replication
subject subject string Subject
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
view_body_html Body html string
# RESPONSE POSITIVE EXAMPLE
							{
        "enabled": true,
        "code": "ACCOUNT_BALANCE_CHANGE",
        "description": "balance change template",
        "subject": "account balance change",
        "body_text": "Greetings! Don't worry, be happy! Your Account {ACCOUNT} balance changed for {CURRENCY} {AMOUNT} dated {DATE}. Available Account balance {CURRENCY} {AVAILABLE_BALANCE} . Best regards.",
        "body_html": "
\n
\nGreetings!\n
\n
\nYour Account {ACCOUNT} balance changed for {CURRENCY} {AMOUNT} dated {DATE}. \nAvailable Account balance {CURRENCY} {AVAILABLE_BALANCE} .\n
\n
\nBest regards.\n
\n",
        "header_template_code": "MAIN_HTML_HEADER",
        "footer_template_code": "MAIN_HTML_FOOTER",
        "view_body_html": "
\n
\nGreetings!\n
\n
\nYour Account {ACCOUNT} balance changed for {CURRENCY} {AMOUNT} dated {DATE}. \nAvailable Account balance {CURRENCY} {AVAILABLE_BALANCE} .\n
\n
\nBest regards.\n
\n",
        "id": 2
}
# 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. Prepare data /model/clientMessage/prepare
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. Create/update data /model/notificationTemplate/putDb
Notification. Delete item by ID /api/notificationTemplate/deleteItem/{id}