Il service STRUCTURE serve per estrapolare la struttura di una tabella; è infatti possibile interrogare il sistema dati centrale, indicando una specifica tabella, per ottenere la lista di tutti i campi in essa presente e la struttura di ognuno.
Il service in questione può essere richiamato tramite il seguente url:
https://api.gooseapp.com/structure/
La struttura dati JSON dovrà essere inviata tramite POST. Di seguito un'esempio di JSON di chiamata:
{
code: "DEV001",
key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
table: "CON_TRO"
}
Questa chiamata restituisce un JSON contenente tutti i campi presenti su tabella CON_TRO.
I parametri disponibili per la chiamate STRUCTURE sono i seguenti.
|
Nome |
Tipo |
Obbligatorio |
Descrizione |
|---|---|---|---|
|
code |
varchar(6) |
Yes |
Codice azienda |
|
key |
varchar(200) |
Yes |
Chiave API di sicurezza |
|
table |
varchar(7) |
Yes |
Nome tabella |
Una chiamata come la seguente permette di ottenere le informazioni relative ai campi specifici della tabella in questione.
{
code: "DEV001",
key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
table: "CON_TRO"
}
Nel caso l'operazione eseguita vada a buon fine si ottiene il seguente JSON:
{
status: "OK",
result:
{
total: 71,
data:
[
{
Field: "RECORD_ID",
Type: "varchar(25)",
Null: "NO",
Key: "PRI",
Default: "",
Extra: ""
},
{
Field: "CORAS",
Type: "varchar(100)",
Null: "YES",
Key: "",
Default: "",
Extra: ""
},
...
]
}
}
Lo status "OK" indica che l'operazione di STRUCTURE è andata a buon fine. Nella struttura result sono poi presenti i campi total (totale campi selezionati) e data (struttura dati di ritorno).
Nel caso l'operazione eseguita non vada a buon fine si ottiene il seguente JSON:
{
status: "error",
error:
{
code: 120,
description: "Table 'client_goose_DEM001.CON_TRO' doesn't exist'"
}
}
In caso di errore lo status viene restituito con valore "error" e nella struttura error vengono indicati il codice di errore e una descrizione dell'errore.