Add

Add a new EmailAddress.

Request Format

Method

POST

URL

/email_addresses.<format>

Request Body

EmailAddress Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of EmailAddress

EmailAddress added

400 Bad Request


EmailAddress Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

403 No Person Specified


A CO Department, a CO Person, or an Org Identity must be specified to attach the Email Address to

403 Person Does Not Exist


The specified CO Department, CO Person, or Org Identity does not exist

500 Other Error


Unknown error

Delete

Remove an EmailAddress.

Request Format

Method

DELETE

URL

/email_addresses/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


EmailAddress deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 EmailAddress Unknown


id not found

500 Other Error


Unknown error

Edit

Edit an existing EmailAddress.

Request Format

Method

PUT

URL

/email_addresses/<id>.<format>

Request Body

EmailAddress Request

Response Format

HTTP Status

Response Body

Description

200 OK


EmailAddress updated

400 Bad Request


EmailAddress Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

403 No Person Specified


A CO Department, a CO Person, or an Org Identity must be specified to attach the Email Address to

403 Person Does Not Exist


The specified CO Department, CO Person, or Org Identity does not exist

404 EmailAddress Unknown


id not found

500 Other Error


Unknown error

View (all)

Retrieve all existing EmailAddresses.

Request Format

Method

GET

URL

/email_addresses.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

EmailAddress Response

EmailAddresses returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error

View (per person)

Retrieve EmailAddresses attached to a CO Department, CO Person, or Org Identity.

Request Format

Method

GET

URL

/email_addresses.<format>?[codeptid|copersonid|organizationid|orgidentityid]=<id>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

EmailAddress Response

EmailAddress returned

204 CO Department Has No EmailAddress
The requested CO Department was found, but has no email addresses attached

204 CO Person Has No EmailAddress


The requested CO Person was found, but has no email addresses attached

204 Organization Has No EmailAddress
The requested Organization was found, but has no email addresses attached

204 Org Identity Has No EmailAddress


The requested Org Identity was found, but has no email addresses attached

401 Unauthorized


Authentication required

404 CO Department Unknown


id not found for CO Department

404 CO Person Unknown


id not found for CO Person

404 Organization Unknown
id not found for Organization

404 Org Identity Unknown


id not found for Org Identity

500 Other Error


Unknown error

View (one)

Retrieve an existing EmailAddress.

Request Format

Method

GET

URL

/email_addresses/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

EmailAddress Response

EmailAddress returned

401 Unauthorized


Authentication required

404 EmailAddress Unknown


id not found

500 Other Error


Unknown error

Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels