Data: lab
- Namespace: http://genologics.com/ri/lab
- XML Schema File: lab.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 lab
- Type: lab
The detailed representation of a lab.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<lab:lab xmlns:lab="http://genologics.com/ri/lab" uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<billing-address>
<!--content of type 'address'-->
<street>
<!--content of type 'string'-->
...
</street>
<city>
<!--content of type 'string'-->
...
</city>
<state>
<!--content of type 'string'-->
...
</state>
<country>
<!--content of type 'string'-->
...
</country>
<postalCode>
<!--content of type 'string'-->
...
</postalCode>
<institution>
<!--content of type 'string'-->
...
</institution>
<department>
<!--content of type 'string'-->
...
</department>
</billing-address>
<shipping-address>
<!--content of type 'address'-->
<street>
<!--content of type 'string'-->
...
</street>
<city>
<!--content of type 'string'-->
...
</city>
<state>
<!--content of type 'string'-->
...
</state>
<country>
<!--content of type 'string'-->
...
</country>
<postalCode>
<!--content of type 'string'-->
...
</postalCode>
<institution>
<!--content of type 'string'-->
...
</institution>
<department>
<!--content of type 'string'-->
...
</department>
</shipping-address>
<udf:type xmlns:udf="http://genologics.com/ri/userdefined">...</udf:type>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<!--...more "field" elements...-->
<ri:externalid xmlns:ri="http://genologics.com/ri">...</ri:externalid>
<ri:externalid xmlns:ri="http://genologics.com/ri">...</ri:externalid>
<!--...more "externalid" elements...-->
<website>
<!--content of type 'string'-->
...
</website>
</lab:lab>
Element labs
- Type: labs
The representation of a list of lab 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"?>
<lab:labs xmlns:lab="http://genologics.com/ri/lab">
<lab uri="...">
<!--content of type 'lab-link'-->
<name>
<!--content of type 'string'-->
...
</name>
</lab>
<lab>
<!--(another 'lab-link' type)-->
</lab>
<!--...more "lab" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</lab:labs>
Type lab
The detailed representation of a lab.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the lab.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 |
The name of the lab.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes |
| billing-address (address) | 0/1 |
The lab's billing address.
Always returns with GET: No, but can be empty if it returns Creatable with POST: Yes Required for POST: No, but system will return nodes with empty data Updatable with PUT: Yes Required for PUT: No, but system will return nodes with empty data |
| shipping-address (address) | 0/1 |
The lab's shipping address.
Always returns with GET: No, but can be empty if it returns Creatable with POST: Yes Required for POST: No, but system will return nodes with empty data Updatable with PUT: Yes Required for PUT: No, but system will return nodes with empty data |
| type () | 0/1 |
The User-Defined Type that is associated with the lab.
Always returns with GET: No Creatable with POST: Yes Required for POST: No, unless the UDT has been configured as required. Updatable with PUT: Yes Required for PUT: No, unless the UDT has been configured as required. If a current UDT is not provided, existing values are deleted. |
| field () | 0/unbounded |
A User-Defined Field that is associated with the lab.
This element is repeated for each UDF associated with the lab.
Always returns with GET: No Creatable with POST: Yes Required for POST: No, unless the UDF has been configured as required. Updatable with PUT: Yes Required for PUT: No, unless the UDF has been configured as required. If a current UDF is not provided, existing values are deleted. |
| externalid () | 0/unbounded |
An identifier that allows an external system to retrieve information about the lab
Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No |
| website (string) | 0/1 |
The lab's website.
Always returns with GET: Yes, but can be empty Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No |
Type lab-link
Lab-link is a child element type of labs and provides a URI linking to the detailed representation of a lab.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the lab. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the lab. |
Type labs
The representation of a list of lab 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 |
|---|---|---|
| lab (lab-link) | 0/unbounded | Lab provides a URI linking to the detailed representation of a lab. |
| previous-page (page) | 0/1 | When working with large lists of labs, the previous-page element provides a URI that links to the previous page of labs. |
| next-page (page) | 0/1 | When working with large lists of labs, the next-page element provides a URI that links to the next page of labs. |