Skip to end of metadata
Go to start of metadata

 

Organizations Collection Resource

Search for organizations.

Query Form

https://www.sciencebase.gov/directory/organizations/queryForm

 

Query Parameters

namevaluesdescription
name(text)an exact match on person.name (the record name).
q(text)full text search on all fields
activetrue, false (boolean)limit results to only parties with the active flag set to true or false
emailemail addresssearch 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
formatjson, html, ....specify the output format to be JSON or HTML. This can also be accomplished with an 'Accepts' header.
sortname, 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.
orderasc, descsort in ascending or descending order

Query Examples

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",
         ...
      },
      
      ....
   ]
}
  • No labels