...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| NewObjectResponse with | Identifier added | |
|
| Identifier Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields | |
| Authentication required | ||
| An entry already exists with the specified identifier | ||
| A CO Department, a CO Person, or an Org Identity must be specified to attach the Identifier to | ||
| The specified CO Department, CO Person, or Org Identity does not exist | ||
| Unknown error |
...
Assign
Assign Identifiers for a CO Person.
...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Identifiers assigned (one or more identifiers may already have existed) | ||
| Identifier Request not provided in POST body | ||
| ErrorResponse with details in | An error in one or more provided fields | |
|
| Authentication required | |
| A CO Person must be specified to attach the Identifiers to | ||
| The specified CO Person does not exist | ||
| Unknown error |
...
Delete
Remove an Identifier.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
|
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Identifier deleted | ||
|
|
| |
| Authentication required | ||
|
| ||
| Unknown error |
...
Edit
Edit an existing Identifier.
...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Identifier updated | ||
| Identifier Request not provided in POST body | ||
| ErrorResponse with details in | An error in one or more provided fields | |
| Authentication required | ||
| An entry already exists with the specified identifier | ||
| A CO Department, CO Person, or Org Identity must be specified to attach the Address to | ||
|
| The specified CO Department, CO Person, or Org Identity does not exist | |
|
| ||
| Unknown error |
...
View (all)
Retrieve all existing Identifiers.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Identifiers returned | ||
|
| Authentication required | |
| Unknown error |
...
View (per
...
entity)
Retrieve Identifiers attached to a CO Department, Co Group, CO Person, or Org Identity.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Identifier returned | ||
204 CO Department Has No Identifier | The requested CO Department was found, but has no identifiers attached | ||
204 CO Group Has No Identifier | The requested CO Department Group was found, but has no identifiers attached | ||
|
| The requested CO Person was found, but has no identifiers attached | |
|
| The requested Org Identity was found, but has no identifiers attached | |
|
| Authentication required | |
|
| ||
|
| ||
|
| ||
|
| ||
| Unknown error |
...
View (one)
Retrieve an existing Identifier.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
|
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Identifier returned | ||
| Authentication required | ||
|
|
| |
| Unknown error |
...
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
...