Campus Karma - List of APIs

Instructions

How to use the APIs


Campus Karma provides a powerful framework for building web services. This allows developers to expose functionality to other web sites, desktop applications or mobile application along with doing integrations with third-party web applications. While we call the API RESTful, it is actually a REST/RPC hybrid similar to the APIs provided by sites like Flickr and Twitter.

Go to https://campuskarma.in/services/api/rest/json/?method=system.api.list and you should be able to see all the method listed as API call.
The same APIs has been listed below as you can see the method name in the below list along with other relevant details.

To call the APIs, all you need to do is call the expose method in your application.
For example, if you want to use the user login API, you could make a POST request to the url: https://campuskarma.in/services/api/rest/json/?method=auth.gettoken&username=your_username&password=your_password (where auth.gettoken is one of the APIs listed below) and you should see JSON data like this:
 {
  "status": 0,
  "result": {
     "auth_token": "afadfadf99adf0fg9f98778adfa",
     "api_key": "afdakfljl3243fajlkfdj8982832493dsfweioruewior"
  }
 }
You can find the list of exposed methods below along with the following information within the API block:
  • description: Description of the API to help you understand the purpose of the API.
  • function: Function used for the API (Internal - Only used for debugging of error if any).
  • parameters: Parameter required to pass after the "https://campuskarma.in/services/api/rest/json/?" url separated by "&".
  • call_method: Defines the call_method either as GET or POST.
  • require_api_auth: If "true" you have to pass the the api_key that is return from auth.gettoken API as shown above.
  • require_user_auth: If "true" you have to pass the the auth_token that is return from auth.gettoken API as shown above.

  • The auth_token default expire is set to 60 minutes. The auth_token will return different value each time you make a call, however the api_key will be same.
Note to developers: Further to add to the above instruction, Campus Karma uses a framework called Elgg for its web services.
There are lots of information available on the official elgg community website regarding the web services of Elgg.

List of APIs

search.site

  •     search.site": {
          "description": "Search the Site",
          "parameters": {
            "q": {
              "type": "string",
              "required": true
            },
            "offset": {
              "type": "int",
              "required": false
            },
            "search_type": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "entity_type": {
              "type": "string",
              "required": false
            },
            "entity_subtype": {
              "type": "string",
              "required": false
            },
            "sort": {
              "type": "string",
              "required": false
            },
            "order": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": false,
          "require_user_auth": false
        },

