GET
Displays a list of researchers stored in the system. In the client, researchers are referred to as contacts.
If the number of researchers returned exceeds the display maximum, the results are paged.
When submitting a GET request, you can use the following query parameters to filter the results.
For more information about using query parameters, please refer to the Filtering list resources section under REST General Concepts.
Parameters
| name | description | type | default |
|---|---|---|---|
| start-index | When working with large lists of researchers, displays the researchers from a set point. If omitted, the first page of results is returned. | query | 0 |
| last-modified | Displays only the researchers modified since the specified date, in YYYY-MM-DDThh:mm:ssTZD format. For more information on this format, please refer to the ISO 8601 Complete Date (plus hours, minutes and seconds) standard. | query | |
| udf.UDFNAME[.OPERATOR]=UDFVALUE | Displays only the researchers that include the specified UDF value. The system will only return researchers with standalone UDFs; it will not return researchers with UDFs that belong to a UDT. When filtering results, you can repeat this parameter. | query | |
| udt.name=UDTNAME | Displays only the researchers that include data for the specified UDT name. When filtering results, you can repeat this parameter. | query | |
| udt.UDTNAME.UDFNAME[.OPERATOR]=UDFVALUE | Displays only the researchers that include the specified value for a UDF within a UDT. The system will only return researchers with UDFs that belong to a UDT; it will not return researchers with standalone UDFs. When filtering results, you can repeat this parameter. | query | |
| firstname | Displays only the researchers whose first name matches the specified value. When filtering results, you can repeat this parameter. | query | |
| lastname | Displays only the researchers whose last name matches the specified value. When filtering results, you can repeat this parameter. | query | |
| username | Displays only the researchers that match the username against the provided parameter. When filtering results, you can repeat this parameter. | query |
Output Payload
| element | produceable content type(s) |
|---|---|
| researchers (XML) |
|
| description | |
| The system returns a response that includes a list of researchers and URI links, starting from the start-index offset. | |
POST
Creates a new researcher in the system. In the client, this adds a new contact.
When creating a new researcher, you must do the following:
- You must provide a first name for the researcher.
- You must provide a last name for the researcher.
- You must provide a valid email address for the researcher.
- Provide a unique user name
- Provide a password
- Provide initials consisting of exactly 3 alphanumeric characters
If you provide credentials you must also:
Here is an example <researcher> in xml format. Note that the UDF and UDT elements are optional and must be pre-configured in the system and the lab uri will need to match your system.
<res:researcher xmlns:udf="http://genologics.com/ri/userdefined" xmlns:ri="http://genologics.com/ri" xmlns:res="http://genologics.com/ri/researcher">
<first-name>API</first-name>
<last-name>Demo</last-name>
<email>noreply@genologics.com</email>
<lab uri="http://qafunc03:8080/api/v2/labs/1"/>
<udf:type name="Researcher UDT Demo">
<udf:field type="String" name="Researcher UDF Under UDT Demo">Researcher UDF Under UDT Demo value</udf:field>
</udf:type>
<udf:field type="String" name="Researcher UDF Demo">Researcher UDF Demo value</udf:field>
<credentials>
<username>apidemo</username>
<password>apidemo</password>
<account-locked>false</account-locked>
<role name="System Administrator"/>
<role name="Collaborator"/>
<role name="Facility Administrator"/>
<role name="Researcher"/>
</credentials>
<initials>JPX</initials>
</res:researcher>
Here is an example response in xml format:
<res:researcher xmlns:udf="http://genologics.com/ri/userdefined" xmlns:ri="http://genologics.com/ri" xmlns:res="http://genologics.com/ri/researcher" uri="http://qafunc03:8080/api/v2/researchers/6>
<first-name>API</first-name>
<last-name>Demo</last-name>
<email>noreply@genologics.com</email>
<lab uri="http://qafunc03:8080/api/v2/labs/1"/>
<udf:type name="Researcher UDT Demo">
<udf:field type="String" name="Researcher UDF Under UDT Demo">Researcher UDF Under UDT Demo value</udf:field>
</udf:type>
<udf:field type="String" name="Researcher UDF Demo">Researcher UDF Demo value</udf:field>
<credentials>
<username>apidemo</username>
<password>apidemo</password>
<account-locked>false</account-locked>
<role name="System Administrator"/>
<role name="Collaborator"/>
<role name="Facility Administrator"/>
<role name="Researcher"/>
</credentials>
<initials>JPX</initials>
</res:researcher>
Input Payload
| element | consumeable content type(s) |
|---|---|
| researcher (XML) |
|
| description | |
| The information about the researcher you want to add to the system. | |
Output Payload
| element | produceable content type(s) |
|---|---|
| researcher (XML) |
|
| description | |
| When the researcher is successfully created, the system returns an HTTP 201 (Created) code with a response body that includes information about the new researcher. | |