API: DOCUMENT_TYPE_CONFIGURATION_UPDATE - Specifica modalità di spedizione di una classe documentale

Gli identificativi del tipo "<***>" sono descritti in questa sezione

Azione

Specifica le modalità di spedizione (via email e posta) di una determinata classe documentale. Ricordiamo che l’invio via fax non richiede alcuna specifica modalità

Richiesta

{ 
    "message_type": "DOCUMENT_TYPE_CONFIGURATION_UPDATE",
    "version": "1.0",
    "authentication": <AUTHENTICATION>,
"organization_code": <ORGANIZATION_CODE>,
"document_type": <DOCUMENT_TYPE>,
"sending": {
"letter_color": ( "BW" | "COLOR" ),
"letter_print_both_sides": ( 1 | 0 ),
"letter_type": ("MASSIVE" | "PRIORITY"),
"email_from": ,
"email_from_name": ,
"email_subject": ,
"email_body":
}
}

Descrizione dei campi

  • "document_type" : l’identificatore della tipologia documentale
  • Parametri per l’invio postale:
    • "letter_color" : "BW" per stampe in bianco/nero o "COLOR" per stampe a colori
    • "letter_print_both_sides" : "S" per stampa solo fronte o “D” per stampa fronte/retro
    • "letter_type" : "MASSIVE" per l’affrancatura di posta massiva, o "PRIORITY" per l’affrancatura prioritaria
  • Parametri per l’invio email:
    • "email_from" : l’email del mittente
    • "email_from_name" : il nome per esteso del mittente
    • "email_subject" : l’oggetto della email
    • "email_body" : il contenuto testuale della email
    Il campo subject può contenere i metadati in forma normalizzata.La normalizzazione prevede che il nome del metadato sia espresso in forma maiuscola, con il carattere '_' al posto dello spazio, ed anticipato dalla sequenza  '[%' e posticipato dalla sequenza '%]'.
    Inoltre è stato creato il placeholder '[%DOCUMENT_URL%]', che costituisce il link al documento cui si riferisce la email.
     
    esempio: [% NUMERO_DOCUMENTO %]

Risposta OK

200 OK 
{ 
    "status": "OK", 
      "comment" : "Document type Configuration updated"
};

Errori

Parametro errato. Questo messaggio viene mostrato quando per questa classe documentale il place holder non viene riconosciuto.
400 Bad Request
{
    "status": "BAD_FIELD_VALUE",
    "field_name": ,
"field_value": ,
"comment": "Bad field value for $FIELD_NAME: $FIELD_VALUE"
}
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.