Delete a Post
Mon, 09/06/2010 - 23:51 — phinton
Operation Summary:
Delete a post from the application by setting its status to 'deleted'
Resource URL:
https://api.compendiumblog.com/app/post/{PostId}
HTTP method:
DELETE
HTTP Status Codes:
200 OK
400 Bad Request
403 Forbidden
405 Method Not Allowed
HTTP Status Code Details:
200 OK
If your post is deleted successfully you will get back a 200 response code.
400 Bad Request
If you attempt to delete a non-existent post, you will get back a 201 response code.
403 Forbidden
You have tried to delete a post for which you do not have sufficient permissions.
Response Representations:
JSON (application/json)
Permitted Roles:
Super Administrator
Super Delegate
Network Administrator
Default Permissions
Required Parameters:
- PostId
- The unique identifier of the post that is being deleted. This parameter is supplied as part of the request URI rather than as a standalone parameter.
Optional Parameters:
There are no optional parameters for this operation.
Response Values:
- Success
- The post was deleted successfully.
- Error
- The post was not successfully deleted.
Response Structure:
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 is the system assigned unique identifier for the post that was just deleted. 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:
- PostId
- The specified PostId was not valid.
- Write
- An error occurred while attempting to write data to storage.
- Security
- The requesting user's assigned roles were not sufficient to perform the operation.
Supported Event:
There are no supported events for this resource operation.
Additional Notes:
- Successfully invoking this endpoint changes the post's status to
deleted, regardless of the posts's current approval status. The post will be suppressed from post listings and will no longer be available for further modification. - Deletion is not a reversible operation. Use with caution.
curl -H "Accept: application/vnd.compendium.blog;version=2,application/json" --user someuser:mgc3crqk45ufzkfb -XDELETE https://api.test.compendiumblog.com/app/post/4a799373-ee13-41c4-a12a-35f...