Query filters¶
These filters can be applied by providing key-value pairs as part of the
query string in your HTTP request, where the key is equal to the
querystring_key
entry below, and the value is formatted like one of the
example_values
. See Narrowing your query for examples.
-
class
voeventdb.server.restapi.v1.filters.
AuthoredSince
[source]¶ Return only VOEvents with a
Who.Date
entry dated after the given time.(Time-range is inclusive, i.e.
>=
)Date-time strings passed should be in a format parseable by the iso8601.parse_date() function (see
example_values
).-
querystring_key
= u'authored_since'¶
-
example_values
= [u'2015-10-09T21:34:19', u'2015-10-09', u'2015-10']¶
-
-
class
voeventdb.server.restapi.v1.filters.
AuthoredUntil
[source]¶ Return only VOEvents with a
Who.Date
entry dated before the given time.(Time-range is inclusive, i.e.
<=
)Date-time strings passed should be in a format parseable by the iso8601.parse_date() function (see
example_values
).-
querystring_key
= u'authored_until'¶
-
example_values
= [u'2015-10-09T21:34:19', u'2015-10-09', u'2015-10']¶
-
-
class
voeventdb.server.restapi.v1.filters.
CitedByAny
[source]¶ Return only VOEvents which are cited by another VOEvent in the database.
Applied via query-strings
cited=true
orcited=false
-
querystring_key
= u'cited'¶
-
example_values
= [u'true', u'false']¶
-
-
class
voeventdb.server.restapi.v1.filters.
ConeSearch
[source]¶ Return only VOEvents with co-ords in the given cone.
Cone specified as a 3-element list in JSON format:
[ra,dec,radius]
(values in decimal degrees).
-
querystring_key
= u'cone'¶
-
example_values
= [u'[10,20,5]', u'[359.9,-30,5]']¶
-
-
class
voeventdb.server.restapi.v1.filters.
CoordsAny
[source]¶ Return only VOEvents which have / do not have associated co-ord positions.
Applied via query-strings
coord=true
orcoord=false
-
querystring_key
= u'coord'¶
-
example_values
= [u'true', u'false']¶
-
-
class
voeventdb.server.restapi.v1.filters.
DecGreaterThan
[source]¶ Return VOEvents with position with Dec greater than given value.
Dec should be specified in decimal degrees.
-
querystring_key
= u'dec_gt'¶
-
example_values
= [u'0', u'-45.123']¶
-
-
class
voeventdb.server.restapi.v1.filters.
DecLessThan
[source]¶ Return VOEvents with position with Dec less than given value.
Dec should be specified in decimal degrees.
-
querystring_key
= u'dec_lt'¶
-
example_values
= [u'0', u'-45.123']¶
-
-
class
voeventdb.server.restapi.v1.filters.
IvornContains
[source]¶ Return only VOEvents which have the given substring in their IVORN.
-
querystring_key
= u'ivorn_contains'¶
-
example_values
= [u'BAT_GRB_Pos', u'XRT']¶
-
-
class
voeventdb.server.restapi.v1.filters.
IvornPrefix
[source]¶ Return only VOEvents where the IVORN begins with the given value.
Note that the value passed should be URL-encoded if it contains the
#
character e.g.:quote_plus('ivo://nvo.caltech/voeventnet/catot#1404')
-
querystring_key
= u'ivorn_prefix'¶
-
example_values
= [u'ivo://nasa.gsfc.gcn', 'ivo%3A%2F%2Fnvo.caltech%2Fvoeventnet%2Fcatot%231404']¶
-
-
class
voeventdb.server.restapi.v1.filters.
RefAny
[source]¶ Return only VOEvents which make / don’t make reference to any other VOEvents.
Applied via query-strings
ref_any=true
orref_any=false
. NB ‘true’/’false’ string-values are case-insensitive, so e.g. ‘true’, ‘True’, ‘TRUE’, ‘tRUe’ are all valid.-
querystring_key
= u'ref_any'¶
-
example_values
= [u'true', u'True', u'false']¶
-
-
class
voeventdb.server.restapi.v1.filters.
RefContains
[source]¶ Return VOEvents which reference an IVORN containing the given substring.
-
querystring_key
= u'ref_contains'¶
-
example_values
= [u'BAT_GRB_Pos', u'GBM_Alert']¶
-
-
class
voeventdb.server.restapi.v1.filters.
RefExact
[source]¶ Return only VOEvents which contain a ref to the given (url-encoded) IVORN.
-
querystring_key
= u'ref_exact'¶
-
example_values
= ['ivo%3A%2F%2Fnasa.gsfc.gcn%2FSWIFT%23BAT_GRB_Pos_649113-680', 'ivo%3A%2F%2Fnasa.gsfc.gcn%2FFermi%23GBM_Alert_2015-08-10T14%3A49%3A38.83_460910982_1-814']¶
-