# SESAR Documentation ## Get Started - [Welcome to SESAR documentation](https://docs.geosamples.org/readme.md): Documentation for registering, managing, and finding samples with SESAR. - [Register your first sample](https://docs.geosamples.org/register-your-first-sample.md): Go from nothing to a registered sample with an IGSN ID. - [Find your path](https://docs.geosamples.org/find-your-path.md): Where to go depending on what you're trying to do. - [Getting help](https://docs.geosamples.org/getting-help.md) ## User Guide - [Test Site for SESAR](https://docs.geosamples.org/for-researchers/accounts-and-access/test-site-for-sesar.md): Use our testing site to practice registering samples and getting familiar with our functions. - [Create a SESAR Account](https://docs.geosamples.org/for-researchers/accounts-and-access/readme.md): Here is the workflow for creating an individual researcher and Team account. - [Choose a SESAR Code](https://docs.geosamples.org/for-researchers/accounts-and-access/choose-a-sesar-code.md): To register samples, all users must have a SESAR Code. - [Shared SESAR Code Permission](https://docs.geosamples.org/for-researchers/accounts-and-access/share-a-code-with-your-lab-group.md): Shared SESAR Codes are no longer available unless you have pre-existing permissions. - [Sample Landing Pages](https://docs.geosamples.org/for-researchers/accounts-and-access/sample-landing-pages.md): Sample landing pages are public profiles of your sample and metadata. They are generated for each sample registered in SESAR. The pages reflect updated sample metadata. - [Request API Access](https://docs.geosamples.org/for-researchers/accounts-and-access/request-web-services-access.md) - [Using SESAR Teams](https://docs.geosamples.org/for-researchers/accounts-and-access/using-sesar-teams.md) - [Choose a Registration Method](https://docs.geosamples.org/for-researchers/register-samples/choose-a-registration-method.md): Determine which registration method works best for your samples and workflow. - [Individual Sample Registration](https://docs.geosamples.org/for-researchers/register-samples/individual-registration.md): For registering individual or single samples. - [Batch Sample Registration](https://docs.geosamples.org/for-researchers/register-samples/batch-registration.md): For registering multiple samples. - [Initiative, Platform, and Launch Platform](https://docs.geosamples.org/for-researchers/register-samples/initiative-platform-and-launch-platform.md): Initiative, Platform, and Launch Platform are now entries that are linked to your samples. - [Sample Images](https://docs.geosamples.org/for-researchers/register-samples/sample-images.md) - [Data and Outputs](https://docs.geosamples.org/for-researchers/register-samples/data-and-outputs.md) - [Sample Groups](https://docs.geosamples.org/for-researchers/register-samples/sample-groups.md) - [Pre-registration Before Fieldwork](https://docs.geosamples.org/for-researchers/register-samples/pre-register-before-fieldwork.md): Users who require IGSNs before going to the field. - [Register a legacy collection](https://docs.geosamples.org/for-researchers/register-samples/register-a-legacy-collection.md) - [Parent-Child Relationships](https://docs.geosamples.org/for-researchers/register-samples/parent-child-relationships.md) - [Updating Sample Metadata](https://docs.geosamples.org/for-researchers/manage-samples/update-sample-metadata.md) - [Transfer Ownership](https://docs.geosamples.org/for-researchers/manage-samples/transfer-ownership.md) - [Embargo Samples](https://docs.geosamples.org/for-researchers/manage-samples/embargo-samples.md) - [Deactivating Samples](https://docs.geosamples.org/for-researchers/manage-samples/deactivate-samples.md) - [Print Labels & QR Codes](https://docs.geosamples.org/for-researchers/manage-samples/print-labels-and-qr-codes.md) - [Cite IGSN IDs in Publications](https://docs.geosamples.org/for-researchers/cite-and-credit/cite-igsn-ids-in-publications.md) - [Crediting SESAR](https://docs.geosamples.org/for-researchers/cite-and-credit/credit-sesar.md) - [SESAR in Grant Proposals](https://docs.geosamples.org/for-researchers/cite-and-credit/sesar-in-grant-proposals.md) - [Page 1](https://docs.geosamples.org/for-researchers/troubleshooting/page-1.md) ## Metadata Schema - [Overview & data model](https://docs.geosamples.org/metadata-schema/readme.md): What SESAR stores about a sample, what is required, and how fields map from legacy and external schemas. - [Schema quick guide](https://docs.geosamples.org/metadata-schema/schema-quick-guide.md): List of all SESAR metadata fields and their definitions - [Field requirements](https://docs.geosamples.org/metadata-schema/field-requirements.md): Fields SESAR requires to register a sample. - [Detailed database schema](https://docs.geosamples.org/metadata-schema/database-schema.md): Tables, columns, relationships, and ER diagrams for the SESAR database. - [Field crosswalk (old -> new)](https://docs.geosamples.org/metadata-schema/migration-from-the-legacy-schema/field-crosswalk-old-greater-than-new.md): How SESAR 1.0 sample fields map to the current schema. - [Renamed vocabularies](https://docs.geosamples.org/metadata-schema/migration-from-the-legacy-schema/renamed-vocabularies.md): Old SESAR vocabulary names and the lists they map to now. - [Sample type to object type](https://docs.geosamples.org/metadata-schema/migration-from-the-legacy-schema/sample-type-to-object-type.md): How SESAR 1.0 sample type values map to object type. - [Classification to material type](https://docs.geosamples.org/metadata-schema/migration-from-the-legacy-schema/classification-to-material-type.md): How SESAR 1.0 classification values map to material type. - [DataCite](https://docs.geosamples.org/metadata-schema/crosswalks/datacite.md): How SESAR sample metadata maps to DataCite DOI records. - [Darwin Core](https://docs.geosamples.org/metadata-schema/crosswalks/darwin-core.md) - [iSamples](https://docs.geosamples.org/metadata-schema/crosswalks/isamples.md) ## Vocabularies - [About SESAR Vocabularies](https://docs.geosamples.org/vocabularies/readme.md): Controlled term lists used in SESAR sample metadata, and how to request additions. - [Request a term](https://docs.geosamples.org/vocabularies/request-a-term.md) - [Object Type](https://docs.geosamples.org/vocabularies/vocabularies/object-type.md): Kind of physical object the sample is. - [Material Type](https://docs.geosamples.org/vocabularies/vocabularies/material-type.md): Material the sample consists of. - [Sampling Method](https://docs.geosamples.org/vocabularies/vocabularies/sampling-method.md): Method by which the sample was collected. - [Location Method](https://docs.geosamples.org/vocabularies/vocabularies/location-method.md): How the location of a sample was determined. - [Platform Type](https://docs.geosamples.org/vocabularies/vocabularies/platform-type.md): Kind of platform used to collect a sample. - [Launch Type](https://docs.geosamples.org/vocabularies/vocabularies/launch-type.md): Kind of launch used for sampling. - [Country](https://docs.geosamples.org/vocabularies/vocabularies/country.md): Country where the sample was collected. ## API - [Overview](https://docs.geosamples.org/api/readme.md): Call the SESAR API to register, find, and update sample metadata. - [Authentication](https://docs.geosamples.org/api/authentication.md): Authenticate API requests with a JWT from Developer Settings. - [Find or fetch a sample](https://docs.geosamples.org/api/find-or-fetch-a-sample.md): Search the catalog or fetch one sample by IGSN. - [Register a sample](https://docs.geosamples.org/api/register-a-sample.md): Register a sample with the SESAR API. - [Update a sample](https://docs.geosamples.org/api/update-a-sample.md): Change metadata on a sample you can edit. - [Archives](https://docs.geosamples.org/api/archives.md) - [Auth](https://docs.geosamples.org/api/auth.md) - [Individuals](https://docs.geosamples.org/api/individuals.md) - [Initiatives](https://docs.geosamples.org/api/initiatives.md) - [Institutions](https://docs.geosamples.org/api/institutions.md) - [Launch Platforms](https://docs.geosamples.org/api/launch-platforms.md) - [Locations](https://docs.geosamples.org/api/locations.md) - [Platforms](https://docs.geosamples.org/api/platforms.md) - [Related Resources](https://docs.geosamples.org/api/related-resources.md) - [Sample Groups](https://docs.geosamples.org/api/sample-groups.md) - [Samples](https://docs.geosamples.org/api/samples.md) - [SESAR Codes](https://docs.geosamples.org/api/sesar-codes.md) - [Vocabulary](https://docs.geosamples.org/api/vocabulary.md) - [Models](https://docs.geosamples.org/api/models.md) - [Migrating from v1 web services](https://docs.geosamples.org/api/migrating-from-v1-web-services.md): Move from SESAR 1.0 PHP web services to the JSON API. --- # 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 This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.geosamples.org/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.