Data: inst
- Namespace: http://genologics.com/ri/instrument
- XML Schema File: instrument.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 instrument
- Type: instrument
The detailed representation of an instrument.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<inst:instrument xmlns:inst="http://genologics.com/ri/instrument" uri="..." limsid="...">
<name>
<!--content of type 'string'-->
...
</name>
<type>
<!--content of type 'string'-->
...
</type>
<serial-number>
<!--content of type 'string'-->
...
</serial-number>
<expiry-date>
<!--content of type 'string'-->
...
</expiry-date>
<archived>
<!--content of type 'boolean'-->
...
</archived>
</inst:instrument>
Element instruments
- Type: instruments
The representation of a list of instrument 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"?>
<inst:instruments xmlns:inst="http://genologics.com/ri/instrument">
<instrument uri="...">
<!--content of type 'instrument-link'-->
<name>
<!--content of type 'string'-->
...
</name>
</instrument>
<instrument>
<!--(another 'instrument-link' type)-->
</instrument>
<!--...more "instrument" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</inst:instruments>
Type instrument
The detailed representation of an instrument.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the Instrument. |
| limsid | string | The limsid of the Instrument. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the Instrument. |
| type (string) | 0/1 | The type of the Instrument. |
| serial-number (string) | 0/1 | The serial number of the Instrument. |
| expiry-date (string) | 0/1 | The expiry date of the Instrument. |
| archived (boolean) | 0/1 | The archived flag specifies if an Instrument is archived. |
Type instrument-link
Instrument-link is a child element type of instruments and provides a URI linking to the detailed representation of an instrument.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the Instrument. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the Instrument. |
Type instruments
The representation of a list of instrument 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 |
|---|---|---|
| instrument (instrument-link) | 0/unbounded | Instrument provides a URI linking to the detailed representation of a instrument. |
| previous-page (page) | 0/1 | When working with large lists of instruments, the previous-page element provides a URI that links to the previous page of instruments. |
| next-page (page) | 0/1 | When working with large lists of instruments, the next-page element provides a URI that links to the next page of instruments. |