GROU.PS API | Wiki | Knowledge Base | GROU.PS Founders Network

Loading...

GROU.PS API

Protocol: REST
Access: http://grou.ps/api.php
Click here to get your API key (Coming soon)

generals

getMembersCount

@param string groupName
@return integer
@example

http://grou.ps/api.php?module=generals&method=getMembersCount&groupName=linux

getTagline

@param string groupName
@return string
@example

http://grou.ps/api.php?module=generals&method=getTagline&groupName=linux

getDescription

@param string groupName
@return string
@example

http://grou.ps/api.php?module=generals&method=getDescription&groupName=linux

getTitle

@param string groupName
@return string
@example

http://grou.ps/api.php?module=generals&method=getTitle&groupName=linux

groupExists

@param string groupName
@return boolean
@example

http://grou.ps/api.php?module=generals&method=groupExists&groupName=linux

addNewMember

@param string groupName
@param string memberName
@example

http://grou.ps/api.php?module=generals&method=addNewMember&groupName=linux&memberName=johndoe

getMembers

@param string groupName
@return array
@example

http://grou.ps/api.php?module=generals&method=getMembers&groupName=linux

members

getNameSurname

@param string groupName
@param string username
@return string
@example

http://grou.ps/api.php?module=members&method=getNameSurname&groupName=linux&username=johndoe

setNameSurname

@param string groupName
@param string username
@param string newUsername
@return boolean
@example

http://grou.ps/api.php?module=members&method=setNameSurname&groupName=linux&username=johndoe&newUsername=mrjohndoe

getBirthday

@param string groupName
@param string username
@return string
@example

http://grou.ps/api.php?module=members&method=getBirthday&groupName=linux&username=johndoe

setBirthday

@param string groupName
@param string username
@param string newBirthday
@return boolean
@example

http://grou.ps/api.php?module=members&method=getBirthday&groupName=linux&username=johndoe&newBirthday=03/08/1985

getPhoto

@param string groupName
@param string username
@return string
@example

http://grou.ps/api.php?module=members&method=getPhoto&groupName=linux&username=johndoe

setPhoto

not documented

getNationality

@param string groupName
@param string username
@return string
@example

http://grou.ps/api.php?module=members&method=getNationality&groupName=linux&username=johndoe

setNationality

@param string groupName
@param string username
@param string newNationality
@return boolean
@example

http://grou.ps/api.php?module=members&method=setNationality&groupName=linux&username=johndoe&newNationality=TR

getGender

@param string groupName
@param string username
@return string
@example

http://grou.ps/api.php?module=members&method=getGender&groupName=linux&username=johndoe

setGender

@param string groupName
@param string username
@param string newGender
@return boolean
@example

http://grou.ps/api.php?module=members&method=setGender&groupName=linux&username=johndoe&newGender=male

talks

getCategories

@param string groupName
@return array
@example

http://grou.ps/api.php?module=talks&method=getCategories&groupName=linux

getMessageList

not documented

getMessage

@param string groupName
@param integer messageId
@return string
@example

http://grou.ps/api.php?module=talks&method=getMessage&groupName=linux&messageId=1

searchMessages

not documented

postNewMessage

@param string groupName
@param string subject
@param string message
@return boolean
@example

http://grou.ps/api.php?module=talks&method=postNewMessage&groupName=linux&subject=APInTest&message=API Test Message

replyMessage

@param string groupName
@param integer messageId
@param string message
@example

http://grou.ps/api.php?module=talks&method=replyMessage&groupName=linux&messageId=1&message=My Reply Message

calendar

getEventList

@param string groupName
@param integer year
@return array
@example

http://grou.ps/api.php?module=calendar&method=getEventList&groupName=linux&year=2009

getEvent

@param string groupName
@param integer eventId
@return string
@example

http://grou.ps/api.php?module=calendar&method=getEvent&groupName=linux&eventId=1

setEvent

not documented

files

getFileList

@param string groupName
@return array
@example

http://grou.ps/api.php?module=files&method=getFileList&groupName=linux

getFile

@param string groupName
@param string fileId
@return string
@example

http://grou.ps/api.php?module=files&method=getFile&groupName=linux&fileId=1

addFile

not documented

Tweet
SHARE