Organizations Collection Resource
Search for organizations.
Query Form
https://www.sciencebase.gov/directory/organizations/queryForm
Query Parameters
name | values | description |
---|---|---|
name | (text) | an exact match on person.name (the record name). |
q | (text) | full text search on all fields |
active | true, false (boolean) | limit results to only parties with the active flag set to true or false |
email address | search by email address | |
max | (integer) | maximimun number of records to return |
offset | (integer) | skip the first N records, use this in combination with max page through results |
format | json, html, .... | specify the output format to be JSON or HTML. This can also be accomplished with an 'Accepts' header. |
sort | name, displayName, ... | the name of the field to sort by. When not specified, the results are sort by search score. Sorting by fields other than search score can negatively impact performance. |
order | asc, desc | sort in ascending or descending order |
Query Examples
- Find all organizations with the words 'water' and 'science'
https://www.sciencebase.gov/directory/organizations?q=water+science - Search for organizations with the words 'water' and 'science' where organization.active is true, return records 21-30
https://www.sciencebase.gov/directory/organizations?q=water+science&active=true&max=10&offset=20
GET: Search for Organizations
https://www.sciencebase.gov/directory/organizations?q=<keywords>
Request
GET directory/organizations?q=bio HTTP/1.1 HOST: www.sciencebase.gov Accept: application/json
Response
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "total":6, "selflink":{ "rel":"self", "url":"https://www.sciencebase.gov/directory/organizations?q=bio&format=json&max=10" }, "organizations":[ { "type":"organization", "id":59605, "name":"Biological Carbon Sequestration", "displayText":"Biological Carbon Sequestration", ... }, { "type":"organization", "id":17042, "name":"Office of the Chief Scientist for Ecosystems", "displayText":"Office of the Chief Scientist for Ecosystems", ... }, .... ] }