GET /api/groups/requests/{MembershipRequestID}

Returns the state value for the specified group membership request.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/groups/requests/{MembershipRequestID}

Back to top

Sample Request

The example below shows a request for the status of the specified group membership request.

Request URL

https://{hostname}/api/groups/requests/group_member_req24560.acmepaymentscorp

Sample request headers

Accept: text/plain

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
MembershipRequestID Path string Required A unique ID assigned by the platform to the team membership request.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the group membership state for the specified membership request.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Date: Fri, 14 Jun 2013 18:27:39 GMT

Sample response body

com.soa.group.membership.state.pending

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
Group membership state string The group membership state for the specified membership request.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics