...
Add a new EmailAddress.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | EmailAddress added |
|
| EmailAddress Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
|
A CO Department, a CO Person, or an Org Identity must be specified to attach the Email Address to | ||
|
| The specified CO Department, CO Person, or Org Identity does not exist |
|
| Unknown error |
...
Delete
Remove an EmailAddress.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| EmailAddress deleted |
|
|
|
|
| Authentication required |
|
|
|
|
| Unknown error |
...
Edit
Edit an existing EmailAddress.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| EmailAddress updated |
|
| EmailAddress Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
|
A CO Department, a CO Person, or an Org Identity must be specified to attach the Email Address to | ||
|
| The specified CO Department, CO Person, or Org Identity does not exist |
|
|
|
|
| Unknown error |
...
View (all)
Retrieve all existing EmailAddresses.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| EmailAddresses returned | |
|
| Authentication required |
|
| Unknown error |
...
View (per person)
Retrieve EmailAddresses attached to a CO Department, CO Person, or Org Identity.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| EmailAddress returned | |
204 CO Department Has No EmailAddress | The requested CO Department was found, but has no email addresses attached | |
|
| The requested CO Person was found, but has no email addresses attached |
|
| The requested Org Identity was found, but has no email addresses attached |
|
| Authentication required |
|
|
|
|
|
|
|
|
|
|
| Unknown error |
...
View (one)
Retrieve an existing EmailAddress.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| EmailAddress returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
...
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
...