Data: res

Namespace: http://genologics.com/ri/researcher
XML Schema File: researcher.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:

researcher
researchers

The following types are members of this namespace:

credentials
lab
researcher
researcher-link
researchers
role

Element researcher

Type: researcher

The detailed representation of a researcher.

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<res:researcher xmlns:res="http://genologics.com/ri/researcher" uri="...">
  <first-name>
    <!--content of type 'string'-->
    ...
  </first-name>
  <last-name>
    <!--content of type 'string'-->
    ...
  </last-name>
  <phone>
    <!--content of type 'string'-->
    ...
  </phone>
  <fax>
    <!--content of type 'string'-->
    ...
  </fax>
  <email>
    <!--content of type 'string'-->
    ...
  </email>
  <lab uri="...">
    <!--content of type 'lab'-->
  </lab>
  <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...-->
  <credentials>
    <!--content of type 'credentials'-->
    <username>
      <!--content of type 'string'-->
      ...
    </username>
    <password>
      <!--content of type 'string'-->
      ...
    </password>
    <account-locked>
      <!--content of type 'boolean'-->
      ...
    </account-locked>
    <role roleName="..." name="..." uri="...">
      <!--content of type 'role'-->
    </role>
    <role>
      <!--(another 'role' type)-->
    </role>
    <!--...more "role" elements...-->
  </credentials>
  <initials>
    <!--content of type 'string'-->
    ...
  </initials>
</res:researcher>

Element researchers

Type: researchers

The representation of a list of researcher 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"?>
<res:researchers xmlns:res="http://genologics.com/ri/researcher">
  <researcher uri="...">
    <!--content of type 'researcher-link'-->
    <first-name>
      <!--content of type 'string'-->
      ...
    </first-name>
    <last-name>
      <!--content of type 'string'-->
      ...
    </last-name>
  </researcher>
  <researcher>
    <!--(another 'researcher-link' type)-->
  </researcher>
  <!--...more "researcher" elements...-->
  <previous-page uri="...">
    <!--content of type 'page'-->
  </previous-page>
  <next-page uri="...">
    <!--content of type 'page'-->
  </next-page>
</res:researchers>

Type credentials

The credentials element contains information about a researcher's access to the client software interface. It is used only when a researcher is given access to the system. It is not used when a researcher's information is being stored for contact purposes only.

Child Elements

name (type)	min/max occurs	description
username (string)	0/1	The researcher's user name. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes
password (string)	0/1	The researcher's password. This element is required when creating a new user or changing the user name of an existing user. You can also use this element to change an existing user's password. When submitting a PUT or POST request, passwords are submitted in plain text, and the API encodes the password before storing it in the database. Password are never displayed in an XML response. Always returns with GET: Never Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: No, unless updating username or password.
account-locked (boolean)	0/1	The researcher's account status. A value of 'true' indicates that the account can be used by the researcher. A value of 'false' indicates that the account is locked and the researcher cannot log into the system. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes
role (role)	0/unbounded	The type of system access assigned to the researcher's user account. When adding a new role you must provide at least one of: URI, name, or roleName. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: No, but existing roles must be included or the system will remove the roles not present

Type lab

Lab is a child element of researcher and provides a URI linking to the detailed representation of the lab for the researcher.

Attributes

name	type	description
uri	anyURI	A URI that links to the lab that the researcher is associated with. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: No, but old lab value will remain

Type researcher

The detailed representation of a researcher.

Attributes

name	type	description
uri	anyURI	A URI that links to the XML representation of the researcher 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
first-name (string)	0/1	The researcher's first name. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
last-name (string)	0/1	The researcher's last name. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
phone (string)	0/1	The researcher's phone number. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
fax (string)	0/1	The researcher's fax number. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
email (string)	0/1	The researcher's e-mail address. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes
lab (lab)	0/1	A URI that links to the lab that the researcher is associated with. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
type ()	0/1	The User-Defined Type that is associated with the researcher. 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 researcher. This element is repeated for each UDF associated with the researcher. 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 researcher. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
credentials (credentials)	0/1	The researcher's system access credentials. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
initials (string)	0/1	The researchers initials Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes, must be 3 alphanumeric characters Updatable with PUT: Yes Required for PUT: Yes, must be 3 alphanumeric characters

Type researcher-link

Researcher-link is a child element type of researchers and provides a URI linking to the detailed representation of a researcher.

Attributes

name	type	description
uri	anyURI	The URI of the researcher.

Child Elements

name (type)	min/max occurs	description
first-name (string)	0/1	The first name of the researcher.
last-name (string)	0/1	The last name of the researcher.

Type researchers

The representation of a list of researcher 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
researcher (researcher-link)	0/unbounded	Researcher provides a URI linking to the detailed representation of a researcher.
previous-page (page)	0/1	When working with large lists of researchers, the previous-page element provides a URI that links to the previous page of researchers.
next-page (page)	0/1	When working with large lists of researchers, the next-page element provides a URI that links to the next page of researchers.

Type role

The role element defines a researcher's level of access in the system. You can repeat the element to provide a researcher with access to more than one area of the system. When submitting a PUT request to update a researcher's credentials (any child elements within the credentials element), your XML must include the current roles for the researcher. If you do not include all of the current roles, the system will remove the current data and the researcher will no longer have access to the system. When adding a new role you must provide at least one of: URI, name, or roleName.

Attributes

name	type	description
roleName	string	The internal name of the security role assigned to the researcher. Only used by built-in roles. Acceptable values are: "systemadministrator", "administrator", "labtech", and "webclient". This attribute is deprecated and will be removed in the next major API version. Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No
name	string	The user-facing name of the security role assigned to the researcher. Must be unique. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes
uri	anyURI	The URI of the Role. Always returns with GET: Yes

REST API

Data: res

Element researcher

Example XML

Element researchers

Example XML

Type credentials

Child Elements

Type lab

Attributes

Type researcher

Attributes

Child Elements

Type researcher-link

Attributes

Child Elements

Type researchers

Child Elements

Type role

Attributes

Home

REST Endpoints

XML Data Elements

XML Data Types