Add
Add a new Organization.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | Organization created |
| Organization Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| Unknown error |
Delete
Remove an Organization.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Organization deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit
Edit an existing Organization.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Organization updated | |
| Organization Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
|
| |
| Unknown error |
View (all)
Retrieve all existing Organizations.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Organizations returned | |
| Authentication required | |
| Unknown error |
View (per CO)
Retrieve Organizations attached to a CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Organization returned | |
| Authentication required | |
|
| |
| Unknown error |
View (one)
Retrieve an existing Organization.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Organization 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_organizations data model definition