...
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 |
...
Find
Search for existing CO Person records.
When too many records are found, a message may be returned rather than specific records.
| Note | ||
|---|---|---|
| ||
This API call is currently intended only to support the People Picker user interface element. It does not currently support RESTful response codes. It may change across minor releases. It may be eventually be merged with the Match API. The Find API is available as of Registry v3.3.0. |
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
where
- id: CO ID
- mode: Search context, currently the only supported value is S (Sponsor Mode)
- string: Search string, which may be a partial or full name token, or a complete Email Address or Identifier
Response Format
A JSON array of objects, where each object contains a label (human readable string) and value (CO Person ID).
...
Match
Attempt to match existing CO Person records.
...
| Note | ||
|---|---|---|
| ||
This API call is likely to evolve to accept search criteria more flexibly. It may change across minor releases. It may eventually be removed in favor of the Find API. |
Request Format
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...
Retrieve all existing CO People.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPerson returned | |
| Authentication required | |
| Unknown error |
...
Retrieve all existing CO People for the specified CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPeople returned | |
| Authentication required | |
|
| |
| Unknown error |
...
Retrieve all existing CO People attached to the specified identifier. Note the specified identifier must be attached to a CO Person, not an Org Identity.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPeople returned | |
| Authentication required | |
|
| |
| Unknown error |
...
Retrieve an existing CO Person.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoPerson returned | |
| Authentication required | |
|
| |
| Unknown error |
...