album.get_posts

  •     album.get_posts: {
          "description": "GET all the albums",
          "function": "album_get_posts",
          "parameters": {
            "context": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

album.getid

  •     album.getid: {
          "description": "Get album id",
          "function": "album_getid",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

auth.gettoken

  •     auth.gettoken: {
          "description": "This API call lets a user obtain a user authentication token which can be used for authenticating future API calls.
    	  Pass it as the parameter auth_token",
          "function": "auth_gettoken",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "password": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": false,
          "require_user_auth": false
        },

auth.token_check

  •     auth.token_check: {
          "description": "Post a auth token check",
          "function": "auth_token_check",
          "parameters": {
            "token": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            },
            "password": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": false
        },

blog.delete_post

  •     blog.delete_post: {
          "description": "Read a blog post",
          "function": "blog_delete_post",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

blog.get_comments

  •     blog.get_comments: {
          "description": "Get comments for a blog post",
          "function": "blog_get_comments",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

blog.get_post

  •     blog.get_post: {
          "description": "Read a blog post",
          "function": "blog_get_post",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

blog.get_posts

  •     blog.get_posts: {
          "description": "Get list of blog posts",
          "function": "blog_get_posts",
          "parameters": {
            "context": {
              "type": "string",
              "required": true,
              "default": "all"
            },
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "group_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

blog.post_comment

  •     blog.post_comment: {
          "description": "Post a comment on a blog post",
          "function": "blog_post_comment",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "text": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

blog.save_post

  •     blog.save_post: {
          "description": "Post a blog post",
          "function": "blog_save_post",
          "parameters": {
            "title": {
              "type": "string",
              "required": true
            },
            "body": {
              "type": "string",
              "required": true
            },
            "comment_status": {
              "type": "string",
              "required": true,
              "default": "On"
            },
            "access": {
              "type": "string",
              "required": true,
              "default": -2
            },
            "status": {
              "type": "string",
              "required": true,
              "default": "published"
            },
            "username": {
              "type": "string",
              "required": true
            },
            "tags": {
              "type": "string",
              "required": false,
              "default": ""
            },
            "excerpt": {
              "type": "string",
              "required": false,
              "default": ""
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

bookmark.get_comments

  •     bookmark.get_comments: {
          "description": "Get comments for a bookmark post",
          "function": "blog_get_comments",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

bookmark.get_post

  •     bookmark.get_post: {
          "description": "Read a bookmark post",
          "function": "bookmark_get_post",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

bookmark.get_posts

  •     bookmark.get_posts: {
          "description": "GET all the bookmarks",
          "function": "bookmark_get_posts",
          "parameters": {
            "context": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "username": {
              "type": "string",
              "required": false
            },
            "from_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

bookmark.post_comment

  •     bookmark.post_comment: {
          "description": "Post a comment on a bookmark post",
          "function": "bookmark_post_comment",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "text": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

bookmark.save_post

  •     bookmark.save_post: {
          "description": "Post a bookmark post",
          "function": "bookmark_save_post",
          "parameters": {
            "title": {
              "type": "string",
              "required": true
            },
            "address": {
              "type": "string",
              "required": true
            },
            "description": {
              "type": "string",
              "required": true
            },
            "access": {
              "type": "string",
              "required": true,
              "default": -2
            },
            "username": {
              "type": "string",
              "required": true
            },
            "tags": {
              "type": "string",
              "required": false,
              "default": ""
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

count.like_comment

  •     count.like_comment: {
          "description": "Get number count like and comment",
          "function": "count_like_comment",
          "parameters": {
            "entity_guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

file.get_comments

  •     file.get_comments: {
          "description": "Get comments for a post",
          "function": "file_get_comments",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

file.delete_comment

  •    file.delete_comment: {
          "description": "Delete file comment",
          "parameters": {
            "comment_guid": {
              "type": "int",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
          },

file.delete_post

  •    file.delete_post: {
          "description": "Delete file post",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
          },

file.update_post

  •     file.update_post: {
          "description":"Update file post",
          "function": "file_update_post",
          "parameters":{  
            "guid":{  
              "type":"int",
              "required":true
            },
            "title":{  
              "type":"string",
              "required":true
            },
            "description":{  
              "type":"string",
              "required":true
            },
            "username":{  
              "type":"string",
              "required":true
            },
            "access":{  
              "type":"string",
              "required":true,
              "default":-2
            },
            "tags":{  
              "type":"string",
              "required":false,
              "default":""
            }
          },
          "call_method":"POST",
          "require_api_auth":true,
          "require_user_auth":true
        },

file.get_file

  •     file.get_file: {
          "description": "Get file data",
          "function": "file_get_file",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

file.get_files

  •     file.get_files: {
          "description": "Get file uploaded by all users",
          "function": "file_get_files",
          "parameters": {
            "context": {
              "type": "string",
              "required": true,
              "default": "all"
            },
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "group_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

file.get_post

  •     file.get_post: {
          "description": "Get file post",
          "function": "file_get_post",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "size": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

file.post_comment

  •     file.post_comment: {
          "description": "Post a comment on a file post",
          "function": "file_post_comment",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "text": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

file.save_post

  •     file.save_post: {
          "description": "Upload file post",
          "function": "file_save_post",
          "parameters": {
            "title": {
              "type": "string",
              "required": true
            },
            "description": {
              "type": "string",
              "required": false
            },
            "username": {
              "type": "string",
              "required": true
            },
            "access": {
              "type": "string",
              "required": true,
              "default": -2
            },
            "tags": {
              "type": "string",
              "required": false,
              "default": ""
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

gcm.register

  •     gcm.register: {
          "description": "GCM a Register for Notification",
          "function": "gcm_register",
          "parameters": {
            "regId": {
              "type": "string",
              "required": true
            },
            "account": {
              "type": "string",
              "required": true
            },
            "name": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": false
        },

group.get_activity

  •     group.get_activity: {
          "description": "GET group activity",
          "function": "group_get_activity",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "username": {
              "type": "string",
              "required": false
            },
            "from_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

group.get_icon

  •     group.get_icon: {
          "description": "GET group icon",
          "function": "group_get_icon",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "size": {
              "type": "string",
              "required": false,
              "default": "medium"
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

group.get_list

  •     group.get_list: {
          "description": "GET all the groups",
          "function": "group_get_list",
          "parameters": {
            "context": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "username": {
              "type": "string",
              "required": false
            },
            "from_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

group.join_group

  •     group.join_group: {
          "description": "Join group",
          "function": "group_join_group",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

group.leave_group

  •     group.leave_group: {
          "description": "Leave group",
          "function": "group_leave_group",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

image.get_photos

  •     image.get_photos: {
          "description": "GET all the photos",
          "function": "image_get_photos",
          "parameters": {
            "context": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

image.get_post

  •     image.get_post: {
          "description": "Get image post",
          "function": "image_get_post",
          "parameters": {
            "joindate": {
              "type": "int",
              "required": true
            },
            "guid": {
              "type": "int",
              "required": true
            },
            "name": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

image.save_post

  •     image.save_post: {
          "description": "Post a image post",
          "function": "image_save_post",
          "parameters": {
            "access": {
              "type": "string",
              "required": true
            },
            "album_guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            },
            "title": {
              "type": "string",
              "required": false,
              "default": ""
            },
            "caption": {
              "type": "string",
              "required": false,
              "default": ""
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

likes.add

  •     likes.add: {
          "description": "Add a like",
          "function": "likes_add",
          "parameters": {
            "entity_guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

likes.count

  •     likes.count: {
          "description": "Count number of likes",
          "function": "likes_count_number_of_likes",
          "parameters": {
            "entity_guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

likes.delete

  •     likes.delete: {
          "description": "Delete a like",
          "function": "likes_delete",
          "parameters": {
            "entity_guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

likes.getusers

  •     likes.getusers: {
          "description": "Get users who liked an entity",
          "function": "likes_getusers",
          "parameters": {
            "entity_guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

message.send

  •     message.send: {
          "description": "Send a message",
          "function": "message_send",
          "parameters": {
            "subject": {
              "type": "string",
              "required": true
            },
            "body": {
              "type": "string",
              "required": true
            },
            "send_to": {
              "type": "string",
              "required": true
            },
            "reply": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.count

  •     messages.count: {
          "description": "Get a count of the users unread messages",
          "function": "messages_count",
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.delete

  •     messages.delete: {
          "description": "Delete a message",
          "function": "messages_delete",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.inbox

  •     messages.inbox: {
          "description": "Get messages inbox",
          "function": "messages_inbox",
          "parameters": {
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.mark_all_as_read

  •     messages.mark_all_as_read: {
          "description": "Mark all select messages as read",
          "function": "messages_mark_all_as_read",
          "parameters": {
            "guidString": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.mark_all_as_unread

  •     messages.mark_all_as_unread: {
          "description": "Mark all select messages as unread",
          "function": "messages_mark_all_as_unread",
          "parameters": {
            "guidString": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.mark_as_unread

  •     messages.mark_as_unread: {
          "description": "Unread a message",
          "function": "messages_mark_as_unread",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.multiple_delete

  •     messages.multiple_delete: {
          "description": "Multiple messages delete",
          "function": "messages_multiple_delete",
          "parameters": {
            "guidString": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.read

  •     messages.read: {
          "description": "Read a single message",
          "function": "messages_read",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

messages.sent

  •     messages.sent: {
          "description": "Get sent",
          "function": "messages_sent",
          "parameters": {
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

post.get_comments

  •     post.get_comments: {
          "description": "Get comments for a post",
          "function": "post_get_comments",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

site.getapi

  •     site.getapi: {
          "description": "Get API Key",
          "function": "site_getapi",
          "call_method": "POST",
          "require_api_auth": false,
          "require_user_auth": false
        },

site.user_can_edit

  •     site.user_can_edit: {
          "description": "Get about user if he/she ownes the object.",
    	  "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": false,
          "require_user_auth": false
        },

site.get_list_plugin

  •     site.get_list_plugin: {
          "description": "Get list site Plugin",
          "function": "site_get_list_plugin",
          "call_method": "GET",
          "require_api_auth": false,
          "require_user_auth": false
        },

site.getinfo

  •     site.getinfo: {
          "description": "Get site information",
          "function": "site_getinfo",
          "call_method": "GET",
          "require_api_auth": false,
          "require_user_auth": false
        },

site.river_friends

  •     site.river_friends: {
          "description": "Read friends latest news feed",
          "function": "site_river_friends",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            },
            "from_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

site.river_mine

  •     site.river_mine: {
          "description": "Read mine latest news feed",
          "function": "site_river_mine",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            },
            "from_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

site.river_short

  •     site.river_short: {
          "description": "Read latest news feed",
          "function": "site_river_short",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            },
            "from_guid": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

system.api.list

  •    system.api.list: {
          "description": "List all available API calls on the system.",
          "function": "list_all_apis",
          "call_method": "GET",
          "require_api_auth": false,
          "require_user_auth": false
        },

user.forgot_password

  •     user.forgot_password:{  
          "description":"Forgot\Lost Password",
          "parameters":{  
            "username":{  
              "type":"string",
              "required":true
            }
          },
          "call_method":"GET",
          "require_api_auth":true,
          "require_user_auth":false
        },

user.check_username_availability

  •     user.check_username_availability: {
          "description": "Get Username by email",
          "function": "user_check_username_availability",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": false
        },

user.friend.add

  •     user.friend.add: {
          "description": "Add a user as friend",
          "function": "user_friend_add",
          "parameters": {
            "friend": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.friend.get_friends

  •     user.friend.get_friends: {
          "description": "Register user",
          "function": "user_get_friends",
          "parameters": {
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": false,
          "require_user_auth": false
        },

user.friend.get_friends_of

  •     user.friend.get_friends_of: {
          "description": "Register user",
          "function": "user_get_friends_of",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.friend.is.friend.of

  •     user.friend.is.friend.of: {
          "description": "Check a user is friend",
          "function": "user_friend_is_friend_of",
          "parameters": {
            "friend": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.friend.remove

  •     user.friend.remove: {
          "description": "Remove friend",
          "function": "user_friend_remove",
          "parameters": {
            "friend": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.get_friends

  •     user.get_friends: {
          "description": "Register user",
          "function": "user_get_friends",
          "parameters": {
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.get_messageboard

  •     user.get_messageboard: {
          "description": "Get a users messageboard",
          "function": "user_get_messageboard",
          "parameters": {
            "limit": {
              "type": "int",
              "required": false,
              "default": 10
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.get_profile

  •     user.get_profile: {
          "description": "Get user profile information",
          "function": "user_get_profile",
          "parameters": {
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.get_profile_fields

  •     user.get_profile_fields: {
          "description": "Get user profile labels",
          "function": "user_get_profile_fields",
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.get_user_by_email

  •     user.get_user_by_email: {
          "description": "Get Username by email",
          "function": "user_get_user_by_email",
          "parameters": {
            "email": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.list_members

  •     user.list_members: {
          "description": "list members",
          "function": "user_list_members",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.post_messageboard

  •     user.post_messageboard: {
          "description": "Post a messageboard post",
          "function": "user_post_messageboard",
          "parameters": {
            "text": {
              "type": "string",
              "required": true
            },
            "to": {
              "type": "string",
              "required": false
            },
            "from": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.register

  •     user.register: {
          "description": "Register user",
          "function": "user_register",
          "parameters": {
            "name": {
              "type": "string",
              "required": true
            },
            "email": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            },
            "password": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": false
        },

user.river_short

  •     user.river_short: {
          "description": "Read latest news feed",
          "function": "user_river_short",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.save_profile

  •     user.save_profile: {
          "description": "Get user profile information with username",
          "function": "user_save_profile",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "profile": {
              "type": "array",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

user.search

  •     user.search: {
          "description": "search user",
          "function": "user_search",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            },
            "search_name": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

wire.delete_posts

  •     wire.delete_posts: {
          "description": "Delete a wire post",
          "function": "wire_delete",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            },
            "wireid": {
              "type": "int",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": false
        },

wire.get_comments

  •     wire.get_comments: {
          "description": "Get comments for a wire post",
          "function": "wire_get_comments",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 20
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

wire.get_image_comments

  •     wire.get_image_comments: {
          "description": "Get image comments for a wire post",
          "function": "wire_get_image_comments",
          "parameters": {
            "guid": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            },
            "limit": {
              "type": "int",
              "required": false,
              "default": 10
            },
            "offset": {
              "type": "int",
              "required": false,
              "default": 0
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

wire.get_posts

  •     wire.get_posts: {
          "description": "Read latest wire post",
          "function": "wire_get_posts",
          "parameters": {
            "context": {
              "type": "string",
              "required": false,
              "default": "all"
            },
            "limit": {
              "type": "int",
              "required": false
            },
            "offset": {
              "type": "int",
              "required": false
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        },

wire.post_comment

  •     wire.post_comment: {
          "description": "Post a comment on a wire post",
          "function": "wire_post_comment",
          "parameters": {
            "parent_guid": {
              "type": "int",
              "required": true
            },
            "text": {
              "type": "string",
              "required": true
            },
            "access": {
              "type": "string",
              "required": false
            },
            "wireMethod": {
              "type": "string",
              "required": false
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

wire.post_image_comment

  •     wire.post_image_comment: {
          "description": "Post a comment on a image post",
          "function": "wire_post_image_comment",
          "parameters": {
            "guid": {
              "type": "int",
              "required": true
            },
            "text": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": false
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        },

wire.save_post

  •     wire.save_post: {
          "description": "Post a wire post",
          "function": "wire_save_post",
          "parameters": {
            "text": {
              "type": "string",
              "required": true
            },
            "access": {
              "type": "string",
              "required": true
            },
            "wireMethod": {
              "type": "string",
              "required": true
            },
            "username": {
              "type": "string",
              "required": true
            }
          },
          "call_method": "POST",
          "require_api_auth": true,
          "require_user_auth": true
        }
    
    	

facebook.user_login

  •     facebook.user_login: {
          "description": "Register user using Facebook",
          "parameters": {
            "accessToken": {
              "type": "string",
              "required": true
            },
            "user_id": {
              "type": "string",
              "required": true
            },
            "profile_name": {
              "type": "string",
              "required": true
            },
            "user_email": {
              "type": "string",
              "required": true
            },
            "user_name": {
              "type": "string",
              "required": true
            }
    		},
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": false
        }
    
    	

site.notifications_count

  •     site.notifications_count: {
          "description": "Get the count of notifications",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            }
    		},
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        }
    
    	

site.get_notifications

  •    site.get_notifications: {
          "description": "Get the list of notifications",
          "parameters": {
            "username": {
              "type": "string",
              "required": true
            }
    		},
          "call_method": "GET",
          "require_api_auth": true,
          "require_user_auth": true
        }
    
    	

Copyright 2016 | Campus Karma