...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| NewObjectResponse with | CoPerson created | |
|
| CoPerson Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields | |
| Authentication required | ||
| The specified CO does not exist | ||
| Unknown error |
...
Delete
Remove a CO Person. This method will also delete related data, such as CoPersonRoles, EmailAddresses, and Identifiers. A person must be removed from any COs (CoPerson records must be deleted) before the OrgIdentity record can be removed.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
|
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoPerson deleted | ||
|
|
| |
|
| Authentication required | |
| The Person has one or more Person Role records and cannot be deleted | ||
|
| The Person has a role in one or more COUs that the authenticated user does not control | |
|
| ||
| Unknown error |
...
Edit
Edit an existing CO Person.
...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoPerson updated | ||
|
| CoPerson Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields | |
| Authentication required | ||
| The specified CO does not exist | ||
|
| ||
| Unknown error |
...
Match
Attempt to match existing CO Person records.
Note that matching is not performed on search criteria of less than 3 characters, or for email addresses that are not syntactically valid.
| Note | ||
|---|---|---|
| ||
This API call is likely to evolve to accept search criteria more flexibly. It may change across minor releases. |
...
Method |
|
|---|---|
URL |
|
Request Body |
mail was added in Registry v3.3.0.
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoPerson returned (zero or more matches may be returned) | ||
| Authentication required | ||
|
| ||
|
| Unknown error |
Not currently implemented -- unknown CO will return an empty set...
View (all)
Retrieve all existing CO People.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
|
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoPerson returned | ||
|
| Authentication required | |
| Unknown error |
...
View (per CO)
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
|
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoPeople returned | ||
| Authentication required | ||
|
| ||
|
| Unknown error |
...
View (per Identifier)
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoPeople returned | ||
| Authentication required | ||
|
| ||
|
| Unknown error |
...
View (one)
Retrieve an existing CO Person.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoPerson returned | ||
| Authentication required | ||
|
|
| |
| Unknown error |
...
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
...