Messaggi d'errore generici

Di seguito sono illustrati i messaggi di errore generici, applicabili a diverse chiamate.

Altri messaggi di errore specifici per le singole API sono riportati nella descrizione delle singole funzioni

Sono indicati lo stato di ritorno, il dettaglio della struttura dati e una spiegazione

BAD_ALIAS_OR_PIN

401 Unauthorized
{
    "status" : "BAD_ALIAS_OR_PIN",
    "comment" : "Bad alias or pin"
}

Indica un errore nell’autenticazione per l’uso della firma digitale del cliente

BAD_INTERFACE_CODE_PASSWORD

403 Forbidden
{
    "status": "BAD_INTERFACE_CODE_PASSWORD",
    "comment": "Bad Interface Code/Password"
}

Indica un errore nell’autenticazione all’uso del back-end

BACKEND_SERVER_ERROR

503 Service Unavailable
{
    "status": "BACKEND_SERVER_ERROR",
    "backend_message": <HUMAN_READABLE_MESSAGE>,
    "comment": 'Backend server error: <HUMAN_READABLE_MESSAGE>'
}

Indica un errore non previsto nel server

DOCUMENT_ALREADY_EXISTS

422 Unprocessable Entity
{
    "status" : "DOCUMENT_ALREADY_EXISTS",
    "comment" : "Document Already Exists",
    "document_id" : DOCUMENT_ID,
    "spool_filename" : spool_file,
    "document_filename" : filename,
    "label" : label
}

Il documento di cui si sta cercando di fare l’upload esiste già

DOCUMENT_DELETED

404 Not Found
{
    "status": "DOCUMENT_DELETED",
    "comment": "Document deleted"
}

Il documento è già stato cancellato

DOCUMENT_NOT_VISIBLE_TO_USER

403 Forbidden
{
    "status": "DOCUMENT_NOT_VISIBLE_TO_USER",
    "comment": "Document not visible to user"
}

Il filtro definito non rende visibile all’utente il documento richiesto

DOCUMENT_NOT_ARCHIVED_DUE_TO_ERROR

422 Unprocessable Entity
{
    "status" : "DOCUMENT_NOT_ARCHIVED_DUE_TO_ERROR",
    "comment" : "An error occurred during document archiving"
}

Un errore applicativo ha impedito l’archiviazione del documento

DOCUMENT_NOT_FOUND

404 Not Found
{
    "status": "DOCUMENT_NOT_FOUND",
    "comment": "Document not found"
}

Il documento richiesto non esiste

DOCUMENT_NOT_YET_ARCHIVED

409 Conflict
{
    "status": "DOCUMENT_NOT_YET_ARCHIVED",
    "comment": "Document not yet archived"
}

Il documento richiesto non è stato ancora archiviato

DOCUMENT_OVERWRITTEN

404 Not Found
{
    "status": "DOCUMENT_OVERWRITTEN",
    "document_id": <DOCUMENT_ID>,
    "comment": "Document Overwritten by '<DOCUMENT_ID>'"
}

Il documento richiesto è stato sovrascritto

DOCUMENT_TYPE_NOT_FOUND

404 Not Found
{
    "status": "DOCUMENT_TYPE_NOT_FOUND",
    "comment": "Document Type not found"
}

Il tipo di documento richiesto non esiste per l’organizzazione indicata

INVALID_MIME_TYPE

422 Unprocessable Entity
{
    "status" : "INVALID_MIME_TYPE",
    "comment" : "Invalid MIME type"
    "mime_type" : GUESSED MIME TYPE
}

Il MIME Type del documento non è supportato dal sistema

LOT_NOT_FOUND

404 Not Found
{
    "status": "LOT_NOT_FOUND",
    "comment": "Lot not found"
}

Il lotto richiesto non è stato trovato

NOT_ADMINISTRATOR_FOR_INTERFACE

403 Forbidden
{
    "status": "NOT_ADMINISTRATOR_FOR_INTERFACE",
    "comment": "User isn't an administrator for any 
    organizations of the interface"
}

L’utente non possiede i diritti di amministrazione del back-end per alcuna organizzazione

NOT_ADMINISTRATOR_IN_ORGANIZATION

403 Forbidden
{
   "status" : "NOT_ADMINISTRATOR_IN_ORGANIZATION",
   "comment" : "User isn't a Administrator for the Organization"
}

L’utente non possiede i diritti di amministrazione per l’organizzazione

ORGANIZATION_NOT_FOUND

404 Not Found
{
   "status" : "ORGANIZATION_NOT_FOUND",
   "comment" : "Organization doesn't exists or it's 
    unavailable for this Interface"
}

L’organizzazione non esiste o non è disponibile per l’interfaccia specificata

REQUEST_BODY_TOO_LONG

413 Request Entity Too Large
{
    "status" : "REQUEST_BODY_TOO_LONG",
    "comment" : "Request body is too long"
}

Il contenuto del file è più grande del massimo accettato, che al momento è 63MB

REQUIRED_CAPABILITY_NOT_AVAILABLE

403 Forbidden
{
    "status": "REQUIRED_CAPABILITY_NOT_AVAILABLE",
    "required_capabilities": [ <REQUIRED_CAPABILITIES> ],
    "available_capabilities": [ <AVAILABLE_CAPABILITIES> ],
    "comment": 
    "Available capabilities (<AVAILABLE_CAPABILITIES>) 
    do not include all required capabilities 
   (<REQUIRED_CAPABILITIES>)"
}

L’utente non è abilitato ad effettuare l’operazione richiesta sulla tipologia documentale indicata

USER_AUTHENTICATION_FAILURE

403 Forbidden
{
   "status" : "USER_AUTHENTICATION_FAILURE",
   "comment" : "Bad Login, Password or Token"
}

L’autenticazione è fallita, o il token ha raggiunto il limite di validità temporale

USER_SERVICE_NOT_AUTHORIZED

403 Forbidden
{
   "status" : "USER_SERVICE_NOT_AUTHORIZED",
   "comment" : "The user didn't authorized 
    this service until the moment"
}

L’utente non è abilitato al servizio selezionato