/{version}/researchers/{researcherid}

The following operations are supported on this resource:

• GET
• PUT
• DELETE

GET

Displays the XML representation of a specified researcher.

Parameters

name	description	type	default
researcherid	The ID of the researcher you would like to display.	path

Output Payload

element	produceable content type(s)
researcher (XML)	application/xml
description
The system returns a response that includes the XML representation of the researcher.

PUT

Updates the characteristics of a specified researcher.

When submitting a PUT request, you can update the following researcher attributes:

• first-name
• last-name
• initials: must be 3 alphanumeric characters when provided. Any researcher with credentials must have initials.
• email
• phone
• fax
• field: You must include all current UDFs recorded for the researcher, even if you do not want to update the UDF values. However, you can add new UDF values, and update or remove current UDF values.
• type: You must include the current UDT recorded for the researcher, even if you do not want to update the UDT values. However, you can replace the current UDT with another UDT, or you can add or remove fields within the current UDT.
• credentials: If you change the username a new password must also be provided at that time.

If you attempt to update attributes that cannot be modified, the system will ignore those elements of the PUT request.

Parameters

name	description	type	default
researcherid	The ID of the researcher you would like to update.	path

Input Payload

element	consumeable content type(s)
researcher (XML)	*/* application/xml
description
The information about the researcher you would like to update.

Output Payload

element	produceable content type(s)
researcher (XML)	application/xml
description
When the researcher is successfully updated, the system returns an HTTP 200 (OK) code with a response body that includes the updated attributes of the researcher.

DELETE

Removes a specified researcher from the system.

A researcher can only be deleted if they meet the following criteria:

• They are not associated with a project
• If they have login credentials, they have never successfully logged in
• They are not managed by LDAP

If the above criteria are not met, the researcher can still be disabled by setting their 'account-locked' flag to true (this corresponds to archiving a User or Client in the Clarity User Management Interface)

Parameters

name	description	type	default
researcherid	The ID of the researcher you would like to remove.	path

Output Payload

element	produceable content type(s)
researcher (XML)	application/xml
description
When the researcher is successfully removed, the system returns an HTTP 204 (No Content) code with an empty response body.