Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Properties
Source
Used by
Included schema ParamHTTP.xsd
Namespace http://voparis-europlanet.obspm.fr/xml/TAPCore/EPNCore.xsd
Annotations
 
Planetary Science Data Model: declaration of ResourceType metadata element.
Properties
attribute form default: unqualified
element form default: qualified
version: 1.0
Element psr:ParamHTTP / psr:templateQuery
Namespace http://voparis-europlanet.obspm.fr/xml/PSR/v1.0
Annotations
 
A description of a template query to access to the data through a service.
Diagram
Diagram ParamHTTP_xsd.tmp#TemplateQueryType_use ParamHTTP_xsd.tmp#TemplateQueryType_std ParamHTTP_xsd.tmp#TemplateQueryType_granule-id ParamHTTP_xsd.tmp#TemplateQueryType_accessURL ParamHTTP_xsd.tmp#TemplateQueryType_templateParam ParamHTTP_xsd.tmp#TemplateQueryType
Type psr:TemplateQueryType
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Model psr:accessURL+ , psr:templateParam*
Children psr:accessURL, psr:templateParam
Instance
 
<psr:templateQuery granule-id="" std="true" use="optional" xmlns:psr="http://voparis-europlanet.obspm.fr/xml/PSR/v1.0">
  <psr:accessURL use="">{1,unbounded}</psr:accessURL>
  <psr:templateParam std="true" use="optional">{0,unbounded}</psr:templateParam>
</psr:templateQuery>
Attributes
QName Type Fixed Default Use Annotation
granule-id xs:token optional 
Token pointing to a unique identifier of a granule. It could
be a numeric value or a short string.
std xs:boolean true optional 
If true, the meaning and behavior of this parameter is
reserved and defined by a standard interface.  If
false, it represents an implementation-specific
parameter that effectively extends the behavior of the 
service or application.
use vs:ParamUse optional optional 
An indication of whether this parameter is required to be provided 
for the application or service to work properly.
 
Allowed values are "required" and "optional".
Source
 
<xs:element name="templateQuery" type="psr:TemplateQueryType" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>A description of a template query to access to the data through a service.</xs:documentation>
  </xs:annotation>
</xs:element>
Element psr:TemplateQueryType / psr:accessURL
Namespace http://voparis-europlanet.obspm.fr/xml/PSR/v1.0
Annotations
 
The URL (or base URL) that a client uses to access the
service.  How this URL is to be interpreted and used 
depends on the specific Interface subclass
 
When more than one URL is given, each represents an
alternative (i.e. mirror) endpoint whose behavior is
identical to all the other accessURLs listed.
 
Editor's note: this element assumes that
all registered services are inherently web based.
Diagram
Diagram
Type vr:AccessURL
Properties
content: complex
minOccurs: 1
maxOccurs: unbounded
Attributes
QName Type Fixed Default Use Annotation
use restriction of xs:NMTOKEN optional 
A flag indicating whether this should be interpreted as a base
URL, a full URL, or a URL to a directory that will produce a 
listing of files.
 
The default value assumed when one is not given depends on the 
context.
Source
 
<xs:element name="accessURL" type="vr:AccessURL" minOccurs="1" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>The URL (or base URL) that a client uses to access the service. How this URL is to be interpreted and used depends on the specific Interface subclass</xs:documentation>
    <xs:documentation>When more than one URL is given, each represents an alternative (i.e. mirror) endpoint whose behavior is identical to all the other accessURLs listed.</xs:documentation>
    <xs:documentation>Editor's note: this element assumes that all registered services are inherently web based.</xs:documentation>
  </xs:annotation>
</xs:element>
Element psr:TemplateQueryType / psr:templateParam
Namespace http://voparis-europlanet.obspm.fr/xml/PSR/v1.0
Annotations
 
A description of the value of an input parameter (provided as ${parameter_name}) 
which must be substituted to provide a name=value argument to the service.
Diagram
Diagram v1_1.tmp#BaseParam_name v1_1.tmp#BaseParam_description v1_1.tmp#BaseParam_unit v1_1.tmp#BaseParam_ucd v1_1.tmp#BaseParam_utype v1_1.tmp#BaseParam v1_1.tmp#InputParam_use v1_1.tmp#InputParam_std v1_1.tmp#InputParam_dataType v1_1.tmp#InputParam
Type vs:InputParam
Type hierarchy
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Model name{0,1} , description{0,1} , unit{0,1} , ucd{0,1} , utype{0,1} , dataType{0,1}
Children dataType, description, name, ucd, unit, utype
Instance
 
