icon_qa

INTRODUZIONE API REST

Usi l'app Postman?
 

CAMPI PERSONALIZZATI

Lista campi personalizzati Rubrica

Lista dei campi personalizzati definiti dall'utente.

Per la creazione di questi campi fare riferimento alla guida campi dinamici

URI

GET https://api.smshosting.it/rest/api/phonebook/customfields/list

Richiesta

ParametroObbligatorioTipoDescrizione
Nessun parametro

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
401 Credenziali non valide
405 Metodo HTTP non consentito
500 Errore generico

La chiamata ritorna una lista con i campi personalizzati definiti dall'utente.

Ogni campo personalizzato è descritto dalle seguenti proprietà:

ProprietàDescrizione
fieldKey Chiave univoca del campo
fieldName Nome del campo
fieldType Tipo campo

I possibili valori sono:

TEXT - campo di testo libero

NUMBER - campo che può contenere solamente cifre.

DATE - campo di tipo data. Utile per le automazioni.

SELECT - menu a tendina: l'utente può selezionare un solo valore.

SELECTMULTIPLE - campo a scelta multipla: l'utente può selezionare uno o più valori.

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  https://api.smshosting.it/rest/api/phonebook/customfields/list
[
   {
      "fieldKey":"f_indirizzo",
      "fieldName":"Indirizzo",
      "fieldType":"TEXT"
   },
   {
      "fieldKey":"f_cap",
      "fieldName":"CAP",
      "fieldType":"NUMBER"
   }
]