...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| NewObjectResponse with | Address added | |
|
| Address 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 Role, or an Org Identity must be specified to attach the Address to | |
|
| The specified CO Department, CO Person Role, or Org Identity does not exist | |
| Unknown error |
...
Delete
Remove an Address.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
|
| Address deleted | |
|
| ||
| Authentication required | ||
|
| ||
| Unknown error |
...
Edit
Edit an existing Address.
...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Address updated | ||
|
| Address 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 Role, or an Org Identity must be specified to attach the Address to | ||
| The specified CO Department, CO Person Role, or Org Identity does not exist | ||
|
| ||
| Unknown error |
...
View (all)
Retrieve all existing Addresses.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Addresses returned | |
| Authentication required | |
| Unknown error |
...
View (per person)
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| Addresses returned | ||
204 CO Department Has No Address | The requested CO Department was found, but has no addresses attached | ||
| 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 | ||
| The requested Org Identity was found, but has no addresses attached | ||
| Authentication required | ||
|
|
| |
|
|
| |
404 Organization Unknown | id not found for Organization | ||
|
| ||
| Unknown error |
...
View (one)
Retrieve an existing Address.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Address returned | |
| Authentication required | |
|
| |
| Unknown error |
...
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
...