🎒Batch Methods

SIGNIUS Sealing Server REST API batch methods

Batch methods are used to start the process of signing, upload files, which are meant to be signed, download signed files and delete the batch from the cache.

A batch is a package that contains files for sign or validation. The package format is ZIP (without directories).

Create new batch

POST /api/CreateBatch/{processId}

Method is used to create new batch with an assigned processId.

Path Parameters

Name	Type	Description
processId	Integer	required

Response

201: Created Batch created successfully

Example response:

{
    "id": “2123”,
    "providerSettingsId": “1”,
    "creationDate": "2023-01-01 12:00:00",
    "status": “1”
}

400: Bad Request The {processID} value is not valid

404: Not Found Not found

Upload package (ZIP)

POST /api/upload/{batchId}

Method is used to upload a file to the batch. The Batch Id value generated and returned during the CreateBatch operation. The contents of the zip file should be sent as a binary octet stream (https://www.iana.org/assignments/media-types/application/octet-stream)

Path Parameters

Name	Type	Description
batchId	Integer	required

Request Body

Name	Type	Description
<binary-octet-stream>	<binary-octet-stream>

Response

202: Accepted File was accepted

Example response:

{
    "id": "1”,
    "counterpartyId": “1”,
    "name": "file_name.pdf",
    "signed": "false”,
    "hash": null,
    "signature": null,
    "batchId": 2123,
    "creationDate": "2023-01-01 00:00:00",
    "isZip": "true”,
    "tsaId": “1”
}

204: No Content No content

404: Not Found Not found

Get batch status

GET /api/BatchStatus/{batchId}

Use this method to get an information about the status of the batch. Possible statuses below.

Path Parameters

Name	Type	Description
batchId	Integer	required

Response

200: OK Status is presented (OK)

Example response:

{
    "id":2123,
    "status": "READY",
    "creationDate": "2023-01-01 10:00:00",
    "documents": [
        {
            "id": "1”,
            "signed": "false”,
            "fileName": "test.pdf",
            "signingResult_Success": "false"
        }
    ]
}

404: Not Found Not found

500: Internal Server Error Internal server error

Possible statuses

Id	Value	Description
0	NEW	New batch successfully created
1	UPLOADED	Zip package successfully received
2	ACCEPTED	Batch successfully created
3	READY	For internal use (awaiting processing)
4	IN_PROGRESS	Signing/stamping process in progress
5	FINISHING	For internal use
6	CLOSED	Batch closed, ready for download
7	DELETED	Batch romoved from cache

Accept batch

POST /api/AcceptBatch

This method accepts batch, starts the signature/validation process

Path Parameters

Name	Type	Description
batchId	Integer	required

202: Accepted Batch is accepted

Example response:

{
    "id": 2123,
    "providerSettingsId": “1”,
    "creationDate": "2023-01-01 10:00:00",
    "status": “0”
}

404: Not Found Not found. BatchId not found

Download signed batch

GET /api/batchfile/{batchId}

This method provides a signed package for download

Path Parameters

Name	Type	Description
batchId	Integer	required

200: OK File is available to download (OK)

<binary-octet-stream>

404: Not Found Not found

500: Internal Server Error Internal server error

Delete batch from the cache

DELETE /api/BatchDeleteCache/{batchId}

This method removes the batch from the cache on the server side

Path Parameters

Name	Type	Description
batchId	Integer	required

200: OK Batch is deleted (OK)

Example response:

{
    "id":2123,
    "status": "DELETED",
    "creationDate": "2023-01-01 10:00:00",
    "documents": [<“array of documents”>]
}

404: Not Found Not found