API Docs. Elcoin Ltd

Product. Fetch data by request POST

Get Product data by request

# ENDPOINT

/api/product/getData/productSearchRequest

# 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: productSearchRequest

Type: object

Variable	Name	Type	Format	Description
code	code	string		Code of a given record
description	description	string		Description of a given record
id	id	integer	INT64	Record's sequence number generated in the system.
limit	limit	integer	int64	Count records for part data to get
offset_version	Offset version	INTEGER
offsetid	Offsetid	integer
page	page	integer	int64	Part data with number of page
page_changes_version_offset	Page changes version offset	INTEGER
parent_id	Parent ID	integer	INT64	Parent record ID of a given record
product_category	Product Category	string		Category of a given product
product_status	Product Status	string		Status of a given product List of allowed values in field (value=>name): 0 ACTIVE 1 INACTIVE
product_type	Product Type	string		Type of a given product
skip_total_records	Skip total records	boolean		List of allowed values in field (value=>name): 0 false 1 true
top_parent_id	Top parent id	INTEGER

# REQUEST BODY EXAMPLE

							{
    "product_status": "ACTIVE"    
}

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: product

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
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
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
parent_id	Parent ID	integer	INT64	Parent record ID of a given record
product_category	Product Category	string		Category of a given product
product_status	Product Status	string		Status of a given product
product_type	Product Type	string		Type of a given product
state	state	integer	INT64	Record state for replication
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": 4,
    "data": [
        {
            "id": 6,
            "uid": "",
            "version": 378361575,
            "state": 0,
            "modify_date": "2020-04-21T11:18:09.438",
            "modify_user": "jsokol",
            "create_date": "2019-02-18T22:59:38.952",
            "create_user": "user",
            "code": "120000",
            "description": "PAYMENTS",
            "parent_id": 0,
            "product_status": "active",
            "product_type": "menu",
            "product_category": "product",
            "fieldSub": "",
            "action": ""
        },
        {
            "id": 7,
            "uid": "",
            "version": 378361636,
            "state": 0,
            "modify_date": "2020-04-21T11:18:25.082",
            "modify_user": "jsokol",
            "create_date": "2019-02-18T23:02:03.819",
            "create_user": "user",
            "code": "130000",
            "description": "CURRENCY EXCHANGE",
            "parent_id": 0,
            "product_status": "active",
            "product_type": "menu",
            "product_category": "product",
            "fieldSub": "",
            "action": ""
        },
        {
            "id": 12,
            "uid": "",
            "version": 378363573,
            "state": 0,
            "modify_date": "2020-04-21T11:27:07.356",
            "modify_user": "jsokol",
            "create_date": "2020-04-08T11:15:40.463",
            "create_user": "jsokol",
            "code": "150000",
            "description": "ACCOUNT MANAGEMENT",
            "parent_id": 0,
            "product_status": "ACTIVE",
            "product_type": "menu",
            "product_category": "product",
            "fieldSub": "",
            "action": ""
        },
        {
            "id": 18,
            "uid": "",
            "version": 378364042,
            "state": 0,
            "modify_date": "2020-04-21T11:29:13.494",
            "modify_user": "jsokol",
            "create_date": "2020-04-08T14:11:32.883",
            "create_user": "jsokol",
            "code": "170000",
            "description": "NOTIFICATION MANAGEMENT",
            "parent_id": 0,
            "product_status": "ACTIVE",
            "product_type": "menu",
            "product_category": "product",
            "fieldSub": "",
            "action": ""
        }
    ]
}

# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

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

# RESPONSE NEGATIVE EXAMPLE

							{
    "status": "error",
    "error_description": "ERROR-DESERIALIZE: ** Decimal number is too large. (536)",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

# Other endpoints

Name	Endpoint
Product. Fetch data by ID / UID	/model/product/getDb/{id}
Product. Validate data	/model/product/validate
Product. Prepare data	/model/product/prepare
Product. Create/update data	/model/product/putDb
Product. Delete item by ID	/api/product/deleteItem/{id}