REST API

Data: ctrltp

  • Namespace: http://genologics.com/ri/controltype
  • XML Schema File: controltype.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 control-type

The detailed representation of a ControlType.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <ctrltp:control-type xmlns:ctrltp="http://genologics.com/ri/controltype" uri="..." name="..."> <supplier> <!--content of type 'string'--> ... </supplier> <catalogue-number> <!--content of type 'string'--> ... </catalogue-number> <website> <!--content of type 'anyURI'--> ... </website> <concentration> <!--content of type 'string'--> ... </concentration> <archived> <!--content of type 'boolean'--> ... </archived> <single-step> <!--content of type 'boolean'--> ... </single-step> </ctrltp:control-type>

Element control-types

The representation of a list of ControlTypes

Example XML

<?xml version="1.0" encoding="UTF-8"?> <ctrltp:control-types xmlns:ctrltp="http://genologics.com/ri/controltype" uri="..."> <control-type name="..." uri="..."> <!--content of type 'control-type-link'--> </control-type> <control-type> <!--(another 'control-type-link' type)--> </control-type> <!--...more "control-type" elements...--> </ctrltp:control-types>

Type control-type

The detailed representation of a ControlType.

Attributes

name type description
uri anyURI The URI of the ControlType.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: Yes
name string The name of the ControlType.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: Yes
Required for PUT: Yes

Child Elements

name (type) min/max
occurs
description
supplier (string) 0/1 The supplier of the ControlType.
Always returns with GET: No
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
catalogue-number (string) 0/1 The catalogue number of the ControlType.
Always returns with GET: No
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
website (anyURI) 0/1 The website of the ControlType.
Always returns with GET: No
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
concentration (string) 0/1 The concentration of the ControlType.
Always returns with GET: No
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
archived (boolean) 0/1 The archived flag specifies whether a ControlType is archived.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No
single-step (boolean) 0/1 The single step flag specifies whether a control sample can only be used in a single protocol step.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: No
Updatable with PUT: Yes
Required for PUT: No

Type control-type-link

Control-type-link is a child element type of controlTypes and provides a URI linking to the detailed representation of a ControlType.

Attributes

name type description
name string The name of the ControlType.
Always returns with GET: Yes
uri anyURI The URI of the ControlType.
Always returns with GET: Yes

Type control-types

The representation of a list of ControlTypes

Attributes

name type description
uri anyURI The URI of the ControlTypes.
Always returns with GET: Yes

Child Elements

name (type) min/max
occurs
description
control-type (control-type-link) 0/unbounded The list of ControlTypes.
Always returns with GET: Yes

Home

REST Endpoints

XML Data Elements

XML Data Types