Web service API

How to use PageSeeder's Web service API

decline invitation

/members/{member}/declineinvitation [POST]

com.pageseeder.membership.DeclineInvitation

Description

Decline an invitation to a group.

Parameters

NameDescriptionRequiredTypeDefault value
mfgidThe membership IDyeslong

mfgid

This required parameter is membership ID for the member. It must be a valid long value.

Permission

An authenticated member can invoke this service and it must match the member specified in the URL as the membership object or be an administrator.

In other words, this service can only be used by a member to decline an invitation that they have received. It can also be used to decline an invitation on behalf of another member by an administrator.

Response

When successful, it is always:

<invitation declined="true"/>

Error handling

CodeCause / Description
0x1012 When the supplied membership ID (MemberForGroup id) is invalid.
0x1013 When the member has already accepted the invitation.

Created on , last edited on