API Reference

Events.removeMember

Removes a member from an event.

This can be used by registered users to remove themselves from a group they're a member of. In this case the "uid" parameter should be left as its default.

This may also be used by privileged users (those with the events.removeMember permission) to remove other users within the event's vhost from an event.


Syntax

mixed events.removeMember ( int eventId, int uid = NULL )

Arguments

NameTypeRequiredDefault valueDescription
eventIdintRequirednoneThe event ID you are removing the user from.
uidintOptionalNULLThe ID of the user you are removing from the event.

Response

Will return whether or not the member has been successfully removed from the desired group.

NameTypeDescription
resultINTUpon success the response will be 1.

Sample Response

Sample REST Response
http://api.filemobile.com/services/rest/events/removeMember?eventId=[EVENT_ID]&uid=[USER_ID]
<?xml version="1.0" encoding="UTF-8"?>
<result>1</result>
Sample JSON Response
{
    "status": true,
    "result": 1
}

Code examples

0 comments

Be the first to comment on removeMember.

Add a Comment

  • captcha