Add

Add a new Address.

Request Format

Method

POST

URL

/addresses.<format>

Request Body

Address Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of Address

Address added

400 Bad Request


Address 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 Role, or an Org Identity must be specified to attach the Address to

403 Person Does Not Exist


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

500 Other Error


Unknown error

Delete

Remove an Address.

Request Format

Method

DELETE

URL

/addresses/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


Address deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 Address Unknown


id not found

500 Other Error


Unknown error

Edit

Edit an existing Address.

Request Format

Method

PUT

URL

/addresses/<id>.<format>

Request Body

Address Request

Response Format

HTTP Status

Response Body

Description

200 OK


Address updated

400 Bad Request


Address 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 Role, or an Org Identity must be specified to attach the Address to

403 Person Does Not Exist


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

404 Address Unknown


id not found

500 Other Error


Unknown error

View (all)

Retrieve all existing Addresses.

Request Format

Method

GET

URL

/addresses.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

Address Response

Addresses returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error

View (per person)

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

Request Format

Method

GET

URL

/addresses.<format>?[codeptid|copersonroleid|organizationid|orgidentityid]=<id>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

Address Response

Addresses returned

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

204 CO Person Role Has No Address


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

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

204 Org Identity Has No Address


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

401 Unauthorized


Authentication required

404 CO Department Unknown


id not found for CO Department

404 CO Person Role Unknown


id not found for CO Person Role

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 Address.

Request Format

Method

GET

URL

/addresses/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

Address Response

Address returned

401 Unauthorized


Authentication required

404 Address 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