SOAP - Esempio chiamata per la scrittura
SeguiIn questo esempio ipotizziamo di voler inserire o aggiornare un curriculum.
Comincia creando la vista per la modifica:
- Crea una vista di tipo maschera che abbia Curricula come tabella di riferimento
- Modifica la vista e assegna per esempio il tag name Curriculum.Edit.API
- Aggiungere alla vista i campi che si intende modificare
- Esponi la vista come API
Crea un token con cui poter usare le API:
- Crea un utente. Questo è l'utente con cui l'API accederà alla piattaforma
- Assegna i permessi all'utente. Assegnare le autorizzazioni per la lettura e la scrittura dei Curricula
- Crea un token API per il vostro utente
Puoi anche usare un utente esistente: ovviamente le autorizzazioni saranno quelle dell'utente che hai scelto. Quindi, se scegli un utente Administrator la chiave API darà all'applicazione accesso a tutti i dati della piattaforma.
Da un client adatto a consumare l'API, usare la URL generata precedentemente sostituendo la API_KEY con la chiave ottenuta.
Configurare il client usando la definizione del servizio in formato WSDL. Tutte le viste esposte come API sono metodi dell'API stessa accessibili da una unica URL.
Struttura del messaggio SOAP
Di seguito gli elementi presenti nel messaggio:
- <soap:APIKey> : contiene la chiave API.
- <soap:Data> : contenitore degli elementi che identificano i singoli campi della vista. Ogni campo all’interno della vista esposta corrisponde a un elemento XML. Ciascuno di essi va compilato con il valore da trasmettere.
Esempio:
<soap:Punches.Date>2018-07-31T00:00:00</soap:Punches.Date>
Lasciando vuoto l'elemento si svuota il campo nella piattaforma. Omettendo l'elemento, non si effettua nessuna modifica nel campo corrispondente.
Alcuni elementi corrispondono a campi a testo libero, altri invece a campi con una lista di valori predefinita (codifiche). I valori inseriti nell'elemento devono essere tra quelli disponibili per quella codifica presenti in piattaforma.
Per ottenere la lista delle codifiche e gli elementi ad esse associati sono disponibili nella API dei metodi specifici (Lists e ListItems).
- <soap:Operation> : inserire il valore di Upsert.
- <soap:Keys> : rappresenta il/i tagname della chiave primaria, ovvero il campo su cui filtrare per estrarre univocamente il Curriculum da modificare.
Nel nostro caso se vogliamo modificare un determinato CV possiamo mettere come chiave il CVID oppure il codice fiscale, o entrambi.
<soap:Keys>CV.CVID</soap:Keys>
N.B. Il valore di tale chiave, cioè il valore del CVID o del codice fiscale dovrà essere inserito nella sezione "Data" vista in precedenza
<soap:Keys>CV.FiscalCode</soap:Keys>
Se il valore dell'elemento keys non viene specificato oppure il valore passato nella sezione "Data" non corrisponde a nessun Curriculum in piattaforma verrà sempre creato un nuovo record.
- <soap:KeysSecondary> : rappresenta la chiave secondaria, che serve a legare il record che si sta per importare a un altro elemento già presente in piattaforma. Per esempio, nel caso dell’importazione di una timbratura, la chiave secondaria serve per legare la timbratura al dipendente che l’ha effettuata e quindi si può usare il codice fiscale:
<soap:KeysSecondary>CV.FiscalCode</soap:KeysSecondary>
Commenti
0 commenti
Accedi per aggiungere un commento.