PeopleAggregator API: method peopleaggregator.leaveGroup

Arguments | Return value | REST (XML) example | REST (JSON) example | XML-RPC example

Method: peopleaggregator.leaveGroup

Removes a user from a group.

User documentation for peopleaggregator.leaveGroup on the PeopleAggregator wiki

Arguments (see also Authentication)

If calling by XML-RPC, note that this method takes a single struct as input, with the following keys:

authToken

Type: string

An authentication token.

Example: 123576abcdef6572134

id

Type: string

ID of the group to leave

Example: group:1234

Return value (see also Exceptions)

Type: hash

Attributes:

success

Type: boolean

true if you have successfully left the group, or false if you were not a member or an error occurred

Example: True

Example REST (XML) request

Request

POST /api/xml/peopleaggregator/leaveGroup HTTP/1.1

Content-Type: application/x-www-form-urlencoded

Content-Length: 45



authToken=123576abcdef6572134&id=group%3A1234

Response

HTTP/1.1 200 OK

Content-Type: application/xml

Content-Length: 89



<response>

 <success>true</success>

</response>

Example REST (JSON) request

Request

POST /api/json/peopleaggregator/leaveGroup HTTP/1.1

Content-Type: application/x-www-form-urlencoded

Content-Length: 45



authToken=123576abcdef6572134&id=group%3A1234

Response

HTTP/1.1 200 OK

Content-Type: application/x-javascript

Content-Length: 17



{"success": true}

Example XML-RPC call

Request

POST /api/xmlrpc HTTP/1.1

Content-Type: text/xml

Content-Length: 992



<?xml version='1.0'?>

 <methodCall>

  <methodName>peopleaggregator.leaveGroup</methodName>

  <params>

   <param>

    <value><struct>

     <member>

      <name>authToken</name>

      <value><string>123576abcdef6572134</string></value>

     </member>

     <member>

      <name>id</name>

      <value><string>group:1234</string></value>

     </member>

    </struct></value>

   </param>

  </params>

 </methodCall>

Response

HTTP/1.1 200 OK

Content-Type: text/xml

Content-Length: 627



<?xml version='1.0'?>

 <methodResponse>

  <params>

   <param>

    <value><struct>

     <member>

      <name>success</name>

      <value><boolean>1</boolean></value>

     </member>

    </struct></value>

   </param>

  </params>

 </methodResponse>