Schemas Postman

Package. Create / Update POST

# ENDPOINT
/model/package/putDb
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: package
Type: object
Variable Name Type Format Usage Description
action Action string
checksum checksum string Checksum
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
error_description Error Description string Description of error
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
oauth_access_token Oauth access token string
payment_import_initiation_id Payment import initiation id integer
processing_date Processing date string
processing_status Processing Status string Status of remote client data processing received from the external system
processing_step Processing step string Step of remote client data processing received from the external system
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
# REQUEST BODY EXAMPLE
							{
"client_code"        : "EN0000FRM",
"oauth_access_token" : "",
"processing_date"    : "2021-10-30",
"processing_status"  : "",
"processing_step"    : ""
}
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: object
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
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: package
Type: object
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 data of Response
attribute: data
Variable Name Type Format Description
action Action string
checksum checksum string Checksum
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
error_description Error Description string Description of error
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
oauth_access_token Oauth access token string
payment_import_initiation_id Payment import initiation id integer
processing_date Processing date string
processing_status Processing Status string Status of remote client data processing received from the external system
processing_step Processing step string Step of remote client data processing received from the external system
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.packageModel",
    "total_records": 1,
    "data": {
        "client_code": "EN0000FRM",
        "oauth_access_token": "",
        "processing_date": "2021-10-30",
        "processing_status": "NEW",
        "processing_step": "NORMAL",
        "error_description": "",
        "checksum": "020040z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==",
        "payment_import_initiation_id": 0,
        "uid": "c8c2ef1d-8274-b7b6-8c14-fb3c50c262a8",
        "id": 21854,
        "version": 1183940751,
        "state": 0,
        "create_user": "root",
        "create_date": "2021-12-03T10:20:22.255",
        "modify_user": "root",
        "modify_date": "2021-12-03T10:20:22.286"
    }
}
# Other endpoints
Name Endpoint
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. Sign to be processed in ABS /api/package/signPackage/packageSignRequest
Package. Authorize by representative /api/package/authorizeByRepresentative/packageSignRequest