WaltersArtMuseum / api-thewalters-org

Repository for the Walters Art Museum collections API. This API provides images and data about objects in the collection of the Walters Art Museum in Baltimore, Maryland.
https://api.thewalters.org/
46 stars 4 forks source link

v1/museum/geographies Parameter Descriptions #39

Closed dylan-k closed 10 years ago

dylan-k commented 10 years ago

@kateblanch I've got 2 parameters I'm unsure how to describe for 'get geographies'. they are geoTerm and geoHierarchy. Can you help?

kateblanch commented 10 years ago

geoTerm = Is a geography "keyword" and would include values like a city, country, region, continent, land mass or body of water. Sample values could be: Paris, Asia, Adriatic Sea, Middle East, Boston, Pakistan, Pacific Ocean, Italy

geo heirarchy = Is a set of geography terms strung together from broadest to most specific, so that you can search geography terms within a broader range without necessarily knowing all the geographic terms that comprise a place in the world. It could also help end users derive more specific values they may be interested in searching on.

Sample values could be:

The Thesaurus of Geographic Names\World\continents\Africa\nations\Misr\regions\

The Thesaurus of Geographic Names\World\continents\Europe\nations\United Kingdom\countries\Scotland\unitary authorities\Edinburgh\inhabited places\

If you searched "Geo Heirarchy contains Mexico" -- you would return:

The Thesaurus of Geographic Names\World\continents\North and Central America\nations\México\states\Jalisco\inhabited places\

The Thesaurus of Geographic Names\World\continents\North and Central America\nations\México\states\México\inhabited places\

The Thesaurus of Geographic Names\World\continents\North and Central America\nations\México\states\Nuevo León\inhabited places\

The Thesaurus of Geographic Names\World\continents\North and Central America\nations\México\states\Tabasco\inhabited places\

The Thesaurus of Geographic Names\World\continents\North and Central America\nations\México\states\Veracruz\deserted settlements\

The Thesaurus of Geographic Names refers to the Getty structured vocabulary for geographies which is the museum industry's standard reference for assigning geography terms to museum art and artifacts. https://www.getty.edu/research/tools/vocabularies/tgn/

kateblanch commented 10 years ago

@dylan-k -- is this sufficient for you? If yes I will close.

dylan-k commented 10 years ago

Here's what I have now. Is this correct?

Name Type Description
geotype string Define this parameter in the request URI. Enter a string here to search within geoType, a geography "keyword" and would include values like a city, country, region, continent, land mass or body of water. Sample values could be: Paris, Asia, Adriatic Sea, Middle East, Boston, Pakistan, Pacific Ocean, Italy
geoTerm string Define this parameter in the request URI. Enter a string here to search within the specific location keyword called geoTerm. For example, the geoTerm value for Guatemala is Guatemala
geoHierarchy string Define this parameter in the request URI. Enter a string to search for within GeoHierarchy. GeoHierarchy is a hierarchical list that describes the location, in terms that range from the broad to the specific, according to The Getty Thesaurus of Geographic Names. For example, the GeoHierarchy for Guatemala reads: The Thesaurus of Geographic Names\\World\\continents\\North and Central America\\nations\\
kateblanch commented 10 years ago

Hi Dylan, this is askew a bit. Geo Type is not correct. See below for more info.

Geo Type -- This is a string that defines what type of geographical reference is being described. Choose from a set list of string values:

Source of Materials Place of Origin Place of Discovery Place Mentioned Place of Binding Place Depicted

GeoTerm - the definition for GeoTerm and the sample values are as I've provided in the first response. Basically combine what you have present for GeoType and GeoTerm and you should be good.

GeoHeirarchy - (and as per our quick phone discussion yesterday) - this does not consistently return a group of terms that you can paste your search term onto the end of (though very often it works that way). I think the way you've described it looks good. It may be a little vague but it's kind of weird data so let's just go with it?

kateblanch commented 10 years ago

@dylan-k -- I made these changes that I sent you this morning...so I am closing :)