Elemento root e attributi
L'elemento root di un messaggio XML è basato su una struttura oggetto e su un'operazione specificata per il canale o il servizio utilizzato per la comunicazione. L'elemento root può contenere uno o più attributi.
La seguente tabella mostra gli attributi che possono essere applicati agli elementi root. I nomi e i valori degli attributi sono sensibili al maiuscolo / minuscolo. Tutti gli attributi sono facoltativi.
| Attributo | Descrizione | Tipo | Applicabile a |
|---|---|---|---|
baselanguage |
La lingua di base in cui vengono forniti i valori del contenuto. |
stringa |
Tutte le operazioni di input e output |
creationDateTime |
Data e ora di generazione del contenuto. |
dateTime |
Tutte le operazioni di input e output |
maximoVersion |
La versione principale, la versione secondaria, la build e la build del database generata per tutti gli XML pubblicati. |
MaximoVersionType |
Tutte le operazioni di input e output |
messageID |
Identificativo univoco generato per tutti i messaggi. |
stringa |
Tutte le operazioni di input e output |
transLanguage |
La lingua in cui vengono forniti i valori per i campi abilitati per più lingue. |
stringa |
Tutte le operazioni di input e output |
event |
L'origine di un messaggio XML in uscita. I valori validi sono:
|
eventType |
Tutte le operazioni di output |
uniqueResult |
Specifica se una query prevede uno o più record in una risposta. Se il valore è 0 o l'attributo non è specificato, la query può restituire più record. Se il valore è 1, la query può restituire solo un singolo record e, altrimenti, si verifica un errore. |
Booleano |
Query (input) |
maxItems |
Se una query può restituire più record, questo attributo limita il numero di record da restituire contemporaneamente. Se questo attributo non è specificato, la risposta contiene l'intera serie di risultati. |
positiveInteger |
Query (input) |
rsStart |
Specifica il primo record da restituire nella risposta. Se non specificato, la risposta inizia con il primo record nella serie di risultati. Se il numero di risultati nella serie di risultati è inferiore al valore Se viene specificato un valore Ad esempio, se maxItems=10 e rsStart non viene specificato, la risposta restituisce i risultati da 1 a 10. Per ricevere i risultati da 11 a 20, inviare nuovamente la query con rsStart=11. |
intero |
Query (input) |
rsStart |
Questo valore corrisponde al valore Se la query contiene un valore Se questo attributo non viene specificato, la risposta inizia con il primo record nella serie di risultati e include il numero di record specificati dall'attributo |
intero |
Risposte (output) |
rsCount |
Il numero di record restituiti in un messaggio. Se la query originale specifica un valore |
intero |
Risposte (output) |
rsTotal |
Il numero totale di record nella serie di risultati. Se la query non specifica un valore |
intero |
Risposte (output) |