Schema toqe_response2.xsd


schema location:  http://search.biocase.org/toqe/schema/toqe_response.xsd
 
Elements 
concept 
conceptSet 
error 
name 
reference 
reference_2 
relation 
relationSet 
response 
status 


element concept
diagram
children name status reference relationSet reference_2
used by
elements conceptSet relation
attributes
Name  Type  Use  Default  Fixed  Annotation
dataSchemaConcept  xs:string  required      
annotation
documentation 
A concept object: contains the first concept (name, reference, id), the second concept(name, reference, id) and the relation between the 2 concepts
source
<xs:element name="concept">
  <xs:annotation>
    <xs:documentation>A concept object: contains the first concept (name, reference, id), the second concept(name, reference, id) and the relation between the 2 concepts</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="name"/>
      <xs:element ref="status"/>
      <xs:element ref="reference"/>
      <xs:element ref="relationSet" minOccurs="0"/>
      <xs:element ref="reference_2" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="dataSchemaConcept" type="xs:string" use="required"/>
  </xs:complexType>
</xs:element>

element conceptSet
diagram
children concept
used by
element response
annotation
documentation 
The set of concepts (pair of concepts)
source
<xs:element name="conceptSet">
  <xs:annotation>
    <xs:documentation>The set of concepts (pair of concepts)</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="concept"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element error
diagram
used by
element response
attributes
Name  Type  Use  Default  Fixed  Annotation
code  xs:int  required      
message  xs:string  required      
detail  xs:string  required      
source
<xs:element name="error">
  <xs:complexType>
    <xs:attribute name="code" type="xs:int" use="required"/>
    <xs:attribute name="message" type="xs:string" use="required"/>
    <xs:attribute name="detail" type="xs:string" use="required"/>
  </xs:complexType>
</xs:element>

element name
diagram
type extension of xs:string
used by
element concept
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
documentation 
ID of the searched/first concept
relationtype  xs:string  required      
documentation 
relation existing between the 2 concepts
id2  xs:string  required      
documentation 
ID of the second concept
name  xs:string  required      
documentation 
name of the second concept
annotation
documentation 
2 concepts and their relation ; value: the name of the searched concept.
source
<xs:element name="name">
  <xs:annotation>
    <xs:documentation>2 concepts and their relation ; value: the name of the searched concept.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:string">
        <xs:attribute name="id" type="xs:string" use="required">
          <xs:annotation>
            <xs:documentation>ID of the searched/first concept</xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute name="relationtype" type="xs:string" use="required">
          <xs:annotation>
            <xs:documentation>relation existing between the 2 concepts</xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute name="id2" type="xs:string" use="required">
          <xs:annotation>
            <xs:documentation>ID of the second concept</xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute name="name" type="xs:string" use="required">
          <xs:annotation>
            <xs:documentation>name of the second concept</xs:documentation>
          </xs:annotation>
        </xs:attribute>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

element reference
diagram
type extension of xs:string
used by
element concept
attributes
Name  Type  Use  Default  Fixed  Annotation
id    required      
annotation
documentation 
The reference (name+ID) of the first concept
source
<xs:element name="reference">
  <xs:annotation>
    <xs:documentation>The reference (name+ID) of the first concept</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:string">
        <xs:attribute name="id" use="required"/>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

element reference_2
diagram
type extension of xs:string
used by
element concept
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
annotation
documentation 
The reference (name+ID) of the second concept
source
<xs:element name="reference_2">
  <xs:annotation>
    <xs:documentation>The reference (name+ID) of the second concept</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:string">
        <xs:attribute name="id" type="xs:string" use="required"/>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

element relation
diagram
children concept
used by
element relationSet
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string  required      
annotation
documentation 
The relation type existing between the two concepts
source
<xs:element name="relation">
  <xs:annotation>
    <xs:documentation>The relation type existing between the two concepts</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="concept" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="name" type="xs:string" use="required"/>
  </xs:complexType>
</xs:element>

element relationSet
diagram
children relation
used by
element concept
annotation
documentation 
A set of relation existing for the searched concept
source
<xs:element name="relationSet">
  <xs:annotation>
    <xs:documentation>A set of relation existing for the searched concept</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="relation"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

element response
diagram
children conceptSet error
attributes
Name  Type  Use  Default  Fixed  Annotation
success  xs:boolean  required      
annotation
documentation 
Defines the document as a toqe response instance
source
<xs:element name="response">
  <xs:annotation>
    <xs:documentation>Defines the document as a toqe response instance</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="conceptSet" minOccurs="0"/>
      <xs:element ref="error" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="success" type="xs:boolean" use="required"/>
  </xs:complexType>
</xs:element>

element status
diagram
used by
element concept
annotation
documentation 
The status (accepted, synonym) of the current concept
source
<xs:element name="status">
  <xs:annotation>
    <xs:documentation>The status (accepted, synonym) of the current concept</xs:documentation>
  </xs:annotation>
</xs:element>


XML Schema documentation generated with
XML Spy Schema Editor www.xmlspy.com