USER_INFORMATION 

Informazioni sull’utente

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

Azione

Restituisce le organizzazionie le classi documentali a cui l’utente può accedere.

Richiesta

{
    "message_type": "USER_INFORMATION",
    "version": "1.0",
    "authentication": <USER AUTHENTICATION>
}

Risposta OK

{
    "status" : "OK",
    "comment" : "User Information",
    "user" : {
        "name": <USER NAME>,
        "organization": <USER ORGANIZATION, THIS DATA IS INDEPENDENT FROM THE PERMISSIONS>,
        "user_email": <USER EMAIL, THIS DATA IS INDEPENDENT FROM THE PERMISSIONS>
    },
    "organizations": [
        {
            "code": <ORGANIZATION_CODE>,
            "name": <ORGANIZATION_NAME>,
            "email": <ORGANIZATION_EMAIL>,
            "is_administrator": ( 1 | 0 )
            "document_types": [
                {
                    "code": <DOCUMENT_TYPE>
                    "filter": <FILTER >,
                    "capabilities": [
                        { "name" : ( "CAN_UPLOAD" | "CAN_RESEND" | "CAN_VIEW" | "CAN_DELETE" ) },
                        ...
                    ],
                    "definition": {
                        "description": <DESCRIPTION>,
                        "to_send": ( 1 | 0 ),
                        "archiving_action": ( "ARCHIVE" | "CONSERVE" | "NONE" )
                        "sending": {
                            "letter_color": ( "BW" | "COLOR" ),
                            "letter_print_both_sides": ( 1 | 0 ),
                            "letter_type": ( "MASSIVE" | "PRIORITY" ),
                            "email_from": <EMAIL_FROM ADDRESS>,
                            "email_from_name": <EMAIL_FROM NAME>,
                            "email_subject": <EMAIL_SUBJECT>,
                            "email_body": <EMAIL_BODY>,
"fpa_country": <COUNTRY>,
"fpa_code": <CODE>
                        },                    
                        "archiving": {
                            "metadata": [
                                {
                                    "name": <FIELD_NAME>,
                                    "optional": ( 1 | 0 ),
                                    "type": ( "STRING" | "DATE" | "INTEGER" ),
                                    "is_sequential_value": ( 1 | 0 ),
                                    "is_preservation_date": ( 1 | 0 ),
                                },
                                ...
                            ],
                            "error": ( "SYSTEM_BAD_CREDENTIALS" |  "GENERIC_ERROR" | "NOT_CONFIGURED" )
                        }
                    }
                },
                ...
            ]
        },
        ...
    ]
}

Descrizione dei campi

organizations.document_types.definition.filter:
filtro impostato in [% SetupUserCapabilities? Setup User Capabilities %]

organizations.document_types.definition.capabilities.name:
i permessi assegnati all’utente sulla tipologia documentale

organizations.document_types.definition. archiving_action:
modalità di gestione della tipologia documentale:

  • “ARCHIVE”: la tipologia documentale può avere metadati, sarà archiviata ma non conservata
  • “CONSERVE”: la tipologia documentale ha metadati, e sarà conservata
  • “NONE”: la tipologia documentale non ha metadati, e non sarà conservata

Errori

Per gli errori generici, consulta la sezione Messaggi d'errore
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.