Delete a Network
Fri, 06/12/2009 - 16:39 — bmatheny
Operation Summary:
Deletes a network and all associated assets including users, blogs, posts and comments.
Resource URL:
https://api.compendiumblog.com/app/network/{NetworkId}
HTTP method:
DELETE
Response Representations:
JSON
Permitted Roles:
Super Administrator
Super Delegate
Required Parameters:
- NetworkId
- As part of the URI, a valid NetworkId must be specified
Optional Parameters:
None.
Response Values:
- Success
- The network was successfully deleted.
- Error
- There was an error deleting the network.
Response Structure:
JSON
Responses are single-member objects which have a property name based on the type of result.
The Success result will look like:
{ 'Success' : string }
where the string value is the GUID for the network that was deleted. This will be the same as the NetworkId that was submitted as part of the request.
The Error result will be a flat array of objects, which have keys for the message name and explanatory text.
{
'Error' : [
{ 'Name' : string, 'Message' : string },
{ 'Name' : string, 'Message' : string },
...
]
}
Error Types:
- NetworkId
- There is a problem with the specified Networkid
- Security
- You are not authorized to delete the specified resource
- Delete
- Unable to delete the network
Command Line Example
curl --request DELETE --header "Accept: application/vnd.compendium.blog;version=2,application/json" --user someuser:mgc3crqk45ufzkfb https://api.test.compendiumblog.com/app/network/some_network_identifier