Extended Attributes
If the data model has been extended using simple extended attributes, the CoPersonRole API will automatically accept and return the extended attributes, with one exception: Retrieving all CO People Roles via will not retrieve their extended attributes. This is largely due to performance reasons and how the underlying framework is structured.
Add
Add a new CO Person Role.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | CoPersonRole created |
|
| CoPersonRole Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified COU does not exist |
|
| Unknown error |
Delete
Remove a CO Person Role.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoPersonRole deleted |
|
|
|
|
| Authentication required |
|
|
|
|
| Unknown error |
Edit
Edit an existing CO Person Role.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoPersonRole updated |
|
| CoPersonRole Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified COU does not exist |
|
|
|
|
| Unknown error |
View (all)
Retrieve all existing CO Person Roles.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPersonRoles returned | |
|
| Authentication required |
|
| Unknown error |
View (per CO Person)
Retrieve all existing CO Person Roles for the specified CO Person. Available since Registry v2.0.0.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPersonRoles returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
View (per COU)
Retrieve all existing CO Person Roles for the specified COU.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPersonRoles returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
View (one)
Retrieve an existing CO Person Role.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPersonRole returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.