prosEO Geotools REST Services API API documentation version v0.1
/proseo/geotools/{version}
- version: required(v0.1)
/info
Get information about known region types
get /info
Get information about known region types
HTTP status code 200
Body
Media type: text/plain
Type: any
HTTP status code 400
The request sent to the server contains invalid data
Headers
- Warning: required(string - pattern: ^\d{3} proseo-geotools \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-geotools (E1508) No or an uneven number of longitude/latitude values were provided
HTTP status code 500
The requested was valid but the implementation is pending or an error occured
Headers
- Warning: required(string - pattern: ^\d{3} proseo-geotools \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-geotools (E1508) No or an uneven number of longitude/latitude values were provided
/contains
Tests whether the polygon is completly contained in any region of type(s)
Tests whether the polygon is completly contained in any region of type(s)
get /contains
Tests whether the polygon is completly contained in any region of type(s)
Query Parameters
- poly: required(array of )
String array containing latitude (uneven fields)/longitude (uneven fields) pairs in Double format, which together describe an area to be compared to a number of specified regions
- type: (array of )
String array used to determine which regions (specified in application.yml) to check. If the array parameter is null or empty, all available region types will be considered.
HTTP status code 200
Body
Media type: application/json
Type: boolean
Example:
trueHTTP status code 400
The request sent to the server contains invalid data
Headers
- Warning: required(string - pattern: ^\d{3} proseo-geotools \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-geotools (E1508) No or an uneven number of longitude/latitude values were provided
HTTP status code 500
The requested was valid but the implementation is pending or an error occured
Headers
- Warning: required(string - pattern: ^\d{3} proseo-geotools \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-geotools (E1508) No or an uneven number of longitude/latitude values were provided
post /contains
Tests whether the polygon is completly contained in any region of type(s)
Query Parameters
- type: (array of )
String array used to determine which regions (specified in application.yml) to check. If the array parameter is null or empty, all available region types will be considered.
Body
Media type: application/json
Type: object
Properties- points: required(array of RestPoint)
The corner points (latitude/longitude pairs) defining the polygon
Items: RestPoint
- lat: required(number)
The latitude in double format
- lon: required(number)
The longitude in double format
- lat: required(number)
Example:
{
"points": [
{"lat": 23.3, "lon": 22.2},
{"lat": 23.4, "lon": 22.3}
]
}
/overlaps
Tests whether the polygon is overlaps any region of type(s)
Tests whether the polygon is overlaps any region of type(s)
get /overlaps
Tests whether the polygon is overlaps any region of type(s)
Query Parameters
- poly: required(array of )
String array containing latitude (uneven fields)/longitude (uneven fields) pairs in Double format, which together describe an area to be compared to a number of specified regions
- type: (array of )
String array used to determine which regions (specified in application.yml) to check. If the array parameter is null or empty, all available region types will be considered.
HTTP status code 200
Body
Media type: application/json
Type: boolean
Example:
trueHTTP status code 400
The request sent to the server contains invalid data
Headers
- Warning: required(string - pattern: ^\d{3} proseo-geotools \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-geotools (E1508) No or an uneven number of longitude/latitude values were provided
HTTP status code 500
The requested was valid but the implementation is pending or an error occured
Headers
- Warning: required(string - pattern: ^\d{3} proseo-geotools \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-geotools (E1508) No or an uneven number of longitude/latitude values were provided
post /overlaps
Tests whether the polygon is overlaps any region of type(s)
Query Parameters
- type: (array of )
String array used to determine which regions (specified in application.yml) to check. If the array parameter is null or empty, all available region types will be considered.
Body
Media type: application/json
Type: object
Properties- points: required(array of RestPoint)
The corner points (latitude/longitude pairs) defining the polygon
Items: RestPoint
- lat: required(number)
The latitude in double format
- lon: required(number)
The longitude in double format
- lat: required(number)
Example:
{
"points": [
{"lat": 23.3, "lon": 22.2},
{"lat": 23.4, "lon": 22.3}
]
}