Loading...

GROU.PS API

GROU.PS API
groups-api
Protocol: REST
Access: http://grou.ps/api.php
Click here to get your API key (Coming soon)
  1. generals
    1. getMembersCount
      • @param string groupName
      • @return integer
      • @example
        • http://grou.ps/api.php?function=generals&operation=getMembersCount&group_name=linux
    2. getTagline
      • @param string groupName
      • @return string
      • @example
        • http://grou.ps/api.php?module=generals&method=getTagline&groupName=linux
    3. getDescription
      • @param string groupName
      • @return string
      • @example
        • http://grou.ps/api.php?module=generals&method=getDescription&groupName=linux
    4. getTitle
      • @param string groupName
      • @return string
      • @example
        • http://grou.ps/api.php?module=generals&method=getTitle&groupName=linux
    5. groupExists
      • @param string groupName
      • @return boolean
      • @example
        • http://grou.ps/api.php?module=generals&method=groupExists&groupName=linux
    6. addNewMember
      • @param string groupName
      • @param string memberName
      • @example
        • http://grou.ps/api.php?module=generals&method=addNewMember&groupName=linux&memberName=johndoe
    7. getMembers
      • @param string groupName
      • @return array
      • @example
        • http://grou.ps/api.php?module=generals&method=getMembers&groupName=linux
  2. members
    1. getNameSurname
      • @param string groupName
      • @param string username
      • @return string
      • @example
        • http://grou.ps/api.php?module=members&method=getNameSurname&groupName=linux&username=johndoe
    2. 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
    3. getBirthday
      • @param string groupName
      • @param string username
      • @return string
      • @example
        • http://grou.ps/api.php?module=members&method=getBirthday&groupName=linux&username=johndoe
    4. 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
    5. getPhoto
      • @param string groupName
      • @param string username
      • @return string
      • @example 
        • http://grou.ps/api.php?module=members&method=getPhoto&groupName=linux&username=johndoe
    6. setPhoto
      • not documented
    7. getNationality
      • @param string groupName
      • @param string username
      • @return string
      • @example
        • http://grou.ps/api.php?module=members&method=getNationality&groupName=linux&username=johndoe
    8. 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
    9. getGender
      • @param string groupName
      • @param string username
      • @return string
      • @example
          • http://grou.ps/api.php?module=members&method=getGender&groupName=linux&username=johndoe
    10. 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
  3. talks
    1. getCategories
      • @param string groupName
      • @return array
      • @example
        • http://grou.ps/api.php?module=talks&method=getCategories&groupName=linux
    2. getMessageList
      • not documented
    3. getMessage
      • @param string groupName
      • @param integer messageId
      • @return string
      • @example
        • http://grou.ps/api.php?module=talks&method=getMessage&groupName=linux&messageId=1
    4. searchMessages
      • not documented
    5. 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
    6. 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
  4. calendar
    1. getEventList
      • @param string groupName
      • @param integer year
      • @return array
      • @example
        • http://grou.ps/api.php?module=calendar&method=getEventList&groupName=linux&year=2009
    2. getEvent
      • @param string groupName
      • @param integer eventId
      • @return string
      • @example
        • http://grou.ps/api.php?module=calendar&method=getEvent&groupName=linux&eventId=1
    3. setEvent
      • not documented
  5. files
    1. getFileList
      • @param string groupName
      • @return array
      • @example
        • http://grou.ps/api.php?module=files&method=getFileList&groupName=linux
    2. getFile
      • @param string groupName
      • @param string fileId
      • @return string
      • @example
        • http://grou.ps/api.php?module=files&method=getFile&groupName=linux&fileId=1
    3. addFile
      • not documented