API: Service DELETED

Il service DELETED serve per estrapolare la lista dei record cancellati, è infatti possibile interrogare il sistema cloud, indicando una specifica tabella, per ottenere la lista di tutti i record in essa cancellati o la lista dei soli record cancellati da uno specifico date/time.

Il service in questione può essere richiamato tramite il seguente url: https://api.gooseapp.com/deleted/


La struttura dati JSON dovrà essere inviata tramite POST, qui di seguito un esempio JSON di chiamata:
 

{
code: "DEV001",
key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
table: "CON_TRO"
}


Questa chiamata restituisce un JSON contenente tutti i record presenti su tabella CON_TRO.

I parametri disponibili per la chiamate SELECT 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


from


varchar(50)


No


Formato date/time "yyyy-mm-dd hh:mm:ss" che permette di richiedere solo i record cancellati da un determinato periodo in avanti.


In alternativa è possibile utilizzare la keyword "latest" per avere solo la lista dei record cancellati su una data tabella dall'ultima chiamata andata a buon fine.


imc


true/false


No


Il parametro imc sta per "Include My Call".


Questo parametro viene preso in considerazione solo se valorizzato anche il parametro from,con un formato date/time valido o con valore "latest".

Nel caso sia impostato a true restituisce tutti i record cancellati, compresi quelli cancellati dal proprio service altrimenti esclusi.


Il parametro from risulta fondamentale nel caso si vogliano eseguire operazioni di sync incrementali, può essere utilizzato oltre che nel formato date/time anche tramite keyword "latest".

Una chiamata come la seguente permette infatti di ottenere la lista di tutti i record cancellati dall'ultima chiamata del proprio service.
 

{
 code: "DEV001",
 key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
 table: "CON_TRO",
 from: "latest"
}

 

Nel caso invece si volessero escludere i record cancellati da service API:
 

{
 code: "DEV001",
 key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
 table: "CON_TRO",
 from: "latest",
 imc: false
}


 

Nel caso l'operazione eseguita vada a buon fine si ottiene il seguente JSON:
 

{
 status: "OK",
 result:
 {
  total: 3,
  data: 
  [
   {
    TABLE: "CON_TRO",
    RECORD_ID: "0-1",
    SYKEY: ""
   },
   {
    TABLE: "CON_TRO",
    RECORD_ID: "0-2",
    SYKEY: "MyCode2"
   },
   {
    TABLE: "CON_TRO",
    RECORD_ID: "0-3",
    SYKEY: "MyCode3"
   }
  ]
 }
} 

 

Lo status "OK" indica che l'operazione di DELETED è andata a buon fine, nella struttura result sono poi presenti i campi total (totale righe selezionate) 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.


Vuoi chiederci qualcosa?
Scrivici a: 
support@gooseapp.com


Entra in Goose
Amministrazione
Area Utenti
Sei già un nostro cliente? Accedi tramite tuo username e password.

Utilizziamo i cookies per garantire la funzionalità del sito e per tenere conto delle vostre scelte di navigazione in modo da offrirvi la migliore esperienza sul nostro sito. Inoltre ci riserviamo di utilizzare cookies di parti terze. Per saperne di più consulta le nostre Privacy Policy e Cookie Policy. Continuando a navigare sul sito, l'utente accetta di utilizzare i cookies.
OK