API Docs / Schemas / DocumentUploadResultDto

DocumentUploadResultDto

The outcome of uploading a single file within a batch upload.

Properties

Name Type Description
fileNamestring

The original file name, so the caller can match this result to the file it sent.

The original file name, so the caller can match this result to the file it sent.

successboolean

Whether the file was stored successfully.

Whether the file was stored successfully.

documentClientDocumentDto
errorstring

A message explaining why the upload failed. Null when it succeeded.

A message explaining why the upload failed. Null when it succeeded.

JSON Example

{
  "fileName": "string",
  "success": false,
  "document": {
    "code": "string",
    "client": "...",
    "category": "...",
    "title": "string",
    "summary": "string"
  },
  "error": "string"
}

Contained in Schemas