Add
Add a new Url.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | Url added |
| Url Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| CO Department, a CO Person Role, or an Org Identity must be specified to attach the URL to | |
| The specified CO Department, CO Person Role, or Org Identity does not exist | |
| Unknown error |
Delete
Remove a Url.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Address deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit
Edit an existing Url.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Url updated | |
| Url 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 Telephone Number to | |
| The specified CO Department, CO Person Role, or Org Identity does not exist | |
|
| |
| Unknown error |
View (all)
Retrieve all existing Urls.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Urls returned | |
| Authentication required | |
| Unknown error |
View (per person)
Retrieve Urls attached to a CO Department, CO Person Role, or Org Identity.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Url returned | |
204 CO Department Has No Url | The requested CO Department was found, but has no Urls attached | |
| The requested CO Person Role was found, but has no Urls attached | |
| The requested Organization was found, but has no Urls attached | |
| The requested Org Identity was found, but has no Urls attached | |
| Authentication required | |
|
| |
|
| |
|
| |
|
| |
| Unknown error |
View (one)
Retrieve an existing Url.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Url returned | |
| Authentication required | |
|
| |
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_urls data model definition