Document routing endpoints provision the ability to send documents to Filer and to check in on its processing status.
1.1.1 RouteDocumentsOperation
Receives a routing request body that contains information on the entity, document(s) and metadata. The document is represented as base 64. As part of the routing operation the object will be added to the queue where it will be picked up by the azure function for processing.
POST: /api/external/routing/routedocumentsoperation
Example Request Body:
{
"entityPrimaryId": "string",
"entitySecondaryId": "string",
"configurationId": 0,
"routingUsername": "string",
"routingDocuments": [
{
"fileName": "string",
"fileExtension": "string",
"documentTitle": "string",
"documentType": "string",
"document": "string",
"convertToPdf": true,
"accessType": "string",
"contentType": "string",
"routingDocumentMetaData": [
{
"key": "string",
"value": "string",
"dataType": "string",
}
]
]
}
202
The HTTP status code 202 Accepted indicates that the server has successfully received and accepted the request but has not yet completed processing it. This means the request has been acknowledged and added to a queue for further processing.
202
{
"httpStatusCode": 0,
"errors": [
"string"
],
"primaryIdentifier": "string",
"signalRConnectionId": "string",
"operationGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"routingOperationType": 1,
"operationStatus": 0,
"statusDescription": "string",
"routingOperationDocuments": [
{
"routingOperationDocumentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"routingOperationGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"operationStatus": 0,
"statusDescription": "string",
"errorReason": "string",
"created": "2024-12-02T10:49:33.857Z",
"modified": "2024-12-02T10:49:33.857Z",
"recordUrl": "string",
"fileName": "string",
"sentToTriage": true
}
]
}
400 Bad Request A 400 error will be presented in the status code and errors will be returned
500 Server Error A 500 error will be presented in the status code and errors will be returned
1.1.2 RoutingOperationBlockReceiver
ROB (Routing Operation Blocks) allowed the system to receive blocks of base64, so it can handle larger documents. To use this feature please consult with the Encodian Filer Team for guidance. In additional to guidance code sample can be provided
POST: /api/external/routing/routingoperationblockreceiver
{
"routingOperationBlockInfo": {
"routingOperationGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentIndex": 0,
"blockOrder": 0
},
"base64Block": "string",
"isLast": true
}
202
The HTTP status code 202 Accepted indicates that the server has successfully received and accepted the request but has not yet completed processing it. This means the request has been acknowledged and added to a queue for further processing.
{
"httpStatusCode": 0
"errors": [
"string"
],
"success": true
}
400 Bad Request A 400 error will be presented in the status code and errors will be returned
500 Server Error A 500 error will be presented in the status code and errors will be returned
1.1.3 AddToAzureStorageQueue
When using ROB and when all parts of the document have been received then the operation will need to be added to the queue separately. To use this feature please consult with the Encodian Filer Team for guidance. In additional to guidance code sample can be provided
POST: /api/external/routing/addtoazurestorage
{
"organisationId": 0,
"dataRouting": {
"routingOperationGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}
}
200 Success
{
"httpStatusCode": 0,
"errors": [
"string "
]
}
400 Bad Request A 400 error will be presented in the status code and errors will be returned
500 Server Error A 500 error will be presented in the status code and errors will be returned
1.1.4 CheckRouteDocumentsOperationProcess
Routing is an asynchronous process that is handled by a backend azure function. Using this check, you can get a response on what’s happening with the documents you’re sending into Filer
GET: /api/external/routing/checkroutedocumentsoperationprocess/{operationId}
200 Success
{
"httpStatusCode": 0,
"errors": [
"string"
],
"primaryIdentifier": "string",
"signalRConnectionId": "string",
"operationGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"routingOperationType": 1,
"operationStatus": 0,
"statusDescription": "string",
"routingOperationDocuments": [
{
"routingOperationDocumentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"routingOperationGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"operationStatus": 0,
"statusDescription": "string",
"errorReason": "string",
"created": "2024-12-02T10:49:33.857Z"
"modified": "2024-12-02T10:49:33.857Z"
"recordUrl": "string",
"fileName": "string"
}
]
}
400 Bad Request A 400 error will be presented in the status code and errors will be returned
500 Server Error A 500 error will be presented in the status code and errors will be returned