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

<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

<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.