DELETE:groups/{groupid}

1. Overview
1. 1. 1. 1.1.1.1. Uri Parameters
    2. 1.1.1.2. Query Parameters
    3. 1.1.1.3. Return Codes
2. Message Format
3. Implementation Notes
4. Code Samples

Overview

public. Remove a group

Uri Parameters

Name	Type	Description
groupid	string	either an integer group ID or "=" followed by a double uri-encoded group name

Query Parameters

None

Return Codes

Name	Value	Description
BadRequest	400	Invalid input parameter or request body
Forbidden	403	Administrator access is required
NotFound	404	Requested group could not be found
Ok	200	Request completed successfully

Message Format

None

Implementation Notes

Groups provide the ability to associate a collection of users with a predefined role.

Use GET:groups to retrieve a list of existing groups.

Code Samples

The following code example deletes the group with ID 2:

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("groups", "2").Delete();

Retrieved from "http://wiki.developer.mindtouch.com/index.php?title=MindTouch_Deki/API_Reference/DELETE:groups%2F%2F%7Bgroupid%7D"

Tag page
What links here

Files 0

Attach file or image

Images 0

You must login to post a comment.