Data: rtp
- Namespace: http://genologics.com/ri/reagenttype
- XML Schema File: reagenttype.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
Element reagent-type
- Type: reagent-type
The detailed representation of a reagent type.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<rtp:reagent-type xmlns:rtp="http://genologics.com/ri/reagenttype" name="..." uri="...">
<special-type name="...">
<!--content of type 'special-type'-->
<attribute name="..." value="...">
<!--content of type 'attribute'-->
</attribute>
<attribute>
<!--(another 'attribute' type)-->
</attribute>
<!--...more "attribute" elements...-->
</special-type>
<reagent-category>
<!--content of type 'string'-->
...
</reagent-category>
</rtp:reagent-type>
Element reagent-types
- Type: reagent-types
The representation for a list of reagent type links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<rtp:reagent-types xmlns:rtp="http://genologics.com/ri/reagenttype">
<reagent-type name="..." uri="...">
<!--content of type 'reagent-type-link'-->
</reagent-type>
<reagent-type>
<!--(another 'reagent-type-link' type)-->
</reagent-type>
<!--...more "reagent-type" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</rtp:reagent-types>
Type attribute
Attribute is a child element of special type and provides a name-value pair of the special type.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the attribute.
Always returns with GET: Yes |
| value | string |
The value of the attribute.
Always returns with GET: Yes |
Type reagent-type
The detailed representation of a reagent type.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the reagent type.
Always returns with GET: Yes |
| uri | anyURI |
The URI of the reagent type.
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| special-type (special-type) | 0/1 |
The special-type of the reagent type.
Always returns with GET: Yes |
| reagent-category (string) | 0/1 |
The reagent category of the reagent type.
Always returns with GET: Yes |
Type reagent-type-link
Reagent-type-link is a child element type of reagent types and provides a URI linking to the detailed representation of a reagent type.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the reagent type. |
| uri | anyURI | The URI of the reagent type. |
Type reagent-types
The representation for a list of reagent type links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| reagent-type (reagent-type-link) | 0/unbounded | Reagent-type provides a URI linking to the detailed representation of a reagent type. |
| previous-page (page) | 0/1 | When working with large lists of reagent types, the previous-page element provides a URI that links to the previous page of reagent types. |
| next-page (page) | 0/1 | When working with large lists of reagent types, the next-page element provides a URI that links to the next page of reagent types. |
Type special-type
Special-type is a child element of reagent type and provides a name and attributes describing a special type of reagent type.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the special type.
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| attribute (attribute) | 0/unbounded |
Each attribute is a name-value pair for the special type.
Always returns with GET: No |