When you formulate a REST query, you have to decide which resource type you want. The resource type is the first word in your query and determines the format of the response data. The resource types currently offered are described below.
type is a data model to represent educational resources related to
agriculture and biodiversity.
The RESTful URL to request data from the akif resource begins:
type is a data model to represent bibliographic references on
agricultural research and technology.
The RESTful URL to request data from the agrif resource begins:
Query features can be broken into two sections: What do you want? and How do you want it?
This is just a keyword search against all the text fields. If don't
know anything about the fields, but you know you want
, use the
anywhere in any field)
You don't know what you want, but you know it has to have
in the english title. It doesn't just have to be the title, though.
You can search for terms within any textual field except:
You do not need the
parameter when searching within a specific field. Use the field's
name as a URL query string parameter instead.
You can combine specific field searches with simple search. You can
also combine multiple field-specific searches. When combining field
parameters, separate them with an ampersand (
). These combinations are exclusive, meaning that result items
fulfill all simple and field-specific criteria.
anywhere in the
anywhere in the
Field & simple:
in any field.)
The eduOER Search API understands dates. Combine that with the fielded search above, and you've got a pretty spiffy way of finding records that have fields that fall before, after, and between dates.
The following examples search the
field which is the time an akif or agrif document was created.
(items that were created on
Say you already have the
you want, and you're just looking to get the rest of the metadata
for that item. Simply add the
to the end of the
request. Bonus: You can search for multiple
's in the given
by separating the ids with a comma (,).
(item with the given
Sort stuff using the
parameter. We’ll sort stuff in ascending order by default, but
if you'd like to flip things, set the
in any field, sorted by the
in any field, sorted by
in any field, sorted by their english title)
Facets tell you the most common values for certain fields in a
collection of items. We return a couple different types of facets
depending upon the field you're looking for. For date fields, we'll
send back facets of type
(which is what it sounds like). For complex text fields, we'll break
it down for you into a
type. For simple text fields, we'll also send back a
type but with unadulterated values. And for geographic types, we'll
give you a
By default, we'll give you 10 items. If that's not enough, you can
get the next ten items incrementing the
parameter (it's one-indexed). If that's still not enough, you can
pull more items per page by using the
parameter (we'll limit you to 100 items per page because greediness
is a vice).
Let's get this APIarty started.
(items with both
sea in any field and
(the first 25 items with either