O3API Endpoints
Swagger API documentation
Tip
The full and actual Swagger documentation is found at https://api.o3as.fedcloud.eu/api/v1/ui/.
Endpoints description
The documentation below is automatically generated from the swagger.yml:
- GET /apiinfo
Returns information about the API
Information about the API (o3api metadata)
- Status Codes
200 OK – Successfully returned o3api info
404 Not Found – Requested resource not found
- GET /data
Returns a list of plot types with the available raw data
List of plot types with the available raw data
- Status Codes
200 OK – Successfully returned the list of data types
404 Not Found – Requested resource not found
default – Unexpected error
- POST /data/tco3_zm
Returns raw data for tco3_zm
Raw data to be processed for building tco3_zm plot
- Query Parameters
begin (integer) – Year to start data scanning from
end (integer) – Year to finish data scanning
month (array) – Month(s) to select, if not a whole year
lat_min (integer) – Latitude (min) to define the range (-90..90)
lat_max (integer) – Latitude (max) to define the range (-90..90)
- Status Codes
200 OK – Successfully retrieved the data
404 Not Found – Requested resource not found
default – Unexpected error
- POST /data/tco3_return
Returns raw data for tco3_return
Raw data to be processed for building tco3_return plot
- Query Parameters
begin (integer) – Year to start data scanning from
end (integer) – Year to finish data scanning
month (array) – Month(s) to select, if not a whole year
lat_min (integer) – Latitude (min) to define the range (-90..90)
lat_max (integer) – Latitude (max) to define the range (-90..90)
- Status Codes
200 OK – Successfully retrieved the data
404 Not Found – Requested resource not found
default – Unexpected error
- GET /models
Returns a list of available models
List of available models
- Query Parameters
ptype (string) – Plot type (tco3_return, tco3_zm, vmro3_zm)
select (string) – Select models according to the {select} pattern
- Status Codes
200 OK – Successfully returned list of models
404 Not Found – Requested resource not found
default – Unexpected error
- GET /models/{model}
Returns detailed information about a model
Detailed information about a model
- Parameters
model (string) – model name
- Status Codes
200 OK – Successfully returned model information
404 Not Found – Requested resource not found
default – Unexpected error
- POST /models/plotstyle
Returns plot styles for models
Plot styles for selected models and plot type
- Query Parameters
ptype (string) – Plot type (tco3_return, tco3_zm, vmro3_zm)
- Status Codes
200 OK – Successfully returned plot styles for models
404 Not Found – Requested resource not found
default – Unexpected error
- GET /plots
Returns a list of possible plots
List of possible plots
- Status Codes
200 OK – Successfully returned the list of possible plots
404 Not Found – Requested resource not found
default – Unexpected error
- POST /plots/tco3_zm
Builds and returns tco3_zm plot
tco3_zm plot or corresponding data points
- Query Parameters
begin (integer) – Year to start data scanning from
end (integer) – Year to finish data scanning
month (array) – Month(s) to select, if not a whole year
lat_min (integer) – Latitude (min) to define the range (-90..90)
lat_max (integer) – Latitude (max) to define the range (-90..90)
ref_meas (string) – Reference observational measurument (Required)
ref_year (integer) – Reference year for the obsevational measurement (Required)
- Status Codes
200 OK – Successfully created the plot
404 Not Found – Requested resource not found
default – Unexpected error
- POST /plots/tco3_return
Builds and returns tco3_return plot
tco3_return plot or corresponding data points
- Query Parameters
month (array) – Month(s) to select, if not a whole year
lat_min (integer) – Latitude (min) to define the range (-90..90)
lat_max (integer) – Latitude (max) to define the range (-90..90)
ref_meas (string) – Reference observational measurument (Required)
ref_year (integer) – Reference year for the obsevational measurement (Required)
- Status Codes
200 OK – Successfully created a plot
404 Not Found – Requested resource not found
default – Unexpected error