API Reference

Groups.isMediaInGroup

Checks whether a media item is in a group.

A simple boolean will be returned, true if the media item is in the group, false otherwise.


Syntax

bool groups.isMediaInGroup ( int groupID, int mediaID )

Arguments

NameTypeRequiredDefault valueDescription
groupIDintRequirednoneThe ID of the group that you want to search the media in.
mediaIDintRequirednoneThe media ID you want to check if it is a member of the specified group.

Response

The response will contain 1 if the media item is in the specified group ID.

NameTypeDescriptionSuccessERROR
resultINTIf the media ID is a member of the group a response of 1 will be returned. If the media item is not a member of the group the response will be empty.<result>1</result><result/>

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/groups/isMediaInGroup?groupID=[GROUP_ID]&mediaID=[MEDIA_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 isMediaInGroup.

Add a Comment

  • captcha