UPLOAD_SINGLE_DOCUMENT Upload di un documento Gli identificativi del tipo "<***>" sono descritti in questa sezione Azione
Upload di un singolo documento.Richiesta
La richiesta è fatta tramite multipart/form. La seguente tabella illustra i campi utilizzati:
| Campo | Obbligatorio | Valore | | message_type | Si | "UPLOAD_SINGLE_DOCUMENT" | | authentication.interface_code | Si | Codice assegnato da KPNQwest | | authentication.interface_password | Si | Password assegnata da KPNQwest | | authentication.login | Si | Email dell’utente | | authentication.token | | Il token restituito da una precedente autenticazione | | authentication.password | | Password dell’utente registrato | | organization_code | Si | Codice azienda | | document_type | Si | Tipologia documentale | | sendto.fax_number | | Numero di fax a cui spedire il documento | | sendto.email | | Email a cui spedire il documento | | sendto.address_1 | | Indirizzo postale | | sendto.address_2 | | Indirizzo postale | | sendto.address_3 | | Indirizzo postale | | sendto.address_4 | | Indirizzo postale | | sendto.address_5 | | Indirizzo postale | | sendto.zipcode | | CAP o “NOT_ITALY” per estero | | metadata.field_name_XX | Si | metadati associati al documento | | label | | Un'etichetta definita dall’utente per identificare il documento | | filename | Si | nome del file | | reference_year | Si | Anno di riferimento | | alias | Si | Alias usato per la firma del documento | | pin | Si | Pin usato per la firma del documento | | content | Si | Il contenuto del file | | mimetype | Si | mimetype | Descrizione dei campi
I campi dei metadati (metadata.field_name_XX) possono essere di 3 tipi:
- Interi: numeri interi
- Date: data nel formato yyy-mm-dd
- Stringhe: stringhe di testo
Risposta OK
200 OK
{
"status": "OK",
"comment": "Document Uploaded",
"document_id": <DOCUMENT_ID>,
"warning": ( "NO_WARNING" | "SEQUENCE_VIOLATION" )
}
Warning ha il valore “SEQUENCE_VIOLATION” se la numerazione del metadato sequenziale non è consecutiva al precedente upload.
Errori Metadato stringa troppo lungo 422 Unprocessable Entity
{
"status" : "STRING_METADATA_TOO_LONG",
"comment" : "String Metadata too long",
"field" : Field Name
}
Metadato Intero non valido 422 Unprocessable Entity
{
"status": "INVALID_INTEGER_METADATA",
"comment": "Invalid Integer metadata <FIELD_NAME>",
"field": <FIELD_NAME>
} Metadato Data non valido 422 Unprocessable Entity
{
"status": "INVALID_DATE_METADATA",
"comment": "Invalid Date metadata <FIELD_NAME>",
"field": <FIELD_NAME>
} Metadato mancante 422 Unprocessable Entity
{
"status" : "MISSING_REQUIRED_METADATA",
"comment" : "Missing required metadata:
(<LIST OF FIELD_NAME>)",
"fields" : [<FIELD_NAME>]
} Per gli errori generici, consulta la sezione Messaggi d'errore |