USER_LIST 

Utenti abilitati

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

Azione

Restituisce l’elenco degli utenti abilitati al servizio. La chiamata è accessibile solo all’amministratore.

Richiesta

{ 
    "message_type": "USERS_LIST",
    "version": "1.0",
    "authentication": <AUTHENTICATION>,
    "filter": [
        {
            "field_name": "user_email",
            "operation": 'MATCH',
            "value1": <USER EMAIL>
        },
    ],
    "order_by": [],
    "paging": {
        "start": <START INDEX, FIRST ELEMENT IS 0>
        "count": <COUNT MAX 100>
    }
}
  • filter: filtra gli utenti da elencare; al momento è utilizzabile solo l’email degli utenti.
  • order_by: specifica l’ordinamento dell’elenco; al momento non è implementato

Risposta OK

{
    "status": "OK",
    "comment": "Users List",
    "rows_count": <TOTAL NUMBER OF ROWS>,
    "users": [
        "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" ) },
                            ...
                        ],
                    },
                    ...
                ]
            },
            ...
        ],
        ...
    ]
}

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.