Documenting Services

From Earth Science Information Partners (ESIP)

Services provide data in standard responses and formats.

Service

Services provide data in standard responses and formats.
ConceptDescriptionDialect (Fit) Paths
Resource TitleA short description of the resource. The title should be descriptive enough so that when a user is presented with a list of titles the general content of the data set can be determined.ADIwg /adiwg:project/adiwg:idinfo/adiwg:citation/adiwg:citeinfo/adiwg:title
BDP /bdp:metadata/bdp:idinfo/bdp:citation/bdp:citeinfo/bdp:title
CSDGM /csdgm:metadata/csdgm:idinfo/csdgm:citation/csdgm:citeinfo/csdgm:title
DCAT /dct:title
DCITE /dcite:resource/dcite:titles/dcite:title
DIF /dif:DIF/dif:Entry_Title
DIF /dif:DIF/dif:Data_Set_Citation/dif:Dataset_Title
DIF-10 /dif:DIF/dif:Entry_Title
DIF-10 /dif:DIF/dif:Dataset_Citation/dif:Dataset_Title
Dryad /*/dcterms:title
ECHO /*/echo:ShortName | /*/echo:LongName
ECHO /*/echo:DataSetId
ECS /*/ecs:ShortName | /*/ecs:LongName
EML /eml:eml/*/title
HCLS dct:title
HDF5.1 /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Attribute[@Name='title']/hdf5:Data/hdf5:DataFromFile
HDF5.1 /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Group[@Name='METADATA']/hdf5:Group[@Name='COLLECTIONMETADATA']/hdf5:Attribute[@Name='LongName']/hdf5:Data/hdf5:DataFromFile
ISO /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:title//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:citation/cit:CI_Citation/cit:title//*
MODS //mods:mods/mods:titleInfo/mods:title
Mercury /mercury:metadata/mercury:idinfo/mercury:citation/mercury:citeinfo/mercury:title
OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:Title
Onedcx /onedcx:metadata/onedcx:simpleDc/dcterms:title
RDA-CISL /rda:dsOverview/rda:title
SERF /serf:SERF/serf:Entry_Title
THREDDS /thredds:catalog/thredds:dataset/@name
THREDDS /thredds:catalog/thredds:dataset/thredds:metadata/dc:title
THREDDS //thredds:dataset[1]/@name
UMM /umm:UMM/umm:CollectionCitation/umm:Title
AbstractA paragraph describing the resource.

Note: This concept is called "Desciption" in Catalog Services for the Web.
ADIwg /adiwg:project/adiwg:idinfo/adiwg:descript/adiwg:abstract
BDP /bdp:metadata/bdp:idinfo/bdp:descript/bdp:abstract
CSDGM /csdgm:metadata/csdgm:idinfo/csdgm:descript/csdgm:abstract
DCAT /dct:description
DCITE /dcite:resource/dcite:descriptions/dcite:description[@descriptionType='Abstract']
DIF /dif:DIF/dif:Summary
DIF /dif:DIF/dif:Summary/dif:Abstract
DIF-10 /dif:DIF/dif:Summary/dif:Abstract
Dryad /*/dcterms:description
ECHO /*/echo:Description
ECS /*/ecs:CollectionDescription
EML /eml:eml/*/abstract
HCLS dct:description
HDF5.1 /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Attribute[@Name='summary']/hdf5:Data/hdf5:DataFromFile
HDF5.1 /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Group[@Name='METADATA']/hdf5:Group[@Name='COLLECTIONMETADATA']/hdf5:Attribute[@Name='CollectionDescription']/hdf5:Data/hdf5:DataFromFile
ISO /*/gmd:identificationInfo/*/gmd:abstract//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:abstract//*
MODS //mods:mods/mods:abstract
Mercury /mercury:metadata/mercury:idinfo/mercury:descript/mercury:abstract
OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:Abstract
Onedcx /onedcx:metadata/onedcx:simpleDc/dcterms:description
Onedcx /onedcx:metadata/onedcx:dcTerms/dcterms:abstract
RDA-CISL /rda:dsOverview/rda:summary
SERF /serf:SERF/serf:Summary/serf:Abstract
THREDDS //thredds:dataset/thredds:documentation[@type='abstract']
THREDDS //thredds:metadata/thredds:documentation[@type='abstract']
UMM /umm:UMM/umm:Summary
Theme KeywordA word or phrase that describes some aspect of a resource. Can be one of several types.

Note: The general identification keywords usually have a type of "theme" and are refered to as "theme keywords". Other types and vocabularies are used for other information. Service Entry Resource Format (SERF) requires a Science and a Service GCMD Keyword. This concept is called Subject in the CSW Specification.
ADIwg /adiwg:project/adiwg:idinfo/adiwg:keywords/adiwg:theme/adiwg:themekey
BDP /bdp:metadata/bdp:idinfo/bdp:keywords/bdp:theme/bdp:themekey
CSDGM /csdgm:metadata/csdgm:idinfo/csdgm:keywords/csdgm:theme/csdgm:themekey
DCAT /dct:keyword
DCITE /dcite:resource/dcite:subjects/dcite:subject
DIF /dif:DIF/dif:Parameters/dif:Category
DIF /dif:DIF/dif:Parameters/dif:Topic
DIF /dif:DIF/dif:Parameters/dif:Term
DIF /dif:DIF/dif:Parameters/dif:Variable_Level_1
DIF /dif:DIF/dif:Parameters/dif:Variable_Level_2
DIF /dif:DIF/dif:Parameters/dif:Variable_Level_3
DIF /dif:DIF/dif:Parameters/dif:Detailed_Variable
DIF-10 /dif:DIF/dif:Parameters/dif:Category
DIF-10 /dif:DIF/dif:Parameters/dif:Topic
DIF-10 /dif:DIF/dif:Parameters/dif:Term
DIF-10 /dif:DIF/dif:Parameters/dif:Variable_Level_1
DIF-10 /dif:DIF/dif:Parameters/dif:Variable_Level_2
DIF-10 /dif:DIF/dif:Parameters/dif:Variable_Level_3
DIF-10 /dif:DIF/dif:Parameters/dif:Detailed_Variable
DIF-10 /dif:DIF/dif:Science_Keywords
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:DisciplineKeyword
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:TopicKeyword
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:TermKeyword
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:VariableKeyword
EML /eml:eml/*/keywordSet/keyword
HCLS dcat:keyword
HDF5.1 (1) /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Attribute[@Name='keywords']/hdf5:Data/hdf5:DataFromFile
HDF5.1 (1) /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Group[@Name='METADATA']/hdf5:Group[@Name='COLLECTIONMETADATA']/hdf5:Group[@Name='DisciplineTopicParameters']/hdf5:Group/hdf5:Attribute[@Name='ECSDisciplineKeyword']/hdf5:Data/hdf5:DataFromFile
HDF5.1 (1) /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Group[@Name='METADATA']/hdf5:Group[@Name='COLLECTIONMETADATA']/hdf5:Group[@Name='DisciplineTopicParameters']/hdf5:Group/hdf5:Attribute[@Name='ECSTermKeyword']/hdf5:Data/hdf5:DataFromFile
HDF5.1 (1) /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Group[@Name='METADATA']/hdf5:Group[@Name='COLLECTIONMETADATA']/hdf5:Group[@Name='DisciplineTopicParameters']/hdf5:Group/hdf5:Attribute[@Name='ECSTopicKeyword']/hdf5:Data/hdf5:DataFromFile
HDF5.1 (1) /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Group[@Name='METADATA']/hdf5:Group[@Name='COLLECTIONMETADATA']/hdf5:Group[@Name='DisciplineTopicParameters']/hdf5:Group/hdf5:Attribute[@Name='ECSVariableKeyword']/hdf5:Data/hdf5:DataFromFile
HDF5.1 (1) /hdf5:HDF5-File/hdf5:RootGroup/hdf5:Group[@Name='METADATA']/hdf5:Group[@Name='COLLECTIONMETADATA']/hdf5:Group[@Name='DisciplineTopicParameters']/hdf5:Group/hdf5:Group[@Name='ECSParameter']/hdf5:Attribute[@Name='ECSParameterKeyword']/hdf5:Data/hdf5:DataFromFile
ISO /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords[normalize-space(gmd:type/gmd:MD_KeywordTypeCode)='theme']/gmd:keyword//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:descriptiveKeywords/mri:MD_Keywords[normalize-space(mri:type/mri:MD_KeywordTypeCode)='theme']/mri:keyword//*
MODS //mods:mods/mods:subject/mods:topic
MODS //mods:mods/mods:genre
Mercury /mercury:metadata/mercury:idinfo/mercury:keywords/mercury:theme/mercury:themekey
OGC-SOS (1) /sos:Capabilities/ows:ServiceIdentification/ows:Keywords[ows:Type='theme']/ows:Keyword
RDA-CISL rda:dsOverview/rda:variable
RDA-CISL rda:dsOverview/rda:keyword
SERF /serf:SERF/serf:Keyword
THREDDS (1) //thredds:metadata/thredds:keyword
THREDDS (1) //thredds:dataset/thredds:keyword
UMM (1) /umm:UMM/umm:ScienceKeywords/umm:Category
UMM (1) /umm:UMM/umm:ScienceKeywords/umm:Topic
UMM (1) /umm:UMM/umm:ScienceKeywords/umm:Term
UMM (1) /umm:UMM/umm:ScienceKeywords/umm:VariableLevel1/umm:Value
UMM (1) /umm:UMM/umm:ScienceKeywords/umm:VariableLevel1/umm:VariableLevel2/umm:Value
UMM (1) /umm:UMM/umm:ScienceKeywords/umm:VariableLevel1/umm:VariableLevel2/umm:VariableLevel3/umm:Value
UMM (1) /umm:UMM/umm:ScienceKeywords/umm:DetailedVariable
Service TypeStandard name for a service type.ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:serviceType/gco:LocalName
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/srv:serviceType/gco:LocalName
OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:ServiceType
Service Type VersionStandard name for a version of a service.ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:serviceTypeVersion//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/srv:serviceTypeVersion//*
OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:ServiceTypeVersion
Resource Cost or FeesCost associated with access to the resourceBDP /bdp:metadata/bdp:distinfo/bdp:storder/bdp:fees
CSDGM /csdgm:metadata/csdgm:distinfo/csdgm:storder/csdgm:fees
DIF /dif:DIF/dif:Distribution/dif:Fees
DIF-10 /dif:DIF/dif:Distribution/dif:Fees
ECHO /*/echo:Price
ISO /*/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributor/gmd:MD_Distributor/gmd:distributionOrderProcess/gmd:MD_StandardOrderProcess/gmd:fees//*
ISO-1 /mdb:MD_Metadata/mdb:distributionInfo/mrd:MD_Distribution/mrd:distributionFormat/mrd:MD_Format/mrd:formatDistributor/mrd:MD_Distributor/mrd:distributionOrderProcess/mrd:MD_StandardOrderProcess/mrd:fees//*
Mercury /mercury:metadata/mercury:distinfo/mercury:storder/mercury:fees
OGC-SOS /sos:Capabilities/ows:ServiceIdentification/ows:Fees
SERF /serf:SERF/serf:Distribution/serf:Fees
Resource Access ConstraintsInformation about any constraints for accessing the data set. This includes any special restrictions, legal prerequisites, limitations and/or warnings on obtaining the data set. Some words that may be used in this field include: Public, In-house, Limited, Additional detailed instructions on how to access the data can be entered in this field.BDP /bdp:metadata/bdp:idinfo/bdp:accconst
CSDGM /csdgm:metadata/csdgm:idinfo/csdgm:accconst
DCAT /dct:accessLevel
DCAT dct:accessLevelComment
DIF /dif:DIF/dif:Access_Constraints
DIF-10 /dif:DIF/dif:Access_Constraints
ECHO /*/echo:RestrictionFlag
ECHO /*/echo:RestrictionComment
ECHO /*/echo:Visible
ECS /*/ecs:AccessConstraints
EML /eml:eml/access
ISO /*/gmd:identificationInfo/*/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:accessConstraints/gmd:MD_RestrictionCode
ISO /*/gmd:identificationInfo/*/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:otherConstraints//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:resourceConstraints/mco:MD_LegalConstraints/mco:accessConstraints//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:resourceConstraints/mco:MD_LegalConstraints/mco:otherConstraints//*
MODS //mods:mods/mods:access
Mercury /mercury:metadata/mercury:idinfo/mercury:accconst
Onedcx /onedcx:metadata/onedcx:dcTerms/dcterms:accessRights
SERF /serf:DIF/serf:Access_Constraints
THREDDS /thredds:catalog/thredds:dataset/thredds:documentation[@type="rights"]
THREDDS /thredds:catalog/thredds:metadata/thredds:documentation[@type="rights"]
Service ProviderOrganization or person responsible for the service.ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:pointOfContact
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/mri:pointOfContact
OGC-SOS /sos:Capabilities/ows:ServiceProvider
SERF /serf:SERF/serf:Personnel
Service Operation NameName of an operation provided by the service.ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:operationName//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:operationName//*
OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/@name
WSDL /wsdl:definitions/wsdl:interface/wsdl:operation/@name
Service LocationEndpoint for accessing the service.DCAT /dct:webService
ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:connectPoint/gmd:CI_OnlineResource/gmd:linkage/gmd:URL
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:connectPoint/cit:CI_OnlineResource/cit:linkage//*
OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/ows:DCP/ows:HTTP/ows:Get/@xlink:href
OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/ows:DCP/ows:HTTP/ows:Post/@xlink:href
SERF /serf:SERF/serf:Service_Citation/serf:URL
WSDL /wsdl:definitions/wsdl:service/wsdl:endpoint
Service ParametersA narrative explanation of the role of the parameter.ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:parameters/srv:SV_Parameter/srv:description//*
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:parameter/srv:SV_Parameter/srv:description//*
OGC-SOS /sos:Capabilities/ows:OperationsMetadata/ows:Operation/ows:Parameter/ows:AllowedValues/ows:Value

xPath Note: The xPaths included in this table use several wildcards. // means any path, so //gmd:CI_ResponsibleParty indicates a gmd:CI_ResponsibleParty anywhere in an XML file. /*/ indicates a single level with several possible elements. This usually indicates one of several concrete realizations of an abstract object. For example /*/gmd:identificationInfo could be gmd:MD_Metadata/gmd:identificationInfo or gmi:MI_Metadata/gmd:identificationInfo and gmd:identificationInfo//*/gmd:descriptiveKeywords could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords.


Metadata Implementation