API di piattaforma > JamioPlug > JamioPlug Survey

Genera un link ad un questionario privato, ovvero che deve essere compilato da un utente Jamio in una specifica sessione e che ci accede tramite apposito link ivi indicato.

Metodo

Plug Survey/GetPrivateSurveyLink

Input
Nome	Descrizione	Tipo	Opzionale
token	Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto)	String	Y
storageConfigurationReference	Collegamento alla configurazione del Plug Elastic Storage da utilizzare. Circa le proprietà: Name è valorizzato con un Nckname di una configurazione, URL nullo e Type Undefined. Il Name della configurazione viene utilizzato nel nome dell’indice del Survey.	Reference
templateReference	Collegamento del documento o componente che contiene il template.	Reference
surveyName	Nome del survey.	String
sourceName	Nome sorgente. Di default il valore è Survey.	String	Y
dueDate	Data e ora massima in cui è possibile compilare il Survey.	DateTime	Y
readableAfterCompletion	Flag indicante se il Survey è leggibile dopo averlo completato. Di default il valore è impostato a false.	Boolean	Y
linkedResourceReference	Risorsa collegata le cui autorizzazioni governano le autorizzazioni di lettura e modifica del questionario.	Reference	Y
initData	Eventuali dati di inizializzazione dei campi del Survey (Questi devono corrispondere ai campi presenti nel template del Survey).	Dataset	Y
Output
Nome	Descrizione	Tipo	Opzionale
returnValue	Collegamento al questionario creato.	Reference

Commenti

La risoluzione del template avviene secondo il seguente pattern:

•se templateReference non punta ad un documento o ad un componente di tipo file, viene generato un errore;

•se templateReference punta ad un componente di tipo file, si assume che il file associato a tale componente sia il file di testo che contiene il JSON del template;

•se templateReference punta ad un documento:

ose non presente un componente di tipo file, viene generato un errore;

ose il componente principale è di tipo file, si assume che il file associato a tale componente sia il file di testo che contiene il JSON del template;

ose il documento contiene un unico componente di tipo file, si assume che il file associato a tale componente sia il file di testo che contiene il JSON del template;

oaltrimenti viene generato un errore.

Il template riportato in templateReference può essere generato utilizzando Jamio Survey Designer.

Per tutte le altre condizioni al di fuori di quelle indicate nella tabella sopra riportata, viene generato un errore.