<psr:templateParam std="true" use="optional" xmlns:psr="http://voparis-europlanet.obspm.fr/xml/PSR/v1.0">
  <name>{0,1}</name>
  <description>{0,1}</description>
  <unit>{0,1}</unit>
  <ucd>{0,1}</ucd>
  <utype>{0,1}</utype>
  <dataType arraysize="1" delim=" " extendedSchema="" extendedType="">{0,1}</dataType>
</psr:templateParam>
Attributes
QName Type Fixed Default Use Annotation
ANY attribute from ANY namespace OTHER than 'http://www.ivoa.net/xml/VODataService/v1.1'
std xs:boolean true optional 
If true, the meaning and behavior of this parameter is
reserved and defined by a standard interface.  If
false, it represents an implementation-specific
parameter that effectively extends the behavior of the 
service or application.
use vs:ParamUse optional optional 
An indication of whether this parameter is
required to be provided for the application
or service to work properly.
 
Allowed values are "required" and "optional".
Source
 
<xs:element name="templateParam" type="vs:InputParam" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation>A description of the value of an input parameter (provided as ${parameter_name}) which must be substituted to provide a name=value argument to the service.</xs:documentation>
  </xs:annotation>
</xs:element>
Complex Type psr:ParamHTTP
Namespace http://voparis-europlanet.obspm.fr/xml/PSR/v1.0
Annotations
 
Extends the VODataService 'ParamHTTP' element. To be used as the type 
of the interface of the capability metadata element.
Diagram
Diagram v1_0.tmp#Interface_version v1_0.tmp#Interface_role v1_0.tmp#Interface_accessURL v1_0.tmp#Interface_securityMethod v1_0.tmp#Interface v1_1.tmp#ParamHTTP_queryType v1_1.tmp#ParamHTTP_resultType v1_1.tmp#ParamHTTP_param v1_1.tmp#ParamHTTP_testQuery v1_1.tmp#ParamHTTP ParamHTTP_xsd.tmp#http___voparis-europlanet.obspm.fr_xml_PSR_v1.0_ParamHTTP_templateQuery
Type extension of vs:ParamHTTP
Type hierarchy
Model accessURL+ , securityMethod* , queryType{0,2} , resultType{0,1} , param* , testQuery* , psr:templateQuery*
Children accessURL, param, psr:templateQuery, queryType, resultType, securityMethod, testQuery
Attributes
QName Type Fixed Default Use Annotation
role xs:NMTOKEN optional 
A tag name the identifies the role the interface plays
in the particular capability.  If the value is equal to
"std" or begins with "std:", then the interface refers
to a standard interface defined by the standard
referred to by the capability's standardID attribute.
 
For an interface complying with some registered
standard (i.e. has a legal standardID), the role can be
match against interface roles enumerated in standard 
resource record.  The interface descriptions in
the standard record can provide default descriptions 
so that such details need not be repeated here.
version xs:string 1.0 optional 
The version of a standard interface specification that this 
interface complies with.  When the interface is
provided in the context of a Capability element, then
the standard being refered to is the one identified by
the Capability's standardID element.  If the standardID
is not provided, the meaning of this attribute is
undefined.
Source
 
<xs:complexType name="ParamHTTP">
  <xs:annotation>
    <xs:documentation>Extends the VODataService 'ParamHTTP' element. To be used as the type of the interface of the capability metadata element.</xs:documentation>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="vs:ParamHTTP">
      <xs:sequence>
        <xs:element name="templateQuery" type="psr:TemplateQueryType" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>A description of a template query to access to the data through a service.</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>
Complex Type psr:TemplateQueryType
Namespace http://voparis-europlanet.obspm.fr/xml/PSR/v1.0
Annotations
 
