API Docs. Elcoin Ltd

Subscription. Fetch data by request POST

Get Subscription data by request

# ENDPOINT

/api/subscription/getData/subscriptionSearchRequest

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0	DEV-SKIP	DEV-SKIP	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
Example	DEV-SKIP

# REQUEST BODY

Schema: subscriptionSearchRequest

Type: object

Variable	Name	Type	Description
code	code	string	Code of a given record
description	description	string	Description of a given record
entity_type	entity_type	string	Customer type List of allowed values in field (value=>name): 0 BUSINESS 1 PERSON
subscription_status	Subscription Status	string	Subscription status List of allowed values in field (value=>name): 0 active 1 closed 2 disabled

# REQUEST BODY EXAMPLE

							{
    "entity_type": "PERSON"
}

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: subscription

Type: application/json

Variable	Name	Type	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
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

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 3,
    "data": [
        {
            "id": 6,
            "uid": "",
            "version": 631085536,
            "state": 0,
            "modify_date": "2021-01-22T13:59:06.222",
            "modify_user": "jsokol",
            "create_date": "2020-04-08T19:47:51.805",
            "create_user": "root",
            "code": "PREMIUM",
            "description": "PREMIUM FOR INDIVIDUALS",
            "subscription_status": "ACTIVE",
            "entity_type": "PERSON",
            "is_default": false
        },
        {
            "id": 10,
            "uid": "84e8d8c6-924c-678b-7114-c6691cfde3a7",
            "version": 455597899,
            "state": 0,
            "modify_date": "2020-09-25T12:27:08.222",
            "modify_user": "skuzema",
            "create_date": "2020-09-25T12:27:08.221",
            "create_user": "skuzema",
            "code": "RB_BASIC",
            "description": "RB Basic for individuals",
            "subscription_status": "ACTIVE",
            "entity_type": "PERSON",
            "is_default": false
        },
        {
            "id": 11,
            "uid": "ac841b88-fd54-7399-7114-c6983859733f",
            "version": 631085566,
            "state": 0,
            "modify_date": "2021-01-22T13:59:06.287",
            "modify_user": "jsokol",
            "create_date": "2020-09-28T12:13:25.390",
            "create_user": "jjakubova",
            "code": "RAILSBANKFIZ",
            "description": "RAILSBANK TEST FIZ",
            "subscription_status": "ACTIVE",
            "entity_type": "PERSON",
            "is_default": true
        }
    ]
}

# 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	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 / UID	/model/subscription/getDb/{id}
Subscription. Validate data	/model/subscription/validate
Subscription. Prepare data	/model/subscription/prepare
Subscription. Create/update data	/model/subscription/putDb
Subscription. Delete item by ID	/api/subscription/deleteItem/{id}