Identificativi utilizzati

Nella descrizione delle funzioni sono usati i seguenti identificativi

<USER AUTHENTICATION> 

Quando si fa riferimento a <USER AUTHENTICATION> si intende la seguente struttura, nel caso che l’autenicazione avvenga tramite token:
{  
    "interface_code": <assegnata da KPNQWEST>
    "interface_password": <assegnata da KPNQWEST >
    "login": <LOGIN>,
    "token": <TOKEN>
}
oppure la seguente struttura, nel caso l’autenticazione avvenga tramite password:
{  
    "interface_code": <assegnata da KPNQWEST>
    "interface_password": <assegnata da KPNQWEST >
    "login": <LOGIN>,
    "password": <PASSWORD>
}

<ORGANIZATION_CODE>

Organizzazione (utile in caso di aziende multi-società sui cui l’azione è eseguita

<DOCUMENT_TYPE>

Classe documentale su cui l’azione è eseguita

<DOCUMENT_ID>

Identificativo del documento su cui l’azione è eseguita

<LOT_ID>

Identificativo del lotto su cui l’azione è eseguita

<CODE>

Identificativo assegnato per poter inviare documenti FPA

<COUNTRY>

Identificativo assegnato per poter inviare documenti FPA (due caratteri)



 

<EVENT>

E' una struttura che identifica l'evento. A seconda dell'evento stesso, la struttura data si riempie dei dati propri dell'evento.

Si vedano le tabelle seguenti, per avere l'elenco dei campi e la popolazione delle strutture:

Nome
Tipo
Descrizione
Opzionale
event_log_id

String

Codice univoco dell'evento N
document_type
String codice della classe documentale N
creation_time
String epoch (numero) N
code

"UNKNOWN_TYPE" | "SEQUENCE_VIOLATION" | "DOCUMENT_TOO_OLD" | "DUPLICATE_DOCUMENT" | "UNEXPECTED_ERROR" | "DOCUMENT_OVERWRITTEN" | "DOCUMENT_DELETED" | "FOUND_SEQUENCE_VIOLATION" | "SPOOL_OK" | "SETUP_USER_CAPABILITIES" | "CREATE_USER" | "DELETE_USER" | "ADVICE" | "LOT_DELETED" | "METADATA_NOT_FOUND" | "MISSING_REQUIRED_METADATA" | "UPLOAD_SPOOL" | "SPOOL_GENERATION_ERROR" | "SPOOL_ARCHIVING_ERROR"

il tipo di evento che si è generato N
context
"UPLOAD_SPOOL" | "UPLOAD_SINGLE_DOCUMENT" | "OVERWRITE_SPOOL" | "OVERWRITE_SINGLE_DOCUMENT" | "ARCHIVE" | "GENERATION" | "SENDING" | "ADMIN" | "DELETE_SINGLE_DOCUMENT" è l'ambito nel quale si è verificato l'evento durante la lavorazione del documento N
type
"WARNING" | "ERROR" tipo di evento N
data
 EventData sono i dati che caratterizzano l'evento e che sono descritti  EventData

 

Attributi «EventData»

Queste informazioni sono variabili a seconda del campo code che individua il tipo di evento e quindi le informazioni associate

Code Nome Tipo Descrizione Opzionale
UNKNOWN_TYPE


job_id

String

identificativo univoco del job N
document_id
String identificativo univoco del documento N
document_filename
String nome del file con il quale il documento è stato caricato N
metadata
Struct i metadati della classe documentale in formato chiave valore N
year String anno 4 cifre N
spool_filename String nome del file originale dell spool Y
user_email String l'utenza che ha creato il job Y
data

String

??? N
SEQUENCE_VIOLATION






job_id
String identificativo univoco del job N
document_id
 String identificativo univoco del documento N
document_number
String numero di documento N
document_filename String nome del file con il quale il documento è stato caricato N
metadata Struct i metadati della classe documentale in formato chiave valore N
previous_document_number
String numero di documento precedente, in modo da verificare il salto segnalato N
year String anno 4 cifre N
spool_filename String nome del file originale dell spool Y
user_email String l'utenza che ha creato il job Y
DOCUMENT_TOO_OLD




job_id
String identificativo univoco del job N
document_id
String identificativo univoco del documento N
document_filename String nome del file con il quale il documento è stato caricato N
metadata Struct i metadati della classe documentale in formato chiave valore N
year String anno 4 cifre N
spool_filename String nome del file originale dell spool Y
user_email String l'utenza che ha creato il job Y
days_too_old String numero di giorni del documento N
DUPLICATE_DOCUMENT



metadata Struct i metadati della classe documentale in formato chiave valore N
year String anno 4 cifre N
spool_filename String nome del file originale dell spool Y
user_email String l'utenza che ha creato il job Y
job_id
String identificativo univoco del job Y
document_number
String numero di documento N
UNEXPECTED_ERROR metadata Struct i metadati della classe documentale in formato chiave valore N
trace String stringa di errore per diagnostica N
DOCUMENT_OVERWRITTEN





job_id
String identificativo univoco del job Y
spool_filename String nome del file originale dell spool Y
year String anno 4 cifre N
user_email String l'utenza che ha creato il job Y
metadata Struct i metadati della classe documentale in formato chiave valore N
old_metadata Struct i metadati della classe documentale del documento sovrascritto in formato chiave valore N
document_number
String numero di documento N
DOCUMENT_DELETED




job_id
String identificativo univoco del job Y
spool_filename String nome del file originale dell spool Y
user_email String l'utenza che ha creato il job Y
metadata Struct i metadati della classe documentale in formato chiave valore N
document_number
String numero di documento N
year String anno 4 cifre N
FOUND_SEQUENCE_VIOLATION year String anno 4 cifre N
documents_holes Array elenco dei buchi documentali nella forma di numeri o archi ( "xx-yy" ) Y
lots Array elenco dei buchi dei lotti nella forma di numeri o archi ( "xx-yy" ) Y
SPOOL_OK   
job_id
String identificativo univoco del job Y
spool_filename String nome del file originale dell spool Y
user_email String l'utenza che ha creato il job Y
year String anno 4 cifre N
documents Struct La struttura è descritta Documents N

SETUP_USER_CAPABILITIES

CREATE_USER

  
user_email String l'utenza della quale sono stati cambiati i permessi N
can_upload "yes" | "no" l'utente è autorizzato a caricare dei documenti N
can_delete "yes" | "no" l'utente è autorizzato a cancellare dei documenti N
can_view "yes" | "no" l'utente è autorizzato a vedere dei documenti N
can_resend "yes" | "no" l'utente è autorizzato a rispedire dei documenti N
DELETE_USER user_email String l'utenza della quale sono stati cambiati i permessi N
ADVICE text String testo libero di avviso per il cliente N
references Struct struttura libera di riferimento in funzione dell'avviso mostrato N
LOT_DELETED old_lot_code String numero del lotto cancellato N
document_count Integer numero dei documenti del lotto N
user_email String l'utenza che ha cancellato il lotto N

METADATA_NOT_FOUND

MISSING_REQUIRED_METADATA

UPLOAD_SPOOL

SPOOL_GENERATION_ERROR

SPOOL_ARCHIVING_ERROR

year String anno 4 cifre N
job_id
String identificativo univoco del job Y
spool_filename String nome del file originale dell spool Y
user_email String l'utenza che ha cancellato il lotto Y

 

Attributi «Documents»

Nome
Tipo
Descrizione
Opzionale
processed

Integer

numero di documenti estratti N
archived
Integer numero di documenti archiviati N
not_archived Integer numero di documenti non archiviati N
sent_by_mail Integer numero di documenti spediti per posta tradizionale Y
sent_by_email Integer numero di documenti spediti per posta elettronica Y
sent_by_fax Integer numero di documenti spediti per fax Y

 

<FAX_NUMBER>     

Numero fax a cui inviare il documento (la presenza di questo valore provoca l’invio via fax)

<EMAIL_ADDRESS>     

Email a cui inviare il documento (la presenza di questo valore provoca l’invio via email)

<ADDRESS_n> <ADDRESS_2>  <ADDRESS_3> <ADDRESS_4>   <ADDRESS_5>  

 Indirizzo postale di destinazione, n-esima linea (da 1 a 5)

<ZIPCODE>

 CAP per l’invio postale (la presenza di questo valore provoca l’invio via posta)

<STATUS DETAIL>

Dettaglio delle informazioni sulla trasmissione secondo la tabella seguente

Canale (media type) Status Descrizione
FAX   In lavorazione
  OK Invio completato
  ABS Nessun segnale audio
  AWC Errore generico
  BAD Timeout scaduto
  NA Tono di ricezione fax assente
  DLD Invio sospeso per fascia oraria protetta
  DER Qualità trasmissione insufficiente
  NC Macchina remota non compatibile
  PROCESSED AWC In attesa di consegna
  OCC Numero occupato
  CANCELLED ABS Nessun segnale audio
  CANCELLED AWC Errore generico
  CANCELLED BAD Timeout scaduto
  CANCELLED BLA Numero in black list
  CANCELLED DER Qualità trasmissione insufficiente
  CANCELLED INV Errore nella conversione
  CANCELLED MMBADFIELDS Errore mailmerge
  CANCELLED MMNODOC Errore mailmerge
  CANCELLED MMNOFAXNUM Errore mailmerge
  CANCELLED MMNOFIEDLS Errore mailmerge
  CANCELLED MMUNEXPECTED Errore generico
  CANCELLED NA Tono di ricezione fax assente
  CANCELLED NC Macchina remota non compatibile
  CANCELLED OCC Numero occupato
  CANCELLED ROU Numero non raggiungibile
EMAIL   In lavorazione
    Invio completato
  RELAYED Messaggio consegnato al mailserver di destinazione
  OK READ Messaggio letto
  DEFERRED Errore temporaneo sul mailserver di destinazione
  PROCESSED UNIMERGED Messaggio composto e spedito
  PROCESSED AWC Messaggio preso in carico
  CANCELLED BADADDRESS Indirizzo di posta elettronico errato
  CANCELLED DUPLICATE Indirizzo duplicato
  CANCELLED EXPIRED Ciclo di tentativi esaurito
  CANCELLED NA Errore di consegna
  CANCELLED QUOTA Spazio esaurito sulla mailbox
  CANCELLED RECENTFAIL Indirizzo bloccato per elevato tasso d'errore
  CANCELLED SPAM Messaggio riconosciuto come spam
  AWC Messaggio preso in carico
LETTERA   In lavorazione
  PROCESSED AWC Messaggio preso in carico
  SENT Messaggio consegnato allo stampatore
  DELIVERED Messaggio consegnato al vettore
PEC    In lavorazione
  OK  Invio completato
  CANCELLED NA Errore di consegna
  CANCELLED NOTPEC Errore casella email NON PEC 

<DOCUMENT_STATUS_DETAIL>

Valori che può assumere

Document_status = TO_ARCHIVE
Document_status_detail = TO_ARCHIVE (il documento è da archiviare)

Document_status = ARCHIVED
Document_status_detail =

  • ARCHIVED: il documento è stato archiviato
  • CONSERVED: il documento è stato archiviato e conservato, il codice del lotto è contenuto nel campo “lot_code”

Document_status = ARCHIVE_ERROR
Document_status_detail =

  • DUPLICATED: il documento è già presente nel sistema
  • UNAUTHORIZED_USER: errore di configurazione del server, segnalare l’errore all’help desk
  • INVALID_ALIAS_OR_PIN: Invalid alias o pin
  • STRING_METADATA_TOO_LONG: i metadati di uno spool non devono superare gli 85 caratteri
  • INVALID_INTEGER_METADATA: metadato numerico non valido all’interno dello spool
  • INVALID_DATE_METADATA: metadato di tipo data non valido all’interno dello spool
  • GENERIC_ERROR: errore non documentato, segnalarlo all’help desk

Document_status = DELETED
Document_status_detail =

  • DELETED: il documento è stato cancellato
  • OVERWRITTEN: il documento è stato sovrascritto

Attenzione: le informazioni riportate in questa sezione possono non essere perfettamente allineate con la versione corrente del servizio, in continua evoluzione. Per qualunque informazione specifica, vi preghiamo di contattarci.