API Docs. Elcoin Ltd

Package. Sign to be processed in ABS POST

Sign package to be processed in ABS

# ENDPOINT

/api/package/signPackage/packageSignRequest

# RESPONSE

# REQUEST BODY

Schema: packageSignRequest

Type: object

Variable	Name	Type	Format	Description
checksum	checksum	string		Checksum
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
id	id	integer	INT64	Record's sequence number generated in the system.
processing_date	Processing date	string
sync_processing	Sync processing	integer

# REQUEST BODY EXAMPLE

							{
    "client_code": "EN00000CY",
    "id": "21362",
    "checksum"        : "",
    "processing_date" : "",     
    "sync_processing" : "0"
}

# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError

Type: object

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

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: packageSignResponseModel

Type: object

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
accepted_application_count	Accepted application count	INTEGER
action	Action	string
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
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
ignored_application_count	Ignored application count	INTEGER
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
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.package.packageSignResponseModel",
    "total_records": 1,
    "data": {
        "ignored_application_id_list": [
            5153
        ],
        "ignored_application_count": 1,
        "accepted_application_id_list": [],
        "accepted_application_count": 0,
        "application_processing_errors": null,
        "uid": "",
        "id": 0,
        "version": 0,
        "state": 0,
        "create_user": "",
        "create_date": null,
        "modify_user": "",
        "modify_date": null
    }
}

# Other endpoints

Name	Endpoint
Package. Create / Update	/model/package/putDb
Package. Create for applications and payment drafts	/api/package/createPackage/packageSignRequest
Package. Remove Application	/api/package/removeApplication/packageApplicationsSearchRequest
Package. Add application	/api/package/addApplication/packageApplicationsSearchRequest
Package. Empty for applications and payment drafts	/api/package/emptyPackage/packageSearchRequest
Package. Set Processing Status Step	/api/package/setProcessingStatusStep/packageSearchRequest
Package. Delete Package	/api/package/deletePackage/packageSearchRequest
Package. Clone Package	/api/package/clonePackage/packageCloneRequest
Package. Fetch data by request	/api/package/getData/packageSearchRequest
Package. Fetch detailed data by request	/api/package/getData/packageDetailedSearchRequest
Package. Authorize by representative	/api/package/authorizeByRepresentative/packageSignRequest