Description of a template query to access to the data through a service.
To be used within the interface of the capability metadata element to
describe how to request the service.
Diagram
Diagram ParamHTTP_xsd.tmp#TemplateQueryType_use ParamHTTP_xsd.tmp#TemplateQueryType_std ParamHTTP_xsd.tmp#TemplateQueryType_granule-id ParamHTTP_xsd.tmp#TemplateQueryType_accessURL ParamHTTP_xsd.tmp#TemplateQueryType_templateParam
Used by
Model psr:accessURL+ , psr:templateParam*
Children psr:accessURL, psr:templateParam
Attributes
QName Type Fixed Default Use Annotation
granule-id xs:token optional 
Token pointing to a unique identifier of a granule. It could
be a numeric value or a short string.
std xs:boolean true optional 
If true, the meaning and behavior of this parameter is
reserved and defined by a standard interface.  If
false, it represents an implementation-specific
parameter that effectively extends the behavior of the 
service or application.
use vs:ParamUse optional optional 
An indication of whether this parameter is required to be provided 
for the application or service to work properly.
 
Allowed values are "required" and "optional".
Source
 
<xs:complexType name="TemplateQueryType">
  <xs:annotation>
    <xs:documentation>Description of a template query to access to the data through a service. To be used within the interface of the capability metadata element to describe how to request the service.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="accessURL" type="vr:AccessURL" minOccurs="1" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>The URL (or base URL) that a client uses to access the service. How this URL is to be interpreted and used depends on the specific Interface subclass</xs:documentation>
        <xs:documentation>When more than one URL is given, each represents an alternative (i.e. mirror) endpoint whose behavior is identical to all the other accessURLs listed.</xs:documentation>
        <xs:documentation>Editor's note: this element assumes that all registered services are inherently web based.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="templateParam" type="vs:InputParam" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>A description of the value of an input parameter (provided as ${parameter_name}) which must be substituted to provide a name=value argument to the service.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
  <xs:attribute name="use" type="vs:ParamUse" default="optional">
    <xs:annotation>
      <xs:documentation>An indication of whether this parameter is required to be provided for the application or service to work properly.</xs:documentation>
      <xs:documentation>Allowed values are "required" and "optional".</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="std" type="xs:boolean" default="true">
    <xs:annotation>
      <xs:documentation>If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="granule-id" type="xs:token">
    <xs:annotation>
      <xs:documentation>Token pointing to a unique identifier of a granule. It could be a numeric value or a short string.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>
Attribute psr:TemplateQueryType / @use
Namespace No namespace
Annotations
 
An indication of whether this parameter is required to be provided 
for the application or service to work properly.
 
Allowed values are "required" and "optional".
Type vs:ParamUse
Properties
default: optional
Facets
enumeration required 
the parameter is required for the application or
service to work properly.
enumeration optional 
the parameter is optional but supported by the application or
service.
enumeration ignored 
the parameter is not supported and thus is ignored by the 
application or service.
Used by
Complex Type psr:TemplateQueryType
Source
 
<xs:attribute name="use" type="vs:ParamUse" default="optional">
  <xs:annotation>
    <xs:documentation>An indication of whether this parameter is required to be provided for the application or service to work properly.</xs:documentation>
    <xs:documentation>Allowed values are "required" and "optional".</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute psr:TemplateQueryType / @std
Namespace No namespace
Annotations
 
If true, the meaning and behavior of this parameter is
reserved and defined by a standard interface.  If
false, it represents an implementation-specific
parameter that effectively extends the behavior of the 
service or application.
Type xs:boolean
Properties
default: true
Used by
Complex Type psr:TemplateQueryType
Source
 
<xs:attribute name="std" type="xs:boolean" default="true">
  <xs:annotation>
    <xs:documentation>If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute psr:TemplateQueryType / @granule-id
Namespace No namespace
Annotations
 
Token pointing to a unique identifier of a granule. It could
be a numeric value or a short string.
Type xs:token
Properties
content: simple
Used by
Complex Type psr:TemplateQueryType
Source
 
<xs:attribute name="granule-id" type="xs:token">
  <xs:annotation>
    <xs:documentation>Token pointing to a unique identifier of a granule. It could be a numeric value or a short string.</xs:documentation>
  </xs:annotation>
</xs:attribute>
XML Schema documentation generated by ® XML Editor.