GET (Retrieve), POST (Create), PUT (Update), and DELETE individual Party records
Request
GET /directory/party/123 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
{
"link":{
"rel":"self",
"url":"https://www.sciencebase.gov/directory/person/1193"
},
"id":1193,
"name":"Sky Bristol/RGIO/USGS/DOI",
"displayName":"Sky Bristol",
"displayText":"Sky Bristol",
"url":"https://my.usgs.gov/catalog/Global/catalogParty/show/1193",
"email":"sbristol@usgs.gov",
"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>",
"aliases":[
{
"id":1,
"alias":"R. Sky Bristol",
"annotation":"publishing alias"
},
{
"id":2,
"alias":"Robert Schuyler Bristol",
"annotation":"full legal name"
},
{
"id":4,
"alias":"Bristol, RS",
"annotation":"publishing alias"
},
{
"id":3,
"alias":"Bristol, R. Sky",
"annotation":"publishing alias"
}
],
"active":true,
"primaryLocation":{
"id":1866,
"name":"Sky Bristol/RGIO/USGS/DOI - Primary Location",
"building":"DFC Bldg 810",
"buildingCode":"KBT",
"officePhone":"303-202-4181",
"faxPhone":"303-202-4710",
"mailAddress":{
"line1":"Box 25046, Denver Federal Center, Mail Stop 306",
"mailStopCode":"306",
"city":"Denver",
"state":"CO",
"zip":"80225-0046",
"country":"USA"
},
"streetAddress":{
"line1":"West 6th Ave. & Kipling St., DFC Bldg. 810",
"city":"Lakewood",
"state":"CO",
"zip":"80225-0046",
"country":"US"
},
"longitude":-105.1247994,
"latitude2":null
},
"partyLocations":[
{
"link":{
"rel":"self",
"href":"https://www.sciencebase.gov/directory/location/1866/get"
},
"locationId":1866,
"displayName":"Sky Bristol/RGIO/USGS/DOI - Primary Location",
"primary":true,
"sort":1
}
],
"permissions":{
"read":{
"acl":[
"PUBLIC"
]
},
"write":{
"acl":[
"USER:sbristol@usgs.gov",
"ROLE:PlotDataAdmin",
"ROLE:ScienceBase_DataAdmin"
]
}
}
}
|
Unique identifier, an integer. This is used in the URI to identify the record for GET, POST, PUT and DELETE.
"id":123 |
A unique name for the record. This property is required for a Party.
"name":"John Doe/DOI/USGS" |
An optional label to display instead of the record name.
"displayName": "John Doe" |
A read-only property add for convenience.
"displayText": "John Doe" |
A web address for a page about the party.
"url": "http://example.gov/homePageOf/jdoe" |
"email": "jdoe@usgs.gov" |
"description": "The happy employee who works on stuff." |
"richDescriptionHtml": "The <b>happy</b> employe who “works” on <i>stuff</i>." |
aliases:
[
{
id: 3,
alias: "Doe, John",
annotation: "publishing alias"
},
{
id: 4,
alias: "Doe, J",
annotation: "publishing alias"
}
] |
A boolean flag to indicate the record is active.
"active": true |
primaryLocation:
{
id: 1866,
name: "Sky Bristol/RGIO/USGS/DOI - Primary Location",
building: "DFC Bldg 810",
buildingCode: "KBT",
officePhone: "303-202-4181",
faxPhone: "303-202-4229",
mailAddress: {line1: "Box 25046, Denver Federal Center, Mail Stop 306",
mailStopCode: "306",
city: "Denver",
state: "CO",
zip: "80225-0046",
country: "USA"
},
streetAddress: {line1: "West 6th Ave. & Kipling St., DFC Bldg. 810",
city: "Lakewood",
state: "CO",
zip: "80225-0046",
country: "US"
},
latitude2: null
},
|