Skip to content

Latest commit

 

History

History
215 lines (189 loc) · 5.15 KB

api.md

File metadata and controls

215 lines (189 loc) · 5.15 KB
Raw
layout title
page
API

Current cloud deployments

REST API v1 Resources

Some implementations provide more features, e.g. PNG rendering.

SVG

Operations to retrieve GEO label SVG representations.

GET /api/v1/geolabel

Query parameters

Name Required Data Type Description
metadata* optional URL Encoded URL of producer metadata document. Metadata document must be ISO19115, ISO19157, FGDC or GVQ-PQM compliant.
feedback* optional URL Encoded URL of feedback document. Feedback document must be GVQ-UQM compliant.
parent_metadata optional URL Encoded URL of parent dataset's producer metadata document. Metadata document must be ISO19115, ISO19157, FGDC or GVQ-PQM compliant.
parent_feedback optional URL Encoded URL of parent dataset's feedback document. Feedback document must be GVQ-UQM compliant.
size optional int Required size of the GEO label SVG in pixels. If not specified, the default size is 200x200 pixels.

* At least one of these parameters must be provided.

POST /api/v1/geolabel

Name Required Data Type Description
metadata* optional File Producer XML metadata document. Metadata document must be ISO19115, ISO19157, FGDC or GVQ-PQM compliant.
feedback* optional File Feedback XML document. Feedback document must be GVQ-UQM compliant.
parent_metadata optional File Parent dataset's producer XML metadata document. Metadata document must be ISO19115, ISO19157, FGDC or GVQ-PQM compliant.
parent_feedback optional File Parent dataset's feedback XML document. Feedback document must be GVQ-UQM compliant.
size optional int Required size of the GEO label SVG in pixels. If not specified, the default size is 200x200 pixels.

* Although optional, at least one of these parameters must be provided.

Facets

Operations to retrieve GEO label JSON representations.

GET /api/v1/facets

Name Required Data Type Description
metadata* optional URL Encoded URL of producer metadata document. Metadata document must be ISO19115, ISO19157, FGDC or GVQ-PQM compliant.
feedback* optional URL Encoded URL of feedback document. Feedback document must be GVQ-UQM compliant.

* At least one of these parameters must be provided.

POST /api/v1/facets

Name Required Data Type Description
metadata* optional File Producer XML metadata document. Metadata document must be ISO19115, ISO19157, FGDC or GVQ-PQM compliant.
feedback* optional File Feedback XML document. Feedback document must be GVQ-UQM compliant.

* At least one of these parameters must be provided.

Drilldown

Operations to retrieve styled representations of metadata records, providing details on specific facets.

GET /api/v1/drilldown

Name Required Data Type Description
metadata optional URL URL to producer metadata document. Metadata document must be ISO19115, ISO19157, FGDC or GVQ-PQM compliant.
feedback optional URL URL to feedback document. Feedback document must be GVQ-UQM compliant.
facet required string GEO label facet identifier. Allowed values:
  • producer_profile
  • producer_comments
  • lineage_information
  • standards_complaince
  • quality_information
  • user_feedback
  • expert_review
  • citations_information