Schemas Postman

Subscription. Fetch data by request POST

Get Client Subscription data by request

# ENDPOINT
/api/clientSubscription/getData/clientSubscriptionSearchRequest
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: clientSubscriptionSearchRequest
Type: object
Variable Name Type Format Usage Description
activation_date Activation Date string DATE Activation date in the system
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
expiration_date Expiration Date string DATE Expiration date in the system
show_expired Show expired boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
subscription_code Subscription Code string Subscription code
# 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: clientSubscription
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
activation_date Activation Date string DATE Activation date in the system
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
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
expiration_date Expiration Date string DATE Expiration date in the system
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
state state integer INT64 Record state for replication
subscription_code Subscription Code string Subscription code
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 ID /model/clientSubscription/getDb/{id}
Subscription. Validate data /model/clientSubscription/validate
Subscription. Prepare data /model/clientSubscription/prepare
Subscription. Create/update data /model/clientSubscription/putDb
Subscription. Delete item by ID /api/clientSubscription/deleteItem/{id}