Confluence Retirement

In an effort to consolidate USGS hosted Wikis, myUSGS’ Confluence service is scheduled for retirement on January 27th, 2023. The official USGS Wiki and collaboration space is now SharePoint. Please migrate existing spaces and content to the SharePoint platform and remove it from Confluence at your earliest convenience. If you need any additional information or have any concerns about this change, please contact myusgs@usgs.gov. Thank you for your prompt attention to this matter.
Skip to end of metadata
Go to start of metadata

 

Organization

GET (Retrieve), POST (Create), PUT (Update), and DELETE individual Organization records

GET: An individual Organization record

Request

GET /directory/organization/59605
HOST: www.sciencebase.gov
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
   "link":{
      "rel":"self",
      "url":"https://www.sciencebase.gov/directory/organization/59605"
   },
   "id":59605,
   "name":"Biological Carbon Sequestration",
   "displayText":"Biological Carbon Sequestration",
   "aliases":[
      {
         "id":900,
         "alias":"Carbon Sequest - Bio",
         "annotation":"FBMS name"
      }
   ],
   "active":true,
   "partyLocations":[

   ],
   "permissions":{
      "read":{
         "acl":[
            "PUBLIC"
         ]
      },
      "write":{
         "acl":[
            "ROLE:PlotDataAdmin",
            "ROLE:ScienceBase_DataAdmin"
         ]
      }
   },
   "parentId":24079,
   "parentName":"Office of the Associate Director for Climate and Land Use Change",
   "fbmsCodes":[
      {
         "id":383,
         "code":"GGHCGR0700",
         "annotation":"Old FBMS Code"
      }
   ],
   "extensions":{
      "usgsOrganization":{
         "orgCode":"GGHCGR0700",
         "fbmsCode":"GGHCGR0700",
         "fbmsName":"Carbon Sequest - Bio"
      }
   }
}

POST: Create a New Organization Record

Request

POST /directory/organization
HOST: www.sciencebase.gov
Content-Type: application/json
Accept: application/json

{
   
   "name":"Test Org",
   ....

}

Response

HTTP/1.1 201 Created
Content-Type: application/json;charset=utf-8

{
   
   "name":"Test Org",
   ....

}

PUT: Update an Existing Person Record

Request

PUT /directory/organization/18856
HOST: www.sciencebase.gov
Content-Type: application/json
Accept: application/json

{
   
   "name":"Test Org",
   ....

}

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
   
   "name":"Test Org",
   ....

}

DELETE: Remove a record

Request

DELETE /directory/organization/18856
HOST: www.sciencebase.gov
Content-Type: application/json

Response

HTTP/1.1 200 OK
application/json;charset=utf-8

 

 

 

Party Properties

 

ID

Unique identifier, an integer.  This is used in the URI to identify the record for GET, POST, PUT and DELETE.

"id":123

Name

A unique name for the record.  This property is required for a Party.

"name":"Some Organization"

DisplayName

An optional label to display instead of the record name.

"displayName": "Some Organization"

DisplayText

A read-only property add for convenience.

"displayText": "Some Organization"

URL

A web address for a page about the organization.

"url": "http://someorganization.gov"

Email

"email": "contact@someorganization.gov"

Description

"description": "This is what some organization is."

Rich Description HTML

"richDescriptionHtml": "<p>This is what <b>some organization</b> is about</p>."

Aliases

aliases: 
[
	{
		id: 1,
		alias: "S.O.",
		annotation: "abbreviation"
    }
]

Active

A boolean flag to indicate the record is active.

"active": true

Primary Location

primaryLocation: 
{
id: 1866,

name: "Some Org - Primary Location",

building: "DFC Bldg 810",

buildingCode: "KBT",

officePhone: "555-123-12345",

faxPhone: "555-123-12345",

mailAddress: {line1: "Box 123, Denver Federal Center, Mail Stop 321",

mailStopCode: "321",

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"


}

},


 

Logo Images

Image to use for the Logo.

"logoUrl": "http://someorganization.gov/mediumLogo.png"
"smallUrl": "http://someorganization.gov/smallLogo.png"

Parent Organization

"parentId": 456
"parentName": "The Bigger Org"

FBMS Codes

[
{"id":1, code:"XYZ", annotation:"a note about this code"},
{"id":2, code:"ZYX"}
]

Extensions

A collection of objects to extend the properties beyond the core Organization attributes for special type of organizations.  USGS organizations have a USGS extension for USGS specific attributes.

"extensions": {
	usgsOrganization: {
		orgCode: "GGWNYG0000",
 fbmsCode: "GGWNYG0000",
		fbmsName: "WASHINGTON WATER SCI CTR",
		oldFppsName: "WASHINGTON WATER SCI CTR",
		oldFfsName: "WASHINGTON WATER SCIENCE CNTR",
		oldFppsCode: "940300",
		oldOrgCode: "94090000"
 }
}
  • No labels