People Collection Resource
Search for people.
Query Form
https://www.sciencebase.gov/directory/people/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 | |
organizationId | ID | search by organization ID |
username | myUSGS username | the username of a myUSGS account, typically an email address |
firstName | (text) | search the person.firstName field |
middleName | (text) | search the person.middleName field |
lastName | (text) | search the person.lastName field |
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 people with the words 'Bristol' and 'Sky' in the person.name field
https://www.sciencebase.gov/directory/people?name=Bristol+Sky - Find people with the words 'Bristol' and 'Sky' in any field
https://www.sciencebase.gov/directory/people?q=Bristol+Sky - Find people with the first name of 'Jill', sorting by displayName and returning the first 25 results
https://www.sciencebase.gov/directory/people?firstName=Jill&sort=displayName&max=25 - Find people with the first name of 'Sky' and organizationId of 59505
https://www.sciencebase.gov/directory/people?firstName=Sky&organizationId=59505 - Find people with the myUSGS of 'sbristol@usgs.gov'
https://www.sciencebase.gov/directory/people?username=sbristol@usgs.gov
GET: Query for People
http://www.sciencebase.gov/directory/people?q=<keywords>
Request
GET /directory/people?q=Bristol HTTP/1.1 HOST: www.sciencebase.gov Accept: application/json
Alternative example using query param instead of Accept header
Response
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "total":2, "selflink":{ "rel":"self", "url":"https://www.sciencebase.gov/directory/people?q=Bristol&format=json&max=10" }, "people":[ { "type":"person", "id":1193, "name":"Sky Bristol/RGIO/USGS/DOI", "displayName":"Sky Bristol", "displayText":"Sky Bristol", "email":"sbristol@usgs.gov", "url":"https://my.usgs.gov/catalog/Global/catalogParty/show/1193", "description":"Sky Bristol currently manages the Applied Earth Systems Informatics Research branch in the Core Science Analytics and Synthesis program of the Core Science Systems Mission Area. He strives to develop innovative technology solutions for USGS science.", "richDescriptionHtml":"<p>\n\tSky Bristol currently manages the Applied Earth Systems Informatics Research branch in the Core Science Analytics and Synthesis program of the Core Science Systems Mission Area. He strives to develop innovative technology solutions for USGS science.<\/p>", "note":null, "aliases":[ "R. Sky Bristol", "Bristol, R. Sky", "Robert Schuyler Bristol", "Bristol, RS" ], "active":true, "primaryLocation":{ "id":1866, "name":"Sky Bristol/RGIO/USGS/DOI - Primary Location", "shortName":null, "description":null, "building":"DFC Bldg 810", "buildingCode":"KBT", "phone":"3032024181", "faxPhone":"3032024710", "areaCode":"303", "mailAddress":{ "line1":"Box 25046, Denver Federal Center, Mail Stop 306", "line2":null, "mailStopCode":"306", "city":"Denver", "state":"CO", "zip":"80225-0046", "country":"USA" }, "streetAddress":{ "line1":"West 6th Ave. & Kipling St., DFC Bldg. 810", "line2":null, "mailStopCode":null, "city":"Lakewood", "state":"CO", "zip":"80225-0046", "country":"US" } }, "firstName":"Sky", "lastName":"Bristol", "jobTitle":"Manager Applied Earth Systems Informatics Research", "cellPhone":"3032414122", "username":"sbristol@usgs.gov", "organization":{ "id":59505, "displayText":"Applied Earth Systems Informatics Research" }, "permissions":{ "read":{ "acl":[ "ROLE:ScienceBase_DataAdmin", "ROLE:PlotDataAdmin" ] }, "write":{ "acl":[ "ROLE:ScienceBase_DataAdmin", "ROLE:PlotDataAdmin" ] } } }, { "type":"person", "id":1192, "name":"Tracy A Bristol-Strock/WRD/USGS/DOI", "displayName":"Tracy A Bristol-Strock", "displayText":"Tracy A Bristol-Strock", "email":"tbristol@usgs.gov", "url":null, "description":null, "richDescriptionHtml":null, "note":null, "aliases":[ ], "active":true, "primaryLocation":{ "id":1865, "name":"Tracy A Bristol-Strock/WRD/USGS/DOI - Primary Location", "shortName":null, "description":null, "building":null, "buildingCode":"AHA", "phone":"5182855626", "faxPhone":"5182855601", "areaCode":"518", "mailAddress":{ "line1":"District Office - Troy, 425 Jordan Road", "line2":null, "mailStopCode":null, "city":"Troy", "state":"NY", "zip":"12180", "country":"USA" }, "streetAddress":{ "line1":"425 Jordan Road", "line2":null, "mailStopCode":null, "city":"Troy", "state":"NY", "zip":"12180", "country":"US" } }, "personalTitle":"Mrs.", "firstName":"Tracy", "middleName":"A", "lastName":"Bristol-Strock", "jobTitle":"Administrative Officer", "username":"tbristol@usgs.gov", "organization":{ "id":17211, "displayText":"New York Water Science Center" }, "permissions":{ "read":{ "acl":[ "ROLE:ScienceBase_DataAdmin", "ROLE:PlotDataAdmin" ] }, "write":{ "acl":[ "ROLE:ScienceBase_DataAdmin", "ROLE:PlotDataAdmin" ] } } } ] }