Download OpenAPI specification:Download
Metaserver provides CoMET services without creating a metadata record, resolves xlinks, and translates between different XML standards
For more information on the ISO Standard 19115-2, please visit this documentation link.
This API is documented in OpenAPI format and is displayed using ReDoc. In addition to standard OpenAPI syntax, ReDoc uses a few vendor extensions.
Users must first establish a user session in order to use the API endpoints. Sessions are established by sending login credentials via an HTTP request to the login URL. The server will create a cookie that contains an API Key (JSESSIONID) that authorizes each request. The cookie must be sent with each request and is valid so long as the session stays alive.
Login Requirements:
Users must first establish a user session to use the API endpoints. Sessions are established by sending login credentials via an HTTP request to the login URL. The server will create a cookie that contains an API Key (JSESSIONID) that authorizes each request. The cookie must be sent with each request and is valid so long as the session stays alive.
# This script saves your apiKey (JSESSIONID) to a cookie file on disk. This file, cookie.txt, is sent in other examples in this documentation curl -X 'POST' \ 'https://data.noaa.gov/cedit/login/wsLogin' \ -H 'accept: */*' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'username=your.username' -d 'password=yourPassword' \ --cookie-jar cookies.txt
Record Services currently supports validating ISO 19115-2 metadata, validating online resource links, checks to see if a resolved xlinks creates valid XML, and provides the Rubric V2 scores as a json object.
Resolves xlinks to xml components and validates resulting document against the ISO 19115-2 standard
| filename required | string Filename or name of record being sent |
AcceptsISO 19915-2 XML.
| gmi:MI_Metadata | object |
{- "service": "isovalidatecheck",
- "date-time": "2022-09-27T13:48:31.452Z",
- "record": "example.xml",
- "error_count": "0"
}Returns Rubric V2 scores as json object
| filename required | string Filename or name of record being sent |
Accepts XML in ISO 19115-2, resolves xlinks,
| gmi:MI_Metadata | object |
{- "service": "transisotorubricv2",
- "date-time": "2022-09-27T13:48:31.452Z",
- "record": "example.xml",
- "error_count": "0",
- "totals_array": [
- {
- "total_score": "34%",
- "total_ec": "2"
}
], - "categories_array": [
- {
- "category_name": "Identification",
- "category_score": "33%",
- "total_ec": "0"
}, - {
- "category_name": "Access",
- "category_score": "0%",
- "total_ec": "0"
}, - {
- "category_name": "Coverage",
- "category_score": "0%",
- "total_ec": "0"
}, - {
- "category_name": "Content",
- "category_score": "0%",
- "total_ec": "0"
}, - {
- "category_name": "History",
- "category_score": "0%",
- "total_ec": "0"
}, - {
- "category_name": "Quality",
- "category_score": "0%",
- "total_ec": "1"
}, - {
- "category_name": "Connections",
- "category_score": "100%",
- "total_ec": "1"
}, - {
- "category_name": "Metadata",
- "category_score": "100%",
- "total_ec": "0"
}, - {
- "category_name": "Associated Resource",
- "category_score": "0%",
- "total_ec": "0"
}, - {
- "category_name": "Attribution",
- "category_score": "0%",
- "total_ec": "0"
}
]
}Resolves xlinks to xml components and returns a success if XML document is created. Doesn't return errors if xlink or resulting XML isn't valid ISO 19115-2
Accepts XML in ISO 19115-2 and resolves xlinks to xml components. Only responds 200 for success or 400 for failure. See Transform to get a resolved document to save.
| gmi:MI_Metadata | object |
{- "statusCode": "200",
- "statusMessage": "success"
}Verify online resource links within the ISO tag CI_OnlineResource are valid URLs. This API can be slow depending on the number links to be checked and the link status.
Accepts ISO 19115-2 XML
| gmi:MI_Metadata | object |
{- "service": "olrlinkcheck",
- "date-time": "2022-09-27T13:48:31.452Z",
- "record": "example.xml",
- "error_count": "0"
}Upload an xml document by rawxml or url and transform it to a requested format
| inputLocation | string Enum: "rawxml" "url" Input Options: rawxml, url |
| recordAction | string Enum: "resolve" "none" "isovalidatecheck" "olrlinkcheck" "nceilandingpage" "transisotorubricv2" "transisotorubric" "transncmltorubric" "transncmltoiso" "fgdctoiso" resolve - Resolve URL references to components. Input: 19139 schema valid XML file. Response: ISO 19115-2 XML |
| filename | string Name if the file uploaded. Ignored if url is used for inputLocation |
| url | string URL to retrieve XML. Ignored if rawxml is used for inputLocation |
| rawxml | string The XML uploaded by file. Ignored if url is used for inputLocation |
#!/bin/bash # Transform a file on your computer using Record Services export METASERVER_URL="https://data.noaa.gov/recordServices/upload" # Change this variable for different transforms, options are: # resolve, none, isovalidatecheck, olrlinkcheck, nceilandingpage, # transisotorubricv2, transisotorubric, transncmltorubric, transncmltoiso, and fgdctoiso recordAction="resolve" echo -n "Enter the filename to transform: " read filename curl --cookie cookies.txt \ -L --max-redirs 1 \ -k \ "$METASERVER_URL" \ -F recordAction="$recordAction" \ -F inputLocation="file" \ -F filename=@"$filename"