API Docs. Elcoin Ltd

Subscription. Fetch data by ID / UID POST

Fetch Subscription data by ID or UID

# ENDPOINT

/model/subscription/getDb/{id}

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0	DEV-SKIP	DEV-SKIP	M	Dev Authentication
id path 0		13 - by ID bb8fc2c1-3291-d8aa-7514-caf7f0e8f1bb - by UID	M	Record ID or UID

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M	Dev Authentication
Example	DEV-SKIP
id	id	path	integer	M	Record ID or UID
Example	13 - by ID bb8fc2c1-3291-d8aa-7514-caf7f0e8f1bb - by UID

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

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "system.api.subscription.subscriptionModel",
    "total_records": 1,
    "data": {
        "code": "Test",
        "description": "TEST SUBSCRIPTION",
        "subscription_status": "closed",
        "entity_type": "BUSINESS",
        "client_group": "",
        "is_default": false,
        "uid": "bb8fc2c1-3291-d8aa-7514-caf7f0e8f1bb",
        "id": 13,
        "version": 488747577,
        "create_user": "smalcheva",
        "create_date": "2020-12-08T16:03:12.711",
        "modify_date": "2020-12-08T17:05:13.981"
    }
}

# 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": "[RECORD-NOT-FOUND : Object subscriptionModel cannot find record subscription.id with value 130]",
    "error": {},
    "data_type": "system.api.subscription.subscriptionModel",
    "total_records": 1,
    "data": {}
}

# Other endpoints

Name	Endpoint
Subscription. Fetch data by request	/api/subscription/getData/subscriptionSearchRequest
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}