Schemas Postman

Package. Empty for applications and payment drafts POST

# ENDPOINT
/api/package/emptyPackage/packageSearchRequest
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: packageSearchRequest
Type: object
Variable Name Type Format Usage Description
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
date_from date_from string DATE The period of dates for which you need to receive an extract - date From
date_to date_to string DATE The period of dates for which you need to receive an extract - date To
delete_applications Delete applications integer
id id integer INT64 Record's sequence number generated in the system.
ignore_with_single_application Ignore with single application integer
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
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
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
with_min_application_count With min application count integer
# REQUEST BODY EXAMPLE
							{
    "client_code": "EN0000FRM",
    "id": "21364",
    "delete_applications"  : "0"
}
# 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: HeaderResponseStatusOk
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
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}
# 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. 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