/{version}/researchers/{researcherid}
The following operations are supported on this resource:
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)
|
|
| description |
| The system returns a response that includes the XML representation of the researcher. |
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)
|
|
| description |
| The information about the researcher you would like to update. |
Output Payload
| element |
produceable content type(s) |
|
researcher (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. |
Removes a specified researcher from the system.
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)
|
|
| description |
| When the researcher is successfully removed, the system returns an HTTP 204
(No Content) code with an empty response body. |