Schemas Postman

Subscription. Create/update data POST

Create/update Subscription data

# ENDPOINT
/model/subscription/putDb
# 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: subscription
Type: object
Variable Name Type Format Usage Description
action Action string
client_group client_group string M Client group
List of allowed values in field (value=>name):
  • 0
    AGENT
  • 1
    APPLICANT
  • 2
    BENEFICIARY
  • 3
    BRANCH
  • 4
    CHALLENGER
  • 5
    CLIENT
  • 6
    CLIENT
  • 7
    COMPANY
  • 8
    CONTACT
  • 9
    COUNTERPARTY
  • 10
    EMPLOYEE
  • 11
    PROVIDER
  • 12
    PSP
  • 13
    RECIPIENT
  • 14
    REGULATOR
  • 15
    RELATED_PERSON
  • 16
    SUPPLIER
  • 17
    USER
code code string M 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 M Description of a given record
division_client_code Division client code string
entity_type entity_type string M Customer type
List of allowed values in field (value=>name):
  • 0
    BUSINESS
  • 1
    PERSON
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
is_default Default boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
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
subscription_status Subscription Status string M Subscription status
List of allowed values in field (value=>name):
  • 0
    active
  • 1
    closed
  • 2
    disabled
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

<p style="color:green;font-size:16px;">200 - Response successfully when status is OK</p>

Schema: subscription
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_group client_group string Client group
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
division_client_code Division client code string
entity_type entity_type string Customer type
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
is_default Default boolean
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
subscription_status Subscription Status string Subscription status
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>

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
Subscription. Fetch data by request /api/subscription/getData/subscriptionSearchRequest
Subscription. Fetch data by ID / UID /model/subscription/getDb/{id}
Subscription. Validate data /model/subscription/validate
Subscription. Prepare data /model/subscription/prepare
Subscription. Delete item by ID /api/subscription/deleteItem/{id}