API: TABLES service

The TABLES service is used to extrapolate the list of all tables and if necessary, the structure of each table.

The service in question can be called up via the following URL: https://api.gooseapp.com/tables/

The JSON data structure must be sent by POST, below is an example of a call JSON:

{
code: "DEV001",
key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
structure: false
}

This call brings up a JSON containing all the tables on your database in the Cloud.

The parameters available for the TABLES calls are as follows:

A call like the following allows you to obtain the list of all system tables.

{
 code: "DEV001",
 key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
 structure: false
}

If the operation performed is successful you will obtain the following JSON:

{
 status: "OK",
 result:
 {
  total: 73,
  data: 
[
   {
    name: "AGE_FAM"
   },
   {
    name: "AGE_GRU"
   },

...

  ]
 }
} 

The "OK" status indicates that the TABLES operation was successful. The result structure then contains the total (total selected fields) and data fields (return data structure).

A call like the following allows you to obtain the list of all tables and the structure of each. In this case, simply set the specific structure to true.

{
 code: "DEV001",
 key: "09mpada9nx4mxl3346055518sf89hcyga74mwmhucgf9j7cg78",
 structure: true
}

If the operation performed is successful you will obtain the following JSON:

{
 status: "OK",
 result:
 {
  total: 73,
  data: 
[
   {
    name: "AGE_FAM",
    structure: [ Array Fields List ]
   },
   {
    name: "AGE_GRU",
    structure: [ Array Fields List ]
   },

...

  ]
 }
} 

If the operation performed is not successful you will obtain the following JSON:

{
 status: "error",
 error: 
 {
   code: 120,
   description: "Table 'client_goose_DEM001.CON_TRO' doesn't exist'"
 }
}

In case of an error, the status is shown with an "error" value and the error code and a description of the error are indicated in the error structure.

Do you want to ask us something?
Contact us at support@gooseapp.com