> For the complete documentation index, see [llms.txt](https://docs.geosamples.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geosamples.org/api/vocabulary.md).

# Vocabulary

## List countries

> Returns active countries. Optional \`query\` filters by country label or ISO 3166 code (case-insensitive substring). When there are no matches, \`data\` is an empty array.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CountrySearchSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Country"},"description":"Matching active countries."}},"required":["data"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","readOnly":true},"iso3166code":{"type":"string","readOnly":true,"nullable":true}},"required":["id","iso3166code","label"]}}},"paths":{"/api/vocab/countries/":{"get":{"operationId":"vocab_countries_retrieve","description":"Returns active countries. Optional `query` filters by country label or ISO 3166 code (case-insensitive substring). When there are no matches, `data` is an empty array.","summary":"List countries","parameters":[{"in":"query","name":"query","schema":{"type":"string"},"description":"Filter by label or ISO 3166 code substring."}],"tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountrySearchSuccess"}}},"description":""}}}}}}
```

## List launch types

> Returns all launch type vocabulary records for launch platforms.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LaunchTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LaunchType"},"description":"Launch types."}},"required":["data"]},"LaunchType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}},"paths":{"/api/vocab/launch-types/":{"get":{"operationId":"vocab_launch_types_retrieve","description":"Returns all launch type vocabulary records for launch platforms.","summary":"List launch types","tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchTypeListSuccess"}}},"description":""}}}}}}
```

## List location methods

> Returns all location method vocabulary records used when describing sample collection locations.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LocationMethodListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LocationMethod"},"description":"Location methods."}},"required":["data"]},"LocationMethod":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}},"paths":{"/api/vocab/location-methods/":{"get":{"operationId":"vocab_location_methods_retrieve","description":"Returns all location method vocabulary records used when describing sample collection locations.","summary":"List location methods","tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationMethodListSuccess"}}},"description":""}}}}}}
```

## List material types (flat)

> Returns all material type vocabulary rows as a flat list.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MaterialTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MaterialType"},"description":"Material types."}},"required":["data"]},"MaterialType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"material_type_uri":{"type":"string","nullable":true,"maxLength":255},"parent_material_types":{"type":"array","items":{"type":"string"},"readOnly":true},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255},"for_registration":{"type":"boolean"},"suppress_from_search":{"type":"boolean"}},"required":["for_registration","id","label","parent_material_types","suppress_from_search"]}}},"paths":{"/api/vocab/material-types/":{"get":{"operationId":"vocab_material_types_retrieve","description":"Returns all material type vocabulary rows as a flat list.","summary":"List material types (flat)","tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaterialTypeListSuccess"}}},"description":""}}}}}}
```

## List material types (hierarchical)

> Returns material types rooted at entries with no parent links; each node includes a \`children\` array. Types with multiple parents appear under each parent.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MaterialTypeHierarchicalListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MaterialTypeHierarchical"},"description":"Root material types with nested children."}},"required":["data"]},"MaterialTypeHierarchical":{"type":"object","description":"OpenAPI / docs shape for nested material types. Prefer util.build_material_type_tree for responses.","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"material_type_uri":{"type":"string","nullable":true,"maxLength":255},"for_registration":{"type":"boolean"},"suppress_from_search":{"type":"boolean"},"children":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Child material types (same shape, recursive)."}},"required":["children","for_registration","id","label","suppress_from_search"]}}},"paths":{"/api/vocab/material-types/hierarchical/":{"get":{"operationId":"vocab_material_types_hierarchical_retrieve","description":"Returns material types rooted at entries with no parent links; each node includes a `children` array. Types with multiple parents appear under each parent.","summary":"List material types (hierarchical)","tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaterialTypeHierarchicalListSuccess"}}},"description":""}}}}}}
```

## List object types (flat)

> Returns all object type vocabulary records as a flat list.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ObjectTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectType"},"description":"Object types."}},"required":["data"]},"ObjectType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"parent_type":{"type":"string","readOnly":true},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["hierarchical_label","id","label","parent_type"]}}},"paths":{"/api/vocab/object-types/":{"get":{"operationId":"vocab_object_types_retrieve","description":"Returns all object type vocabulary records as a flat list.","summary":"List object types (flat)","tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTypeListSuccess"}}},"description":""}}}}}}
```

## List object types (hierarchical)

> Returns object types rooted at entries with no parent type; each node includes a \`children\` array.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ObjectTypeHierarchicalListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeHierarchical"},"description":"Root object types with nested children."}},"required":["data"]},"ObjectTypeHierarchical":{"type":"object","properties":{"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"children":{"type":"string","readOnly":true}},"required":["children","hierarchical_label","label"]}}},"paths":{"/api/vocab/object-types/hierarchical/":{"get":{"operationId":"vocab_object_types_hierarchical_retrieve","description":"Returns object types rooted at entries with no parent type; each node includes a `children` array.","summary":"List object types (hierarchical)","tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectTypeHierarchicalListSuccess"}}},"description":""}}}}}}
```

## List platform types

> Returns all platform type vocabulary records for collection platforms.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PlatformTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PlatformType"},"description":"Platform types."}},"required":["data"]},"PlatformType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}},"paths":{"/api/vocab/platform-types/":{"get":{"operationId":"vocab_platform_types_retrieve","description":"Returns all platform type vocabulary records for collection platforms.","summary":"List platform types","tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformTypeListSuccess"}}},"description":""}}}}}}
```

## List sampling methods

> Returns sampling method vocabulary. Optional \`q\` filters by label (case-insensitive substring). When \`q\` is provided and nothing matches, \`data\` is an empty array.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SamplingMethodListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SamplingMethod"},"description":"Sampling methods."}},"required":["data"]},"SamplingMethod":{"type":"object","properties":{"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":1000},"method_uri":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true,"maxLength":255},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["label"]}}},"paths":{"/api/vocab/sampling-methods/":{"get":{"operationId":"vocab_sampling_methods_retrieve","description":"Returns sampling method vocabulary. Optional `q` filters by label (case-insensitive substring). When `q` is provided and nothing matches, `data` is an empty array.","summary":"List sampling methods","parameters":[{"in":"query","name":"q","schema":{"type":"string"},"description":"Filter by label substring (case-insensitive)."}],"tags":["Vocabulary"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamplingMethodListSuccess"}}},"description":""}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.geosamples.org/api/vocabulary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.