Delete a Blog from a Network
Mon, 06/22/2009 - 16:04 — phinton
Operation Summary:
Deletes a blog and its content from a network.
Resource URL:
https://api.compendiumblog.com/app/blog/{BlogId}
HTTP method:
DELETE
Response Representations:
JSON
Permitted Roles:
Super Administrator
Super Delegate
Required Parameters:
- BlogId
- The blog's unqiue identifier.
Optional Parameters:
There are no optional parameters for this endpoint.
Response Values:
- Success
- The blog was successfully deleted.
- Error
- There was an error deleting the blog.
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 blog that was deleted. This will be the same as the BlogId 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:
- BlogId
- There is a problem with the specified BlogId
- Security
- You are not authorized to delete the specified resource
- Delete
- Unable to delete the network
Additional Notes:
- Any type of blog may be deleted from this endpoint.
- Deletion of an individual blog also deletes the user account, posts, and comments associated with the account.