Moosocial REST API

What is REST API?Simply, REST API is the set of functions to which the developers can perform requests and receive responses. The interaction is performed via the HTTP/HTTPS protocol. An advantage of such an approach is the wide usage of HTTP/HTTPS that’s why REST API can be used practically for any programming language.

Base URL

All requests to this REST API should have the base URL: [https://example.com/api]

HTTP Verbs

In REST API, there are four verbs that are used to manage resources: GET ,POST, PUT, and DELETE. You can get the contents of a data using GET, delete the data using DELETE, and create or update the data using POST/PUT.

Authentication

Access Token Request - Allows a application to exchange the OAuth Request Token for an OAuth Access Token.

Authenticate

Authenticate
POST/auth/token

Endpoint : /api/auth/token.json

It is based on the Resource Owner Password Credentials   flow of the   OAuth 2 specification

Permission

It is not requires permission .

Request
HideShow
Parameter Required Type Example Description
grant_type yes string Value MUST be set to "password" or "refresh_token"
username yes string if grant_type is "password". NOT NEED if grant_type is "refresh_token" The resource owner email.
password yes string if grant_type is "password". NOT NEED if grant_type is "refresh_token" The resource owner email.
refresh_token yes if grant_type is "password". NOT NEED if grant_type is "refresh_token" The resource owner email.
scope OPTIONAL string The scope of the access request as described by Section 3.3.
Response  200
HideShow
Parameter Type Example Description
access_token string The access token issued by the authorization server.
token_type string The type of the token
expires_in number The lifetime in seconds of the access token
refresh_token string The refresh token, which can be used to obtain new access tokens using the same authorization grant
scope string
Response  400
HideShow
{
                        "name": "please enter a valid email",
                        "message": "please enter a valid email",
                        "url": "http://addons.moosocial.com/api/auth/token"
                      }
Response  401
HideShow
{
                        "name": "password is not correct",
                        "message": "password is not correct",
                        "url": "http://addons.moosocial.com/api/auth/token"
                      }
Response  404
HideShow
{
                        "name": "username or password is invalid",
                        "message": "username or password is invalid",
                        "url": "http://addons.moosocial.com/api/auth/token"
                      }

How to grant user access permision

To grant user access token permission , we use access_token generate from here

Here some example to use call api with access_token by GET , POST method .

GET Resquest
GET

Call moosocial api using GET RESQUEST

Assume your token is e7564451559131517ca2c1c70ac176633f19d5da

Example 1
HideShow

- To get your website's all created blog-posts: Send a GET request to:

http://addons.moosocial.com/api/blog/all?access_token=e7564451559131517ca2c1c70ac176633f19d5da

Response  200

An array of blog object

Example 2
HideShow

- To get home feed that current user can view . Send a GET request to:

http://addons.moosocial.com/api/activity/home?filter=everyone&page=1&access_token=e7564451559131517ca2c1c70ac176633f19d5da

Response  200

An array of Activity objects.

POST Resquest
POST

Call moosocial api using POST RESQUEST

Assume your token is e7564451559131517ca2c1c70ac176633f19d5da

Example
HideShow

- Like a bog : Send a POST request to:

http://addons.moosocial.com/api/Blog_Blog/like

Parameter Type Example Description
access_token string e7564451559131517ca2c1c70ac176633f19d5da User access token
id int 1 Blog id
Response  200
Parameter Type Example Description
success boolean Return TRUE when success

Post request with Access Token in Header
POST

Call moosocial api using POST RESQUEST and add access_token in HEADER

We use moo-access-token variable to define access token at header.

Assume your token is e7564451559131517ca2c1c70ac176633f19d5da

Example
HideShow

- Like a bog : Send a POST request with access token send by header

http://addons.moosocial.com/api/Blog_Blog/like

Request Headers

Content-Type: application/json

Host: http://addons.moosocial.com

moo-access-token: e7564451559131517ca2c1c70ac176633f19d5da

Parameter Type Example Description
id Blog id 1
Response  200
Parameter Type Example Description
success boolean Return TRUE when success

Activity Feeds

APIs allow to mooSocial members to manage there feed and get paginated list of feeds, post new feed, share on feed and manage feed etc.

Example Activity

Default Activities

Base Moosocial Activity Feed

This is default of api activity feed .

hideLikeAndComment : TRUE show that this activity does not allow to LIKE or leave COMMENT

share : TRUE mean this feed can be shared.

titleHtml : Feed title with HTML format .

contentHtml : Text content of current activity with HTML format .

tagUser : List of all friends has been tagged in this activity .

isViewerDisliked,isViewerLiked : TRUE mean this activity feed has been already liked/disliked by current viewer .

isHideDislike: TRUE mean dislike function has been disabled by admin .

A JSON serialized activity
HideShow

                                        {
                                            "id" :  "post_id"
                                            "published"  :  "2016-07-31 16:16:22"
                                            "modified"  :  "2016-07-31 16:16:22"
                                            "modifiedTranslated"  :  "on December 27 at 05:57 PM"
                                            "publishedTranslated"  :  "on December 27 at 05:57 PM"
                                            "hideLikeAndComment"  :  "false"
											"share" :  "false"
											"privacy" :  "1"
                                            "commentCount"  :  "0"
											"likeCount" :  "1"
                                            "dislikeCount"  :  "0"
											"actor"  :  {
												"url": "http://addons.moosocial.com/users/view/1",
												"type": "User",
												"id": "user_id",
												"image": {
														  "600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
														  "50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
														  "100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
														  "200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
														  "type": "Link"
														  "mediaType": "image/jpeg"
												}
												"name": "User A",
											}
											"name" :  "User A joined mooSocial Plugins - php Social Network Software"
                                            "type"  :  "join"
											"object"  :  {
												"url": http://addons.moosocial.com/users/view/1,
												"type": "User",
												"id": "user_id",
											}
											"target"  :  {}
											"isViewerDisliked"  :  false
											"isViewerLiked"  :  false
											"isHideDislike"  :  false
                                        }
                                        
Example Activities

User A joined mooSocial Plugins - php Social Network Software

A JSON serialized activity
HideShow

                                        {
                                           
					"title" :  "User A joined mooSocial Plugins - php Social Network Software"
					"titleHtml" :  "User A joined mooSocial Plugins - php Social Network Software"
                                            "type"  :  "join"
											"object"  :  {
												"url": http://addons.moosocial.com/users/view/1,
												"type": "User",
												"id": "user_id",
											}
											"target"  :  {}
                                        }
                                        

User A changed profile picture

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A changed profile picture"
                                            "titleHtml" :  "User A changed profile picture"
                                            "type"  :  "update"
											"object"  :  {
												"url": http://addons.moosocial.com/users/view/1,
												"type": "User",
												"id": "user_id",
											}
											"target"  :  {}
                                        }
                                        

User A post a text

A JSON serialized activity
HideShow

                                        {
                                            "type"  :  "post"
											"object"  :  {
												"url": http://addons.moosocial.com/users/view/1,
												"type": "Activity",
												"id": "activity_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/api/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
															  "url": "http://addons.moosocial.com/api/users/view/user_id",
															  "width": "250"
															  "height": "250"
															}
														 "name": "User B"
												}
											}
											"target"  :  {}
                                        }
                                        

User A post a link

A JSON serialized activity
HideShow

                                        {
                                            "type"  :  "post"
											"object"  :  {
												"url": http://addons.moosocial.com/users/view/user_id,
												"type": "Activity_Link",
												"name": "link title",
												"description": "link description",
												"image": "link image",
												"link_url": "link url",
												"id": "activity_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/api/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {}
                                        }
                                        

User A > User B
User A post on User B's profile

A JSON serialized activity
HideShow

                                        {
                                            
					"title" :  "User A > User B"
					"titleHtml" :  "User A > User B "
                                            "type"  :  "post"
											"object"  :  {
												"url": http://addons.moosocial.com/users/view/user_id,
												"type": "Activity_Post_User",
												"id": "activity_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User"
												"id": "user_id"
												"name": "User B"
											}
                                        }
                                        

User A share User B's post

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A share User B's post"
                                            "titleHtml" :  "User A share User B's post"
                                            "type"  :  "share"
											"object"  :  {
												"url": http://addons.moosocial.com/users/view/user_id,
												"type": "Activity",
												"id": "activity_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User"
												"id": "user_id"
												"name": "User B"
											}
                                        }
                                        

User A is now friend with User B and 2 others

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A is now friend with User B and 2 others "
					"titleHtml" :  "User A is now friend with User B and 2 others "
                                            "type"  :  "add"
											"object"  :  {
												"type": "User",
												"friend": [
													{
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"type": "Link"
																"mediaType": "image/jpeg"
															}
														 "name": "User B"
														 "userFriendCount": "1 friend"
														 "userPhotoCount": "1 photo"
														 "userStatus": "Remove"
													},
													{
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"type": "Link"
																"mediaType": "image/jpeg"
															}
														 "name": "User C"
														 "userFriendCount": "1 friend"
														 "userPhotoCount": "1 photo"
														 "userStatus": "Remove"
													},
													{
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"type": "Link"
																"mediaType": "image/jpeg"
															}
														 "name": "User D"
														 "userFriendCount": "10 friend"
														 "userPhotoCount": "1 photo"
														 "userStatus": "Remove"
													}
												]
											}
											"target"  :  {}
                                        }
                                        

User A post photo on feed

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A post photo on feed"
					"titleHtml" :  "User A post photo on feed"
                                            "type"  :  "post"
											"object"  :  {
												"type": "Album",
												"id": "activity_id",
												"url": "http://addons.moosocial.com/users/view/user_id/activity_id:activity_id",
												"content": "This is text of feed",
												"imageCount": "3",
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"2": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"3": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/albums/view/album_id/album_name",
												"type": "Album",
												"id": "album_id",
											}
                                        }
                                        

User A added 2 news photo to album Album Name

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A added 2 news photo to album Album Name"
					"titleHtml" :  "User A added 2 news photo to album Album Name"
                                            "type"  :  "add"
											"object"  :  {
												"type": "Album",
												"id": "activity_id",
												"url": "http://addons.moosocial.com/users/view/user_id/activity_id:activity_id",
												"imageCount": "3",
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"2": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"3": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/albums/view/album_id/album_name",
												"type": "Album",
												"id": "album_id",
												"name": "Album Name",
											}
                                        }
                                        

User A > Group Name
( post photo in group )

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A > Group Name"
					"titleHtml" :  "User A > Group Name "
                                            "type"  :  "post"
											"object"  :  {
												"type": "Album",
												"id": "activity_id",
												"url": "http://addons.moosocial.com/users/view/user_id/activity_id:activity_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												"imageCount": "3",
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"2": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"3": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/groups/view/group_id/group-name",
												"type": "Group",
												"id": "group_id",
												"name": "Group Name",
											}
                                        }
                                        

User A > Event Name
( post photo in event )

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A > Event Name"
                                            "titleHtml" :  "User A > Event Name "
                                            "type"  :  "post"
											"object"  :  {
												"type": "Album",
												"id": "activity_id",
												"url": "http://addons.moosocial.com/users/view/user_id/activity_id:activity_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												"imageCount": "3",
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"2": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"3": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/events/view/event_id/event-name",
												"type": "Event",
												"id": "event_id",
												"name": "Event Name",
											}
                                        }
                                        

User A shared User B's photo

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A shared User B's photo"
                                            "titleHtml" :  "User A shared User B's photo "
                                            "type"  :  "share"
											"object"  :  {
												"type": "Photo",
												"id": "activity_id",
												"url": "http://addons.moosocial.com/users/view/user_id/activity_id:activity_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A shared User B's album

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A shared User B's album"
                                            "titleHtml" :  "User A shared User B's album "
                                            "type"  :  "share"
											"object"  :  {
												"type": "Album",
												"id": "album_id",
												"url": "http://addons.moosocial.com/albums/view/album_id/album-name",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												"imageCount": "3",
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"2": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
													"3": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A was tagged in a photo

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A was tagged in a photo"
                                            "titleHtml" :  "User A was tagged in a photo"
                                            "type"  :  "post"
											"object"  :  {
												"type": "Photo_Tag",
												"id": "activity_id",
												"url": "http://addons.moosocial.com/users/view/user_id/activty_id:activity_id/",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												"imageCount": "1",
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {}
                                        }
                                        

User A commented on User B photo

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A commented on User B photo"
                                            "titleHtml" :  "User A commented on User B photo"
                                            "type"  :  "post"
											"object"  :  {
												"type": "Photo_Comment",
												"id": "activity_id",
												"url": "http://addons.moosocial.com/users/view/user_id/activty_id:activity_id/",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												"imageCount": "1",
												"imageArray": "{
													"1": "http://addons.moosocial.com/uploads/photos/thumbnail/2016/folder/album_id/prefix_name.png",
												}",
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A created a new event

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A created a new event"
                                            "titleHtml" :  "User A created a new event"
                                            "type"  :  "create"
											"object"  :  {
												"type": "Event",
												"id": "event_id",
												"url": "http://addons.moosocial.com/events/view/event_id/event-name",
												
											}
											"target"  :  {}
                                        }
                                        

User A shared User B's event

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A shared User B's event"
                                            "titleHtml" :  " User A shared User B's event"
                                            "type"  :  "share"
											"object"  :  {
												"type": "Event",
												"id": "event_id",
												"url": "http://addons.moosocial.com/events/view/event_id/event-name",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A is attending Event 1 , Event 2 and 2 others

A JSON serialized activity
HideShow

                                        {
											"title" :  "User A is attending Event 1 , Event 2 and 2 others"
											"titleHtml" :  "User A is attending Event 1 ,  Event 2 and 2 others "
                                            "type"  :  "attend"
											"object"  :  {
												"type": "Event",
												"event":  [
													{
														  "url": "http://addons.moosocial.com/events/view/event_id/event-name",
														  "name": "Event Name"
														  "id": "event_id" 
													},
													{
														  "url": "http://addons.moosocial.com/events/view/event_id/event-name",
														  "name": "Event Name"
														  "id": "event_id" 
													}
												],
											},
											"target"  :  {}
                                        }
                                        

User A shared a new video

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A shared a new video"
					"titleHtml" :  "User A  shared a new video"
                                            "type"  :  "create"
											"object"  :  {
												"type": "Video",
												"id": "video_id",
												"url": "http://addons.moosocial.com/videos/view/video_id/video-name",
												
											}
											"target"  :  {}
                                        }
                                        

User A shared User B's video

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A shared User B's video"
                                            "titleHtml" :  "User A shared User B's video "
                                            "type"  :  "share"
											"object"  :  {
												"type": "Video",
												"id": "video_id",
												"url": "http://addons.moosocial.com/videos/view/video_id",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A > Group Name
( post video in group )

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A > Group Name"
					"titleHtml" :  "User A > Group Name"
                                            "type"  :  "create"
											"object"  :  {
												"type": "Video",
												"id": "video_id",
												"url": "http://addons.moosocial.com/groups/view/group_id/video_id:video_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/groups/view/group_id/group-name",
												"type": "Group",
												"id": "group_id",
												"name": "Group Name",
											}
                                        }
                                        

User A created a new topic

A JSON serialized activity
HideShow

                                        {
                                           "title" :  "User A created a new topic"
                                           "titleHtml" :  "User A created a new topic"
                                            "type"  :  "create"
											"object"  :  {
												"type": "Topic",
												"id": "topic_id",
												"url": "http://addons.moosocial.com/topics/view/topic_id/topic-name",
												
											}
											"target"  :  {}
                                        }
                                        

User A shared User B's topic

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A shared User B's topic"
					"titleHtml" :  "User A shared User B's topic "
                                            "type"  :  "share"
											"object"  :  {
												"type": "Topic",
												"id": "topic_id",
												"url": "http://addons.moosocial.com/topics/view/topic_id",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A > Group Name
( post topic in group )

A JSON serialized activity
HideShow

                                        {
					"title" :  "User A > Group Name"
					"titleHtml" :  "User A > Group Name"
                                            "type"  :  "create"
											"object"  :  {
												"type": "Topic",
												"id": "topic_id",
												"url": "http://addons.moosocial.com/groups/view/group_id/topic_id:topic_id",
												"content": "This is text of feed",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
												
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/groups/view/group_id/group-name",
												"type": "Group",
												"id": "group_id",
												"name": "Group Name",
											}
                                        }
                                        

User A created a new blog entry

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A created a new blog entry"
                                            "titleHtml" :  "User A created a new blog entry"
                                            "type"  :  "create"
											"object"  :  {
												"type": "Blog",
												"id": "blog_id",
												"url": "http://addons.moosocial.com/blogs/view/blog_id/blog-name",
												
											}
											"target"  :  {}
                                        }
                                        

User A shared User B's blog

A JSON serialized activity
HideShow

                                        {
                                        "title" :  "User A shared User B's blog"
                                        "titleHtml" :  "User A shared User B's blog"
                                        "type"  :  "share"
											"object"  :  {
												"type": "Blog",
												"id": "blog_id",
												"url": "http://addons.moosocial.com/blogs/view/blog_id",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A created a new group

A JSON serialized activity
HideShow

                                        { 
					"title" :  "User A created a new group"
					"titleHtml" :  "User A created a new group"
                                            "type"  :  "create"
											"object"  :  {
												"type": "Group",
												"id": "group_id",
												"url": "http://addons.moosocial.com/groups/view/group_id/group-name",
												
											}
											"target"  :  {}
                                        }
                                        

User A shared User B's group

A JSON serialized activity
HideShow

                                        {
                                        "title" :  "User A shared User B's group"
                                        "titleHtml" :  "User A shared User B's group"
                                            "type"  :  "share"
											"object"  :  {
												"type": "Group",
												"id": "group_id",
												"url": "http://addons.moosocial.com/groups/view/group_id",
												"tagUser": {
														  "url": "http://addons.moosocial.com/users/view/user_id",
														  "type": "User"
														  "id": "user_id"
														  "image": {
																"600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
																"100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
																"200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
															}
														 "name": "User B"
												}
											}
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User B",
											}
                                        }
                                        

User A joined group Group Name and 2 others

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A joined group Group Name and 2 others"
                                            "titleHtml" :  "User A joined group Group Name and 2 others "
                                            "type"  :  "join"
											"object"  :  {
												"type": "Group",
												"event":  [
													{
														  "url": "http://addons.moosocial.com/groups/view/group_id/group-name",
														  "name": "Group Name"
														  "id": "group_id" 
													},
													{
														  "url": "http://addons.moosocial.com/groups/view/group_id/group-name",
														  "name": "Group Name"
														  "id": "group_id" 
													}
												],
											},
											"target"  :  {}
                                        }
                                        

User A shared User B's object > User C
(Share Friend wall)

Object can be Blog | Topic | Video | Group | Event | Photo | Album

A JSON serialized activity
HideShow

                                        {
                                            "title" :  "User A shared User B's object > User C "
                                            "titleHtml" :  " User A shared User B's object > User C "
                                            "type"  :  "share_user"
											"object"  :  {
												"type": "Object type",
												"url": "http://addons.moosocial.com/objects/view/object_id",
												"id": "object_id",
												"user_id": "User Id",
												"user_name": "User B",
											},
											"target"  :  {
												"url": "http://addons.moosocial.com/users/view/user_id",
												"type": "User",
												"id": "user_id",
												"name": "User C",
											}
                                        }
                                        

Get Single Activity Feed

Get Single Activity Feeds
GET/activity/{activity_id}

An individual entry in a profile's feed or plugins activities . The profile could be a user, event or group.

Permission

It's required a user access token. How to use

Request
HideShow
Response  200
HideShow
Parameter Type Example Description
id int The post ID
published datetime The time the post was initially published.
publishedTranslated string The time the post was initially published with text translation
privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
commentCount int Total comment count
likeCount int Total like count.
dislikeCount int Total dislike count.
actor object The author of this post.
{
                                        url: http://addons.moosocial.com/api/users/view/user_id,
                                        type: person,
                                        id: user_id,
                                        image: {
                                          600: "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                          50_square: "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
                                          100_square: "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                          200_square: "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
                                          type: "Link"
                                          mediaType: "image/jpeg"
                                        }
                                        "name": User Name,
                                      }
title string Title of this post
titleHtml string Title of this post with HTML format
type string Action of this post
object object The author of this post.
{
                        type: Type of this post,
                        id: id object can be group_id , activity_id , userArray , ... base on type ,
                        url: url of this object post,
                        }
target object Describes the target of the activity. The precise meaning of the activity's target is dependent on the activities type.
Response  400
HideShow
{
               "name": "You can not view this activity.",
               "message": "You can not view this activity.",
               "url": "http://addons.moosocial.com/api/activity/119"
               }
Response  404
HideShow
{
               "name": "This activity feed not exist.",
               "message": "This activity feed not exist.",
               "url": "http://addons.moosocial.com/api/activity/1122"
               }

Get Users were tagged in invidual feed

Get Users were tagged in invidual feed
GET/activity/tag/{tag_id}

Return list of users were tagged in individual feed.

Permission

It's required a user access token. How to use

Field
HideShow
Parameter Type Example Description
tag_id int Tag id
Response  200
HideShow
An array of user information.
Parameter Type Example Description
id int User id
name string User name
avatar object The list of person's image path of this person's avatar .
profile_url link Link to profile of user
Response  404
HideShow
{
               "name": "This tag feed not exist.",
               "message": "This tag feed not exist.",
               "url": "http://addons.moosocial.com/api/activity/tag/1234"
               }

Post New Feed

Post a new feed

New feed
POST/activity

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
type string default : User , in array of (User,Group_Group,Event_Event).
Define which type of feed is posted , User can post feed at home , user profile , in a group or event
target_id int default : 0 , in array of (userid , groupid , eventid)
message string Hi @[25:David J. Thouless] #1234 The main body of the post, otherwise called the status message. Either link, place, or message must be supplied.
messageText string Hi David J. Thouless #1234 The text of status
userTagging string 63,25,33 Comma-separated list of user IDs of people tagged in this post
privacy int Determines the privacy settings of the post
wallphoto arrat[string] An array of Photo path which is uploaded by using the api :/file
Response  200
HideShow
{
                        "message": "success",
                        "id": "activity_id",
                        }
Response  401
HideShow
{
                        "name": "Missing parameter : Share feed can not be empty",
                        "message": "Missing parameter : Share feed can not be empty",
                        "url": "http://addons.moosocial.com/api/activity/post"
                      }

Post a comment on a feed

Post a comment on a feed

Post comment on feed
POST/activity/{activity_id}/comment

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
activity_id int Activity Id
text string Content of comment
photo string is the path which is uploaded by using the api : /file
Response  200
HideShow
{
                        "message": success,
                        "id": "comment_id",
                        }

Edit comment on feed

Edit comment on feed

Edit comment on feed
POST/activity/comment/edit

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
activity_id int Activity Id
comment_id int Comment Id
text string Content of comment
photo string is the path which is uploaded by using the api : /file
Response  200
HideShow
{
                        "message": success,
                        }
Response  400
HideShow
{
                                                            "name": Comment can not be empty.,
                                                            "message": Comment can not be empty.,
                                                            "url": "http://addons.moosocial.com/api/activity/comment/edit"
                                                          }

Edit comment on feed
PUT/activity/{activity_id}/comment/{comment_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
activity_id int Activity Id
comment_id int Comment Id
text string Content of comment
photo string is the path which is uploaded by using the api : /file
Response  200
HideShow
{
                        "message": success,
                        }
Response  400
HideShow
{
                                                            "name": Comment can not be empty.,
                                                            "message": Comment can not be empty.,
                                                            "url": "http://addons.moosocial.com/api/activity/10/comment/20"
                                                          }

Delete Activity feed

Delete an activity feed.

Delete Activity feed
POST/activity/delete/{id}

Permission

It's required a user access token. How to use

Response  200
HideShow
{
                        "success": true,
                        }
Response  404
HideShow
{
                        "name": "This activity feed not exist",
                        "message": "This activity feed not exist",
                        "url": "http://addons.moosocial.com/api/activity/1122"
                      }

Delete Activity feed
DELETE/activity/{activity_id}

Permission

It's required a user access token. How to use

Response  200
HideShow
{
                        "success": true,
                        }
Response  404
HideShow
{
                        "name": "This activity feed not exist",
                        "message": "This activity feed not exist",
                        "url": "http://addons.moosocial.com/api/activity/1122"
                      }

Delete comment on a feed .

Delete comment on a feed .

Delete comment on a feed.
POST/activity/{activity_id}/comment/delete

Permission

It's required a user access token. How to use

Fields  
HideShow
Parameter Type Example Description
activity_id int Activity Id
comment_id int Comment Id
Response  200
HideShow
{
                        "success": true,
                        }
Response  400
HideShow
{
                        "name": Something wrong with your data , please check again.,
                        "message": Something wrong with your data , please check again.,
                        "url": "http://addons.moosocial.com/api/activity/1/comment/delete"
                      }

Delete comment on a feed.
DELETE/activity/{activity_id}/comment

Permission

It's required a user access token. How to use

Fields  
HideShow
Parameter Type Example Description
activity_id int Activity Id
comment_id int Comment Id
Response  200
HideShow
{
                        "success": true,
                        }
Response  400
HideShow
{
                        "name": Something wrong with your data , please check again.,
                        "message": Something wrong with your data , please check again.,
                        "url": "http://addons.moosocial.com/api/activity/1/comment"
                      }

Get Home Feed

The posts that a person sees in their mooSoical News Feed.

Get User Activity Feed
GET/activity/home

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
filter string OPTIONAL.It mus be "everyone" or "friends"
page int default value is 1
Response  200
HideShow

An array of Activity objects.

File

All action related to upload file

Upload photo for new feed

Upload photo for new feed
POST/file

Upload photo for a new feed

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
qqfile image/jpeg
Response  200
HideShow
{
                        "success": true,
                        "filename": 0fdc7992b900f41ab1b7641a48604bed.jpg,
                        "photo": uploads/tmp/0fdc7992b900f41ab1b7641a48604bed.jpg
                        "file_path": http://addons.moosocial.com/uploads/tmp/0fdc7992b900f41ab1b7641a48604bed.jpg
                      }
Response  400
HideShow
{
                        "name": Message,
                        "message": Message,
                        "url": "http://addons.moosocial.com/api/activity/photo"
                      }

Messages can be :

# Server error. Upload directory isn't writable.

# No files were uploaded.

# File is empty

# File is too large

# File has an invalid extension.

# Could not save uploaded file.The upload was cancelled, or server error encountered

Upload photo for album

Upload photo for album
POST/file/album

Upload photo for album

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
qqfile image/jpeg
Response  200
HideShow
{
                        "success": true,
                        "filename": 0fdc7992b900f41ab1b7641a48604bed.jpg,
                        "photo": uploads/tmp/0fdc7992b900f41ab1b7641a48604bed.jpg
                        "file_path": http://addons.moosocial.com/uploads/tmp/0fdc7992b900f41ab1b7641a48604bed.jpg
                      }
Response  400
HideShow
{
                        "name": Message,
                        "message": Message,
                        "url": "http://addons.moosocial.com/api/file/album"
                      }

Messages can be :

# Server error. Upload directory isn't writable.

# No files were uploaded.

# File is empty

# File is too large

# File has an invalid extension.

# Could not save uploaded file.The upload was cancelled, or server error encountered

Friends

Get Friend lists

Get list of your friend .

Get list of your friend .
GET/friend/list

Permission

It's required a user access token. How to use

Response  200
HideShow
Parameter Type Example Description
totalFriendCount int Total friend count
friend object An array of user friend

                                        {
                                            url    :  http://addons.moosocial.com/users/view/1
                                            type    :  User
                                            id    :  1
                                            name    :  Admin
                                            photoCount    :  10
                                            friendCount    :  5
                                            image    :  
                                                                                        "600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
                                                                                        
                                        }
                                        
Response  404
HideShow
{
                        "name": "No friend found.",
                        "message": "No friend found.",
                        "url": "http://addons.moosocial.com/api/friend/list"
                      }

Get Friend's requested lists

Get list of your friend's requested

Get list of your friend's requested
GET/friend/requests

Permission

It's required a user access token. How to use

Response  200
HideShow
Parameter Type Example Description
totalFriendCount int Total friend count
friend object An array of user friend

                                        {
                                            url    :  http://addons.moosocial.com/users/view/1
                                            type    :  User
                                            id    :  1
                                            name    :  Admin
                                            photoCount    :  10
                                            friendCount    :  5
                                            image    :  
                                                                                        "600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
                                                                                        
                                        }
                                        
Response  404
HideShow
{
                        "name": "No friend found.",
                        "message": "No friend found.",
                        "url": "http://addons.moosocial.com/api/friend/requests"
                      }

Get User friend lists

Get the user’s friends.

Get the user’s friends.
GET/friend/{user_id}/list

Permission

It's required a user access token. How to use

Response  200
HideShow
Parameter Type Example Description
totalFriendCount int Total friend count
friend object An array of user friend

                                        {
                                            url    :  http://addons.moosocial.com/users/view/1
                                            type    :  User
                                            id    :  1
                                            name    :  Admin
                                            photoCount    :  10
                                            friendCount    :  5
                                            image    :  
                                                                                        "600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                                                                        "200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
                                                                                        
                                        }
                                        
Response  401
HideShow
{
                        "name": "User does not have access to this resource.",
                        "message": "User does not have access to this resource.",
                        "url": "http://addons.moosocial.com/api/friend/3/list"
                      }
Response  404
HideShow
{
                        "name": "User does not exist.",
                        "message": "User does not exist.",
                        "url": "http://addons.moosocial.com/api/friend/2/list"
                      }

Add friend

Send friend request to a user.

Send friend request to a user.
POST/friend/add

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
user_id int User id to whom sent the friend request by logged-in user.
message string Message sent to user whom you sent request .
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Friend already .",
                        "message": "Friend already .",
                        "url": "http://addons.moosocial.com/api/friend/add"
                      }
Response  404
HideShow
{
                        "name": "User does not exist.",
                        "message": "User does not exist.",
                        "url": "http://addons.moosocial.com/api/friend/add"
                      }
Response  405
HideShow
{
                        "name": "You have already sent a friend request to this user",
                        "message": "You have already sent a friend request to this user",
                        "url": "http://addons.moosocial.com/api/friend/add"
                      }

Accept friend request

Accept friend request

Accept friend request
POST/friend/accept

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id int Friend request id .
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow
{
                        "name": "Friend request not found.",
                        "message": "Friend request not found.",
                        "url": "http://addons.moosocial.com/api/friend/accept"
                      }

Reject friend request

Reject friend request

Reject friend request
POST/friend/reject

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id int Friend request id .
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow
{
                         "name": "Friend request not found.",
                        "message": "Friend request not found.",
                        "url": "http://addons.moosocial.com/api/friend/reject"
                      }

Cancel friend request

Cancel the friend request sent to a user.

POST/friend/cancel

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
user_id int User id to whom sent the friend request by logged-in user.
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow
{
                         "name": "Friend request not found.",
                        "message": "Friend request not found.",
                        "url": "http://addons.moosocial.com/api/friend/cancel"
                      }

Delete friendship

Remove friendship with a user .

POST/friend/delete

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
user_id int user id of the friend to remove as friend by logged-in user.
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "You are not a friend of this user",
                        "message": "You are not a friend of this user",
                        "url": "http://addons.moosocial.com/api/friend/delete"
                      }

Likes and Dislikes

Likes and dislikes object to make action on moosocial site .

Get user liked list

Get user liked list
GET{objectType}/like/{id}

Get array of user who already liked this item

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/like Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
count int Total user liked this item
user object An array of user already liked

                                        {
                                            url    :  http://addons.moosocial.com/users/view/1
                                            type    :  User
                                            id    :  1
                                            name    :  Admin
                                            photoCount    :  10
                                            friendCount    :  5
                                        }
                                        
Response  404
HideShow
{
                        "name": "Nobody liked this item",
                        "message": "Nobody liked this item",
                        "url": "http://addons.moosocial.com/api/activity/like/10"
                      }

Get user disliked list

Get user disliked list
GET{objectType}/dislike/{id}

Get array of user who already disliked this item

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/dislike Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
count int Total user disliked this item
user object An array of user already disliked

                                        {
                                            url    :  http://addons.moosocial.com/users/view/1
                                            type    :  User
                                            id    :  1
                                            name    :  Admin
                                            photoCount    :  10
                                            friendCount    :  5
                                        }
                                        
Response  404
HideShow
{
                        "name": "Nobody dislike this item",
                        "message": "Nobody dislike this item",
                        "url": "http://addons.moosocial.com/api/activity/dislike/10"
                      }

Like an item

Like an item
POST{objectType}/like

Like an activity feed , comment , blog , topic ,....

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/like Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Item already liked",
                        "message": "Item already liked",
                        "url": "http://addons.moosocial.com/api/activity/like"
                      }
Response  404
HideShow
{
                        "name": "items not exist.",
                        "message": "items not exist.",
                        "url": "http://addons.moosocial.com/api/activity/like"
                      }

Dislike an item

Dislike an item
DELETE{objectType}/dislike

Dislike an activity feed , comment , blog , topic ,....

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/dislike Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Item already dislike",
                        "message": "Item already dislike",
                        "url": "http://addons.moosocial.com/api/activity/dislike"
                      }
Response  404
HideShow
{
                        "name": "items not exist.",
                        "message": "items not exist.",
                        "url": "http://addons.moosocial.com/api/activity/dislike"
                      }

Remove like an item

Remove like an item
POST{objectType}/like/delete

Unlike an activity feed , comment , blog , topic ,....

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/like/delete Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Item not liked yet",
                        "message": "Item not liked yet",
                        "url": "http://addons.moosocial.com/api/activity/like/delete"
                      }
Response  404
HideShow
{
                        "name": "items not exist.",
                        "message": "items not exist.",
                        "url": "http://addons.moosocial.com/api/activity/like/delete"
                      }

Remove like an item
DELETE{objectType}/like

Remove like an activity feed , comment , blog , topic ,....

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/like Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Item not liked yet",
                        "message": "Item not liked yet",
                        "url": "http://addons.moosocial.com/api/activity/like"
                      }
Response  404
HideShow
{
                        "name": "items not exist.",
                        "message": "items not exist.",
                        "url": "http://addons.moosocial.com/api/activity/like"
                      }

Remove dislike an item

Remove dislike an item
POST{objectType}/dislike/delete

Remove dislike an activity feed , comment , blog , topic ,....

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/dislike/delete Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Item not disliked yet",
                        "message": "Item not disliked yet",
                        "url": "http://addons.moosocial.com/api/activity/dislike/delete"
                      }
Response  404
HideShow
{
                        "name": "items not exist.",
                        "message": "items not exist.",
                        "url": "http://addons.moosocial.com/api/activity/dislike/delete"
                      }

Remove dislike an item
DELETE{objectType}/dislike

Remove dislike an activity feed , comment , blog , topic ,....

Permission

It's required a user access token. How to use

Request
HideShow
Parameter Type Example Description
objectType string /activity/dislike Object type can be (activity | core_activity_comment | comment | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic | .... )
id int Object id (activity_id , comment_id , photo_id .....)
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Item not disliked yet",
                        "message": "Item not disliked yet",
                        "url": "http://addons.moosocial.com/api/activity/dislike"
                      }
Response  404
HideShow
{
                        "name": "items not exist.",
                        "message": "items not exist.",
                        "url": "http://addons.moosocial.com/api/activity/dislike"
                      }

Comment

All action related to comment plugin

View comment from item

Get comment from an item like feed , topic , blog, video, photo...

Get comment from item
GET{objectType}/comment/{item_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
objectType string Object Type can be ( conversation | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic)
item_id int item id ( comment_id , photo_id .....)
Response  200
HideShow
An array of comment

                        {
                            id :  100
                            userId :  2
                            userName :  Admin
                            userNameHtml :  Admin
                            image    :   {
                                "600": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                "50_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                "100_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg",
                                "200_square": "http://addons.moosocial.com/uploads/users/avatar/user_id/prefix_name.jpg"
                                }
                            
                            edited :  false
                            message :  comment to album 
                            likeCount :  0	
                            dislikeCount :  0
                            published :  2016-08-31 04:12:08	
                            publishedTranslated :  2016-08-31 04:12:08	
                            thumbnails :   {
                                "200_square": "http://addons.moosocial.com/uploads/comments/thumbnail/image.jpg",
                                "default": "http://addons.moosocial.com/uploads/comments/thumbnail/image.jpg",
                                }
                            
                            isLoadmore :  false
                            isGiftImage :  false
                        }
                     
Response  400
HideShow

                        {
                            name :  This photo not allow to comment
                            message :  This photo not allow to comment
                            url :  http://addons.moosocial.com/Photo_Photo/comment/120
                        }
                     
Response  404
HideShow

                        {
                            name :  Comment not found.
                            message :  Comment not found.
                            url :  http://addons.moosocial.com/Photo_Photo/comment/120
                        }
                     

Get list of edited comment

Get list of edited comment.

Get list of edited comment.
GET{objectType}/comment/{item_id}/edited/{comment_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
objectType string Object Type can be ( activity | conversation | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic)
item_id int item id ( activity_id , comment_id , photo_id .....)
comment_id int Comment id .
Response  200
HideShow
Parameter Type Example Description
editCount int Total edited count
editObject objectType An array of comment

                        {
                            id :  100
                            userId :  2
                            userName :  Admin
                           content :  This is an edited comment
                            created :  2016-08-31 04:12:08	
							status :  Added photo attachment.
                        }
                     
Response  400
HideShow

                        {
                            name :  This photo not allow to comment
                            message :  This photo not allow to comment
                            url :  http://addons.moosocial.com/Photo_Photo/comment/116/edited/51
                        }
                     

Share new comment

Share new comment

Post new comment
POST{objectType}/comment

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
objectType string Object Type can be ( conversation | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic)
id int item id ( comment_id , photo_id .....)
text string The text content of comment
photo file is the path which is uploaded by using the api : /file
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow

                        {
                            name :  "Comment can not be empty"
                            message :  "Comment can not be empty"
                            url :  http://addons.moosocial.com/blog/comment
                        }
                     

                        {
                            errorCode :  "not_group_member"
                            name :  "This photo is in a group . Only group members can leave comment"
                            message :  "This photo is in a group . Only group members can leave comment"
                            url :  http://addons.moosocial.com/photo/comment
                        }
                     

                        {
							errorCode :  "topic_is_blocked"
                            name :  "This topic has been locked"
                            message :  "This topic has been locked"
                            url :  http://addons.moosocial.com/topic/comment
                        }
                     
Response  401
HideShow

                        {
                            name :  "Access denied"
                            message :  "Access denied"
                            url :  http://addons.moosocial.com/conversation/comment
                        }
                     

                        {
                            name :  "Only friends of the poster can view this item"
                            message :  "Only friends of the poster can view this item"
                            url :  http://addons.moosocial.com/blog/comment
                        }
                     
Response  404
HideShow

                        {
                            name :  "items not exist."
                            message :  "items not exist."
                            url :  http://addons.moosocial.com/blog/comment
                        }
                     

Edit a comment

Edit a comment on module like Topic , Photo , Blog , Video ,....

Edit a comment
POST{objectType}/comment/edit

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
objectType string Object Type can be (conversation | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic)
id int item id ( comment_id , photo_id .....)
comment_id int Comment id
text string The text content of comment
photo file is the path which is uploaded by using the api : /file
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow

                        {
                            name :  "Comment can not be empty."
                            message :  "Comment can not be empty."
                            url :  http://addons.moosocial.com/Blog_Blog/comment/edit
                        }
                     
Response  404
HideShow

                        {
                            name :  "Comment not found."
                            message :  "Comment not found."
                            url :  http://addons.moosocial.com/Blog_Blog/comment/edit
                        }
                     

Edit a comment
PUT{objectType}/comment

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
objectType string Object Type can be (conversation | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic)
id int item id ( comment_id , photo_id .....)
comment_id int Comment id
text string The text content of comment
photo file is the path which is uploaded by using the api : /file
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow

                        {
                            name :  "Comment can not be empty."
                            message :  "Comment can not be empty."
                            url :  http://addons.moosocial.com/Blog_Blog/comment
                        }
                     
Response  404
HideShow

                        {
                            name :  "Comment not found."
                            message :  "Comment not found."
                            url :  http://addons.moosocial.com/Blog_Blog/comment
                        }
                     

Delete a comment

Delete a comment on module like Topic , Photo , Blog , Video ,....

Delete a comment
POST{objectType}/comment/delete

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
objectType string Object can be (conversation | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic)
item_id int item id ( comment_id , photo_id .....)
comment_id int Comment id
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow

                        {
                            name :  "Comment not found."
                            message :  "Comment not found."
                            url :  http://addons.moosocial.com/blog/comment/delete
                        }
                     

Delete a comment
DELETE{objectType}/comment

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
objectType string Object can be (conversation | Blog_Blog | Photo_Album | Photo_Photo | Video_Video | Topic_Topic)
item_id int item id ( comment_id , photo_id .....)
comment_id int Comment id
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow

                        {
                            name :  "Comment not found."
                            message :  "Comment not found."
                            url :  http://addons.moosocial.com/blog/comment/
                        }
                     

User

User Object

Parameter Type Example Description
id int User id
name string User name
url string User profile url
avatar array 1 An array of user avatar

                                        {
                                            http://addons.moosocial.com/uploads/users/avatar/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                            http://addons.moosocial.com/uploads/users/avatar/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                            http://addons.moosocial.com/uploads/users/avatar/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                            http://addons.moosocial.com/uploads/users/avatar/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                           http://addons.moosocial.com/uploads/users/avatar/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                            http://addons.moosocial.com/uploads/users/avatar/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                            http://addons.moosocial.com/uploads/users/avatar/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                                        }
                                        
type string User type
friendCount int User's friend count
photoCount int User's photo count
userStatus string Status with current user (Remove,Add, Cancel,Respond)
userCase int User case that similar to user's status of current user (2 : Remove ,1 : Add ,4: Cancel ,3: Respond )
requestId int If status is Respond , will have request id to answer Accept or Remove friend request . (Default is null )

Get All User

Get all user
GETuser/browse/all

Get an array of all users

Permission

It's required a user access token. How to use

Fields  
HideShow
Parameter Type Example Description
page int Pagging number
Response  200
HideShow

An array of user object

Response  404
HideShow
{
                        "name": "User not found",
                        "message": "User not found",
                        "url": "http://addons.moosocial.com/api/user/browse/all"
                      }

Get all current user's friend

Get all current user's friend
GETuser/browse/friends

Get an array of current user's friend

Permission

It's required a user access token. How to use

Fields  
HideShow
Parameter Type Example Description
page int Pagging number
Response  200
HideShow

An array of user object

Response  404
HideShow
{
                        "name": "User not found",
                        "message": "User not found",
                        "url": "http://addons.moosocial.com/api/user/browse/friends"
                      }

Get all user that current user is following.

Get all user that current user is following.
GETuser/follow

Get all user that current user is following.

Permission

It's required a user access token. How to use

Fields  
HideShow
Parameter Type Example Description
page int Pagging number
Response  200
HideShow

An array of user object

Response  404
HideShow
{
                        "name": "User not found",
                        "message": "User not found",
                        "url": "http://addons.moosocial.com/api/user/follow"
                      }

Search user

Search user
POSTuser/search

Search user

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
name string User name
email email User email
gender array

Array of gender

0 : Male

1: Female

picture int Have profile picture or not ( default : 0 , selected : 1)
online int User is online ( default : 0 , selected : 1)
Response  200
HideShow

An array ofuser object

Response  404
HideShow
{
                        "name": "User not found",
                        "message": "User not found",
                        "url": "http://addons.moosocial.com/api/user/search"
                      }

Change password

Change password
POSTuser/password

Change current user password

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
old_password string Current password
password string New password
password2 string New password ( need matching with password)
Response  200
HideShow
Parameter Type Example Description
message string Your password has been changed
Response  400
HideShow
{
                        "name": "message",
                        "message": "Message",
                        "url": "http://addons.moosocial.com/api/user/password"
                      }

Messages can be :

# Incorrect current password

# Passwords do not match

# Password must have at least 6 characters

Edit user information

Edit user information
POSTuser/edit

Edit user information

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
name string User name
email email User email
month int Birthday month
day int Birthday day
year int Birthday year
gender string User gender (Male , Female)
timezone string Timezone
username string User special username
about string User about
privacy int

Privacy setting

1 : Everyone

2 : Friends Only

hide_online int Setting hide your online status ( default : 0)
receive_message_from_non_friend int Setting receive message from non-friend (default:1)
Response  200
HideShow
Parameter Type Example Description
message string Your changes have been saved
Response  400
HideShow
{
                        "name": "message",
                        "message": "Message",
                        "url": "http://addons.moosocial.com/api/user/edit"
                      }

Messages can be :

# Birthday is required

# Username must not be a numeric value

# Username is restricted

# Name is required

# Email must be a valid email

# Email already exists

# Email is required

# Username must only contain letters and numbers

# Username must be between 5 and 50 characters long.

# Username already exist

Edit user information
PUTuser

Edit user information

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
name string User name
email email User email
month int Birthday month
day int Birthday day
year int Birthday year
gender string User gender (Male , Female)
timezone string Timezone
username string User special username
about string User about
privacy int

Privacy setting

1 : Everyone

2 : Friends Only

hide_online int Setting hide your online status ( default : 0)
receive_message_from_non_friend int Setting receive message from non-friend (default:1)
Response  200
HideShow
Parameter Type Example Description
message string Your changes have been saved
Response  400
HideShow
{
                        "name": "message",
                        "message": "Message",
                        "url": "http://addons.moosocial.com/api/user"
                      }

Messages can be :

# Birthday is required

# Username must not be a numeric value

# Username is restricted

# Name is required

# Email must be a valid email

# Email already exists

# Email is required

# Username must only contain letters and numbers

# Username must be between 5 and 50 characters long.

# Username already exist

Get current user

Returns current user info.

Get current user
GET/user/me

Permission

It's required a user access token. How to use

Response  200
HideShow
Parameter Type Example Description
id number The id of this person's user account. This ID is unique.
name string The person's name.
email string This person's primary email address listed on their profile.
avatar string The list of person's image path of this person's avatar .
last_login string This person's last login in the format MM/DD/YYYY .
photo_count string This person's total photos
friend_count string This person's total friends .
notification_count string This person's notifications is unread
friend_request_count string This person's total friend request is being waited to accept.
blog_count string This person's total blogs
topic_count string This person's total topic
conversation_user_count string This person's total conversations
video_count string This person's total videos
gender string The gender pronoun selected by this person
birthday string This person's birthday in the format MM/DD/YYYY.
timezone string The person's current timezone offset from UTC.
about string The 'about me' section of this person's profile.
lang string The language is selected by this person
cover string The person's image path of this person's avatar.
profile_url string The person's profile path
email_validation boolean This user has verify email or not
menus objects Lists menu show and hide

Get User Info

Get the profile field values of single user.

Get User Info
GETuser/{id}

Permission

It's required a user access token. How to use

Response  200
HideShow
Parameter Type Example Description
enableFollow boolean Enable follow action or not
follow boolean Follow status (followed : true , not follow : false)
canView boolean Current user can view that user's profiel or not
id number The id of this person's user account. This ID is unique.
name string The person's name.
avatar string The list of person's image path of this person's avatar .
photo string
photo_count string This person's total photos of ???
friend_count string This person's total friends .
blog_count string This person's total blogs
topic_count string This person's total topic
video_count string This person's total videos
gender string OPTION.It's belongs to viewer access token .The gender pronoun selected by this person
birthday string OPTION.It's belongs to viewer access token .This person's birthday in the format MM/DD/YYYY
timezone string The person's current timezone offset from UTC.
about string The 'about me' section of this person's profile.
cover string The person's image path of this person's avatar .
Response  404
HideShow
{
                            "name": "User does not exist.",
                            "message": "User does not exist.",
                            "url": "http://addons.moosocial.com/api/user/1000"
                          }

My Avatar

Post owner avatar .

User avatar
POST/user/me/avatar

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
qqfile image
Response  200
HideShow
Parameter Type Example Description
success string success text
filename string photo name
photo string photo url
file_path string photo FULL url
Response  400
HideShow
Parameter Type Example Description
error string error text

Get User Activities

Get user activities feed.

User Activities
GET/user/{id}/activities

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array of Activity objects.

Response  404
HideShow
{
                        "name": "Parameter error : User does not exist.",
                        "message": "Parameter error : User does not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/activities"
                      }

Friend Lists

A person's friends.

Friend Lists
GET/user/{id}/friends

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofUser objects

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/friends"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/friends"
                      }

Blocked Lists

Get all single user's blocked
GET/user/{id}/blocked

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofUser objects

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/blocked"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/blocked"
                      }

User Blogs Created

The photo blogs this person has created.

User Blogs Created
GET/user/{id}/blogs

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofBlog object

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/blogs"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/blogs"
                      }

User Topics Created

The photo topics this person has created.

User Topics Created
GET/user/{id}/topics

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofTopic object

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/topics"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/topics"
                      }

User Albums Created

The photo albums this person has created

User Albums Created
GET/user/{id}/albums

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofAlbum object

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/albums"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/albums"
                      }

User Albums

Publishing new albums.

Note : Special endpoint /user/me/albums

User avatar
POST/user/{user-id}/albums

Permission

A user access token with user_activities permission is required to return activities of that person.

Fields
HideShow
Response  200
HideShow
Reading this endpoint returns an array of Album objects with the same fields as that node.

Attending Events

Returns the events this person is attending.

Attending Events
GET/user/{id}/events

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofEvent objects

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/events"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/events"
                      }

Group Members

The groups that a person is a member of.

Group Members
GET/user/{id}/groups

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofGroup object

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/groups"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/groups"
                      }

Photo Tagged

Shows all photos this person is tagged in.

Photo Tagged
GET/user/{id}/photos

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofPhoto object

Response  404
HideShow
{
                        "name": "Photo not found.",
                        "message": "Photo not found.",
                        "url": "http://addons.moosocial.com/api/user/100/photos?page=1"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/photos?page=1000"
                      }

Liked Items

The items that this person has 'liked'.

Liked Items
GET/user/{user-id}/likes

Permission

A user access token with user_likes permission is required to see all pages liked by that person.

Fields
HideShow
Response  200
HideShow

Reading this endpoint returns an array of item objects with the following additional field:

Parameter Type Example Description
created_time datetime A timestamp indicating when the page was liked by this person.

Notification

The unread notifications that a person has.

Note : Special endpoint /user/me/notifications

Notification
GET/user/{user-id}/notifications

Permission

A user access token with manage_notifications permission is required to view that person's notifications.

Fields
HideShow
Response  200
HideShow
An array of Notification objects.

Photo Tagged

Shows all photos this person is tagged in.

Note : Special endpoint /user/me/photos

Photo Tagged
GET/user/{user-id}/photos

Permission

A user access token with user_photos permission is required to see all photos that person is tagged in .

Fields
HideShow
Response  200
HideShow
An array of Photo objects.

Photo Uploaded

Shows all photos were published by me.

Note : Special endpoint /user/me/photos/uploaded

Photo Uploaded
GET/user/{user-id}/photos/uploaded

Permission

A user access token with user_photos permission is required to see all photos that person has uploaded.

Fields
HideShow
Response  200
HideShow
An array of Photo objects.

Profile Picture

This person's profile picture.

Profile Picture
GET/user/{user-id}/photos/picture

Permission

Because profile pictures are always public on mooSocial, this call does not require any access token.

Fields
HideShow
Parameter Type Example Description
type enum{square,small,normal,large} You use this to get a pre-specified size of picture.
height int Restrict the picture height to this size in pixels.
width int Restrict the picture width to this size in pixels. When height and width are both used, the image will be scaled as close to the dimensions as possible and then cropped down
Response  200
HideShow
Parameter Type Example Description
url string The URL of the profile photo.
height int Picture height in pixels. height and width are only returned when specified as modifiers.
width int Picture width in pixels.

User's video

All videos this person created.

User's video
GET/user/{id}/videos

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int default value is 1
id int User id
Response  200
HideShow

An array ofVideo objects

Response  404
HideShow
{
                        "name": "User not exist.",
                        "message": "User not exist.",
                        "url": "http://addons.moosocial.com/api/user/100/videos"
                      }
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/10/videos"
                      }

Video Published

Shows all videos that were published to mooSocial by this person.

Note : Special endpoint /user/me/videos

Video Published
GET/user/{user-id}/videos/uploaded

Permission

It's required a user access token. How to use

Fields
HideShow
Response  200
HideShow
An array of Video objects.

Get GCM Token

Registering an ID issued by the GCM connection servers to the client app that allows it to receive messages

View detail here

GCM Token
POST/user/me/gcm/token

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
token string REQUIRED - GCM token
language string OPTIONAL - default is eng
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  404
HideShow

                        {
                            errorCode :  "GCM_token_is_emtpy"
                            name :  "GCM Token is emtpy"
                            message :  GCM Token is emtpy
                            url :  http://addons.moosocial.com/user/me/gcm/token
                        }
                     

Delete GCM Token

Delete GCM Token.

Delete GCM Token
POST/user/me/gcm/token/delete

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
token string REQUIRED - GCM token
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  404
HideShow

                        {
                            errorCode :  "GCM_token_is_emtpy"
                            name :  "GCM Token is emtpy"
                            message :  GCM Token is emtpy
                            url :  http://addons.moosocial.com/user/me/gcm/token/delete
                        }
                     

Delete Token
DELETE/user/me/gcm/token

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
token string REQUIRED - GCM token
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  404
HideShow

                        {
                            errorCode :  "GCM_token_is_emtpy"
                            name :  "GCM Token is emtpy"
                            message :  GCM Token is emtpy
                            url :  http://addons.moosocial.com/user/me/gcm/token/
                        }
                     

User Register

Receiving an token security from the server that uses it for registering new user ( It will help to protect the 'public' part of a REST service from spam? )

User Register
GET/user/register

Permission

It is a public api

Fields
HideShow
Response  200
HideShow
Parameter Type Example Description
key string AUTO defind , reuturn key string
birthday_require boolean CORE defind , return TRUE or FALSE
disable_registration boolean CORE defind , return TRUE or FALSE
require_gender boolean CORE defind , return TRUE or FALSE
show_gender_signup boolean CORE defind , return TRUE or FALSE
enable_unspecified_gender boolean CORE defind , return TRUE or FALSE
show_birthday_signup boolean CORE defind , return TRUE or FALSE

Sign up an account.

Sign up an account.
POST/user/register

Permission

It is a public api

Fields
HideShow
Parameter Type Example Description
key number Get from '/user/register' api via 'GET' method
security_token string md5(Api.api_secret_key + key)
email string Required
password string Required - Password must have at least 6 characters
password2 string Required - Verify password , need match with password
name string Required
gender string OPTIONAL - ( Male , Female ) , can be blank .
birthday string OPTIONAL - Can be blank
registration_code string OPTIONAL
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  400
HideShow

                        {
                            errorCode :  "key_is_not_empty"
                            name :  "Key is not empty!"
                            message :  "Key is not empty!"
                            url :  http://addons.moosocial.com/user/register
                        }
                     

                        {
                            errorCode :  "key_is_not_invalid"
                            name :  "Key is not invalid!"
                            message :  "Key is not invalid!"
                            url :  http://addons.moosocial.com/user/register
                        }
                     

                        {
                            errorCode :  "security_token_is_invalid"
                            name :  "Security token is invalid"
                            message :  "Security token is invalid"
                            url :  http://addons.moosocial.com/user/register
                        }
                     

User Forgot

Set key for reset password form

User Forgot
GET/user/forgot

Permission

It is a public api

Fields
HideShow
Response  200
HideShow
Parameter Type Example Description
key string AUTO defind , reuturn key string

Forgot Password

Reset and Send forgot password email to email user .

Send forgot password
POST/user/forgot

Permission

It is a public api

Fields
HideShow
Parameter Type Example Description
key string REQUIRED
email string REQUIRED - Email user
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  400
HideShow

                        {
                            errorCode :  "key_is_not_empty"
                            name :  "Key is not empty!"
                            message :  "Key is not empty!"
                            url :  http://addons.moosocial.com/user/forgot
                        }
                     

                        {
                            errorCode :  "key_is_not_invalid"
                            name :  "Key is not invalid!"
                            message :  "Key is not invalid!"
                            url :  http://addons.moosocial.com/user/forgot
                        }
                     

                        {
                            errorCode :  "email_does_not_exist"
                            name :  "Email does not exist"
                            message :  "Email does not exist"
                            url :  http://addons.moosocial.com/user/forgot
                        }
                     
Response  401
HideShow

                        {
                            errorCode :  "key_is_expired"
                            name :  "Key is expired!"
                            message :  "Key is expired!"
                            url :  http://addons.moosocial.com/user/forgot
                        }
                     

Follow user

Follow user
POSTuser/follow

Follow user

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
user_id int User id
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  400
HideShow
{
                        "name": "Already Followed",
                        "message": "Already Followed",
                        "url": "http://addons.moosocial.com/api/user/follow"
                      }
Response  404
HideShow
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/follow"
                      }

UnFollow user

UnFollow user
POSTuser/unfollow

UnFollow user

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
user_id int User id
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  400
HideShow
{
                        "name": "Already UnFollowed",
                        "message": "Already UnFollowed",
                        "url": "http://addons.moosocial.com/api/user/unfollow"
                      }
Response  404
HideShow
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/unfollow"
                      }

Block user

Block user
POSTuser/block

Block user

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
user_id int User id
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  400
HideShow
{
                        "name": "You cannot block to yourself",
                        "message": "You cannot block to yourself",
                        "url": "http://addons.moosocial.com/api/user/block"
                      }
{
                        "name": "You already block this user",
                        "message": "You already block this user",
                        "url": "http://addons.moosocial.com/api/user/block"
                      }
Response  404
HideShow
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/block"
                      }

UnBlock user

UnBlock user
POSTuser/unblock

UnBlock user

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
user_id int User id
Response  200
HideShow
Parameter Type Example Description
message string Return message when done
Response  400
HideShow
{
                        "name": "This user is not blocked by you",
                        "message": "This user is not blocked by you",
                        "url": "http://addons.moosocial.com/api/user/unblock"
                      }
{
                        "name": "You cannot unblock to yourself",
                        "message": "You cannot unblock to yourself",
                        "url": "http://addons.moosocial.com/api/user/unblock"
                      }
Response  404
HideShow
{
                        "name": "User not found.",
                        "message": "User not found.",
                        "url": "http://addons.moosocial.com/api/user/unblock"
                      }

Blog

All action related to blog plugin

Blog Object

Parameter Type Example Description
id int Blog id
title string Blog title
body string Blog body
thumbnail string A array of blog thumbnail .
 {
                         http://addons.moosocial.com/uploads/blogs/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/blogs/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/blogs/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/blogs/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/blogs/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/blogs/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/blogs/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
categoryId int Blog category id
privacy int 1 The privacy settings of the post.

                                        {
                                            description     :  Number that describes the privacy settings, as they would appear on mooSocial
                                            value     :  The actual privacy setting. enum{EVERYONE = 1 , ALL_FRIENDS = 2 , SELF = 3}
                                        }
                                        
commentCount int Total comment count on a blog
shareCount int Total share count on a blog
likeCount int Total like count on a blog
dislikeCount int Total dislike count on a blog
userId int Owner id
userName string Owner name
userUrl string Owner link to profile
url string Blog url
published datetime Created time
publishedTranslated datetime The time the post was initially published with text translation
type string Type of blog object (Blog_Blog)
shareAction string Action type when share detail of Blog (blog_item_detail)

It will be used in api blog/{blog_id}

isViewerLiked boolean Return TRUE if current user liked this blog

It will be used in api blog/{blog_id}

isViewerDisliked boolean Return TRUE if current user disliked this blog

It will be used in api blog/{blog_id}

Get All Blog

Get all blog
GETblog/all

Get an array of all blogs

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of blog object

Response  404
HideShow
{
                        "name": "Blog not found",
                        "message": "Blog not found",
                        "url": "http://addons.moosocial.com/api/blog/all"
                      }

Get My Blog

Get my blog
GETblog/my

Get an array of my blogs

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of blog object

Response  404
HideShow
{
                        "name": "Blog not found",
                        "message": "Blog not found",
                        "url": "http://addons.moosocial.com/api/blog/my"
                      }

Get Friends Blog

Get friends blog
GETblog/friends

Get an array of friends blogs

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of blog object

Response  404
HideShow
{
                        "name": "Blog not found",
                        "message": "Blog not found",
                        "url": "http://addons.moosocial.com/api/blog/friends"
                      }

Browse blog from a category

Browse blog from a category
GETblog/category/{category_id}

Get blog from a category

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Fields
HideShow
Parameter Type Example Description
category_id int category id
Response  200
HideShow

An array of blog object

Response  404
HideShow
{
							"name": "Blog not found",
                        "message": "Blog not found",
							"url": "http://addons.moosocial.com/api/blog/category/5"
						  }

View Blog Detail

Get blog detail
GETblog/{blog_id}

View blog detail by blog id

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
blog_id int Blog id
Response  200
HideShow
Response  401
HideShow
{
			"errorCode": "friends_only",
            "name": "Only friends of the poster can view this item",
            "message": "Only friends of the poster can view this item",
            "url": "http://addons.moosocial.com/api/blog/2"
          }
{
			"errorCode": "only_me",
            "name": "Only the poster can view this item",
            "message": "Only the poster can view this item",
            "url": "http://addons.moosocial.com/api/blog/3"
          }
Response  404
HideShow
{
                        "name": "Blog not found",
                        "message": "Blog not found",
                        "url": "http://addons.moosocial.com/api/blog/4000"
                      }

Filter blog

Filter blog
POSTblog/filter

Filter blog by keyword

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
keyword string Keyword to search
page int Page number
Response  200
HideShow

An array ofblog object

Response  404
HideShow
{
                       "name": "Blog not found",
                        "message": "Blog not found",
                        "url": "http://addons.moosocial.com/api/blog/filter"
                      }

Create blog

Create blog
POSTblog/create

Create a blog

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
title string REQUIRED | Blog title
body string REQUIRED | Blog body
thumbnail file Thumbnail of blog , is the path which is uploaded by using the api /file
tags string

Blog tag , seperate by comma

ex : this,is,blog,tag

category_id int

Blog category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "blog title is missing.",
                        "message": "blog title is missing.",
                        "url": "http://addons.moosocial.com/api/blog/create"
                      }
{
                        "name": "blog body is missing.",
                        "message": "blog body is missing.",
                        "url": "http://addons.moosocial.com/api/blog/create"
                      }
{
                        "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/blog/create"
                      }

Edit blog

Edit blog
POSTblog/edit

Edit a blog

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id int Blog id
title string REQUIRED | Blog title
body string REQUIRED | Blog body
thumbnail file Thumbnail of blog , is the path which is uploaded by using the api /file
tags string

Blog tag , seperate by comma

ex : this,is,blog,tag

category_id int

Blog category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "blog title is missing.",
                        "message": "blog title is missing.",
                        "url": "http://addons.moosocial.com/api/blog/edit"
                      }
{
                        "name": "blog body is missing.",
                        "message": "blog body is missing.",
                        "url": "http://addons.moosocial.com/api/blog/edit"
                      }
{
                       "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/blog/edit"
                      }

Edit blog
PUTblog/{id}

Edit a blog

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id int Blog id
title string REQUIRED | Blog title
body string REQUIRED | Blog body
thumbnail file Thumbnail of blog , is the path which is uploaded by using the api /file
tags string

Blog tag , seperate by comma

ex : this,is,blog,tag

category_id int

Blog category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "blog title is missing.",
                        "message": "blog title is missing.",
                        "url": "http://addons.moosocial.com/api/blog/10"
                      }
{
                        "name": "blog body is missing.",
                        "message": "blog body is missing.",
                        "url": "http://addons.moosocial.com/api/blog/10"
                      }
{
                       "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/blog/10"
                      }

Delete Blog

Delete Blog

Delete blog
POST/blog/delete/{blog_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
blog_id int Blog id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/blog/delete/2"
                      }
Response  404
HideShow
{
                        "name": "Blog not found",
                        "message": "Blog not found",
                        "url": "http://addons.moosocial.com/api/blog/delete/20000"
                      }

Delete blog
DELETE/blog/delete/{blog_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
blog_id int Blog id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                       "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/blog/delete/2"
                      }
Response  404
HideShow
{
                        "name": "Blog not found",
                        "message": "Blog not found",
                        "url": "http://addons.moosocial.com/api/blog/delete/20000"
                      }

Topic

All action related to topic plugin

Topic Object

Parameter Type Example Description
id int topic id
title string topic title
body string topic body
thumbnail string A array of topic thumbnail .
 { .

                        http://addons.moosocial.com/uploads/topics/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/topics/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/topics/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/topics/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/topics/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/topics/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/topics/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       } 
caterogyId int topic category id
commentCount int Total comment count on a topic
shareCount int Total share count on a topic
likeCount int Total like count on a topic
dislikecount int Total dislike count on a topic
userId int Owner id
userName string Owner name
userUrl string Owner link to profile
url string Topic url
published datetime Created time
publishedTranslated datetime Created time with format .
type datetime Type of topic object (Topic_Topic)
shareAction string Action type when share detail of Topic (topic_item_detail)

It will be used in api topic/{topic_id}

isViewerLiked boolean Return TRUE if current user liked this topic

It will be used in api topic/{topic_id}

isViewerDisliked boolean Return TRUE if current user disliked this topic

It will be used in api topic/{topic_id}

Get All topic

Get all topic
GETtopic/all

Get an array of all topics

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Paging
Response  200
HideShow

An array of topic object

Response  404
HideShow
{
                        "name": "topic not found",
                        "message": "topic not found",
                        "url": "http://addons.moosocial.com/api/topic/all"
                      }

Get My topic

Get my topic
GETtopic/my

Get an array of my topics

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Paging
Response  200
HideShow

An array of topic object

Response  404
HideShow
{
                        "name": "topic not found",
                        "message": "topic not found",
                        "url": "http://addons.moosocial.com/api/topic/my"
                      }

Get Friends topic

Get friends topic
GETtopic/friends

Get an array of friends topics

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Paging
Response  200
HideShow

An array of topic object

Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/friends"
						  }

View topic

Get topic detail
GETtopic/{topic_id}

View topic detail by topic id

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
topic_id int topic id
Response  200
HideShow

A topic object

Parameter Type Example Description
allowAction boolean Current user can comment, like , share on this topic or not (In case topic is locked)
groupId int Group id when posted topic in a group
groupName string Group name when posted topic in a group
groupUrl string Group url when posted topic in a group
Response  401
HideShow
{
				"errorCode": "friends_only",
				"name": "Only friends of the poster can view this item",
				"message": "Only friends of the poster can view this item",
				"url": "http://addons.moosocial.com/api/topic/2"
			  }
{
				"errorCode": "only_me",
				"name": "Only the poster can view this item",
				"message": "Only the poster can view this item",
				"url": "http://addons.moosocial.com/api/topic/3"
			  }
Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/4000"
						  }

Browse topic from a group

Browse topic from a group
GETtopic/group/{group_id}

Get topic from a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int Group id
page int Paging
Response  200
HideShow

An array of topic object

Response  400
HideShow
{
				"errorCode": "not_group_member",
				"name": "Only group members can view topics",
				"message": "Only group members can view topics",
				"url": "http://addons.moosocial.com/api/topic/group/2"
			  }
Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/group/5"
						  }
{
							"name": "group not found",
							"message": "group not found",
							"url": "http://addons.moosocial.com/api/topic/group/20000"
						  }

Browse topic from a category

Browse topic from a category
GETtopic/category/{category_id}

Get topic from a category

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
category_id int category id
page int Paging
Response  200
HideShow

An array of topic object

Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/category/5"
						  }

Pin a topic

Pin a topic
POSTtopic/pin/{topic_id}

Pin a topic

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
topic_id int Topic id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
				"name": "Topic already pinned",
				"message": "Topic already pinned",
				"url": "http://addons.moosocial.com/api/topic/pin/2"
			  }
Response  401
HideShow
{
				"name": "Access denied",
				"message": "Access denied",
				"url": "http://addons.moosocial.com/api/topic/pin/1"
			  }
Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/pin/500"
						  }

Unpin a topic

Unpin a topic
POSTtopic/unpin/{topic_id}

Unpin a topic

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
topic_id int Topic id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
				"name": "Topic already unpinned",
				"message": "Topic already unpinned",
				"url": "http://addons.moosocial.com/api/topic/unpin/2"
			  }
Response  401
HideShow
{
				"name": "Access denied",
				"message": "Access denied",
				"url": "http://addons.moosocial.com/api/topic/unpin/1"
			  }
Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/unpin/500"
						  }

Lock a topic

Lock a topic
POSTtopic/lock/{topic_id}

Lock a topic

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
topic_id int Topic id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
				"name": "Topic already locked",
				"message": "Topic already locked",
				"url": "http://addons.moosocial.com/api/topic/lock/2"
			  }
Response  401
HideShow
{
				"name": "Access denied",
				"message": "Access denied",
				"url": "http://addons.moosocial.com/api/topic/lock/1"
			  }
Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/lock/500"
						  }

Unlock a topic

Unlock a topic
POSTtopic/unlock/{topic_id}

Unlock a topic

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
topic_id int Topic id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
				"name": "Topic already unlocked",
				"message": "Topic already unlocked",
				"url": "http://addons.moosocial.com/api/topic/unlock/2"
			  }
Response  401
HideShow
{
				"name": "Access denied",
				"message": "Access denied",
				"url": "http://addons.moosocial.com/api/topic/unlock/1"
			  }
Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/unlock/500"
						  }

Filter topic

Filter topic
POSTtopic/filter

Filter topic by keyword

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
keyword string Keyword to search
page int Paging
Response  200
HideShow

An array of topic object

Response  404
HideShow
{
							"name": "topic not found",
							"message": "topic not found",
							"url": "http://addons.moosocial.com/api/topic/filter"
						  }

Create topic

Create topic
POSTtopic/create

Create a topic

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
title string REQUIRED | topic title
body string REQUIRED | topic body
thumbnail file Thumbnail of blog , is the path which is uploaded by using the api /file
tags string

topic tag , seperate by comma

ex : this,is,topic,tag

category_id int

topic category id

group_id int

Group id when create topic in a group

Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
id int topic id
Response  400
HideShow
{
							"name": "topic title is missing.",
							"message": "topic title is missing.",
							"url": "http://addons.moosocial.com/api/topic/create"
						  }
{
							"name": "topic body is missing.",
							"message": "topic body is missing.",
							"url": "http://addons.moosocial.com/api/topic/create"
						  }
{
							"name": "No special characters ( /,?,#,%,...) allowed in Tags",
							"message": "No special characters ( /,?,#,%,...) allowed in Tags",
							"url": "http://addons.moosocial.com/api/topic/create"
						  }

Edit topic

Edit topic
POSTtopic/edit

Edit a topic

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id int topic id
title string REQUIRED | topic title
body string REQUIRED | topic body
thumbnail file Thumbnail of blog , is the path which is uploaded by using the api /file
tags string

topic tag , seperate by comma

ex : this,is,topic,tag

category_id int

topic category id

group_id int

group id

Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "topic title is missing.",
                        "message": "topic title is missing.",
                        "url": "http://addons.moosocial.com/api/topic/edit"
                      }
{
                        "name": "topic body is missing.",
                        "message": "topic body is missing.",
                        "url": "http://addons.moosocial.com/api/topic/edit"
                      }
{
                        "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/topic/edit"
                      }
{
                        "name": "You are not member of this group.",
                        "message": "You are not member of this group.",
                        "url": "http://addons.moosocial.com/api/topic/edit"
                      }

Edit topic
PUTtopic/{id}

Edit a topic

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id int topic id
title string REQUIRED | topic title
body string REQUIRED | topic body
thumbnail file Thumbnail of blog , is the path which is uploaded by using the api /file
tags string

topic tag , seperate by comma

ex : this,is,topic,tag

category_id int

topic category id

group_id int

group id

Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "topic title is missing.",
                        "message": "topic title is missing.",
                        "url": "http://addons.moosocial.com/api/topic/2"
                      }
{
                        "name": "topic body is missing.",
                        "message": "topic body is missing.",
                        "url": "http://addons.moosocial.com/api/topic/1"
                      }
{
                        "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/topic/1"
                      }
{
                        "name": "You are not member of this group.",
                        "message": "You are not member of this group.",
                        "url": "http://addons.moosocial.com/api/topic/1"
                      }

Delete topic

Delete topic

Delete topic
POST/topic/delete/{topic_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
topic_id int topic id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/topic/delete/2"
                      }
Response  404
HideShow
{
                        "name": "topic not found",
                        "message": "topic not found",
                        "url": "http://addons.moosocial.com/api/topic/delete/20000"
                      }

Delete topic
DELETE/topic/delete/{topic_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
topic_id int topic id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/topic/delete/2"
                      }
Response  404
HideShow
{
                        "name": "topic not found",
                        "message": "topic not found",
                        "url": "http://addons.moosocial.com/api/topic/delete/20000"
                      }

video

All action related to video plugin

video Object

Parameter Type Example Description
id int video id
published datetime Video created time
publishedTranslated datetime The time the post was initially published with text translation
title string video title
description string video description
thumbnail string A array of video thumbnail .
 {
                         http://addons.moosocial.com/uploads/videos/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/videos/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/videos/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/videos/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/videos/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/videos/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/videos/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
url string Video url
videoType string Type of video only allow( youtube | vimeo )
videoSourceId string Ex: youtube : 34PmUiKPrQg Video source ID
caterogyId int video category id
privacy int 1 The privacy settings of the post.

                                        {
                                            description     :  "Number that describes the privacy settings, as they would appear on mooSocial"
                                            value     :  The actual privacy setting. enum{EVERYONE = 1 , ALL_FRIENDS = 2 , SELF = 3}
                                        }
                                        
commentCount int Total comment count on a video
shareCount int Total share count on a video
likeCount int Total like count on a video
dislikeCount int Total dislike count on a video
userId int Owner id
userName string Owner name
userUrl string Owner link to profile
userAvatar string An array of owner's avatar
 {
                         http://addons.moosocial.com/uploads/videos/thumbnail/6/50_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/videos/thumbnail/6/100_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/videos/thumbnail/6/200_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        http://addons.moosocial.com/uploads/videos/thumbnail/6/600_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
type string Type of video object (Video_Video)
shareAction string Action type when share detail of Video (video_item_detail)

It will be used in api video/{video_id}

isViewerLiked boolean Return TRUE if current user liked this photo

It will be used in api video/{video_id}

isViewerDisliked boolean Return TRUE if current user disliked this photo

It will be used in api video/{video_id}

Get All video

Get all video
GETvideo/all

Get an array of all videos

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Paging
Response  200
HideShow

An array of video object

Response  404
HideShow
{
                        "name": "video not found",
                        "message": "video not found",
                        "url": "http://addons.moosocial.com/api/video/all"
                      }

Get My video

Get my video
GETvideo/my

Get an array of my videos

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Paging
Response  200
HideShow

An array of video object

Response  404
HideShow
{
                        "name": "video not found",
                        "message": "video not found",
                        "url": "http://addons.moosocial.com/api/video/my"
                      }

Get Friends video

Get friends video
GETvideo/friends

Get an array of friends videos

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Paging
Response  200
HideShow

An array of video object

Response  404
HideShow
{
                        "name": "video not found",
                        "message": "video not found",
                        "url": "http://addons.moosocial.com/api/video/friends"
                      }

Browse video from a category

Browse video from a category
GETvideo/category/{category_id}

Get video from a category

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
category_id int category id
page int Paging
Response  200
HideShow

An array of video object

Response  404
HideShow
{
							"name": "video not found",
							"message": "video not found",
							"url": "http://addons.moosocial.com/api/video/category/5"
						  }

Browse video from a group

Browse video from a group
GETvideo/group/{group_id}

Get video from a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
page int Paging
Response  200
HideShow

An array of video object

Response  400
HideShow
{
							"name": "Only group members can view topics",
							"message": "Only group members can view topics",
							"url": "http://addons.moosocial.com/api/video/group/5"
						  }
Response  404
HideShow
{
							"name": "video not found",
							"message": "video not found",
							"url": "http://addons.moosocial.com/api/video/group/5"
						  }
{
							"name": "group not found",
							"message": "group not found",
							"url": "http://addons.moosocial.com/api/video/group/5"
						  }

View video detail by video id

View video detail by video id
GETvideo/{video_id}

View video detail by video id

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
video_id int video id
Response  200
HideShow

A video object

Parameter Type Example Description
groupId int Group id when posted video in a group
groupName string Group name when posted video in a group
groupUrl string Group url when posted video in a group
pcUpload boolean Return true when video upload by Upload Video Plugin
videoSource string Video source when upload by Upload Video Plugin
Response  401
HideShow
{
							"name": "Only friends of the poster can view this item",
							"message": "Only friends of the poster can view this item",
							"url": "http://addons.moosocial.com/api/video/5"
						  }
{
							"name": "Only the poster can view this item",
							"message": "Only the poster can view this item",
							"url": "http://addons.moosocial.com/api/video/5"
						  }
Response  404
HideShow
{
							"name": "video not found",
							"message": "video not found",
							"url": "http://addons.moosocial.com/api/video/5"
						  }

Filter video

Filter video
POSTvideo/filter

Filter video by keyword

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
keyword string Keyword to search
page int Paging
Response  200
HideShow

An array of video object

Response  404
HideShow
{
                        "name": "video not found",
                        "message": "video not found",
                        "url": "http://addons.moosocial.com/api/video/filter"
                      }

Fetch video

Fetch video
POSTvideo/fetch

Fetch a video by url

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
source string Type of video ( youtube | vimeo )
url link

youtube : https://www.youtube.com/watch?v=sbfks7HdRoE

vimeo : https://vimeo.com/180525552

Url of video
group_id int

Group id when fetch video in a group

Response  200
HideShow
Parameter Type Example Description
source string Video source ( youtube | vimeo )
sourceId string Video source id
title string Title of video parsed by video's source
description string Description of video parsed by video's source
privacy int Privacy of video ( default : 1)
thumb link Video thumb
Response  400
HideShow
{
                        "name": Invalid URL. Please try again.,
                        "message": Invalid URL. Please try again.,
                        "url": "http://addons.moosocial.com/api/video/fetch"
                      }

Save video

Save video
POSTvideo/save

Save a video

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
source string Type of video ( youtube | vimeo )
source_id string Video source id
title string OPTIONAL | IF title set blank , title of video will be set by title of url video
description string OPTIONAL | IF video description is blank , description will be set by description of url video
tags string

video tag , seperate by comma

ex : this,is,video,tag

category_id int

video category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
group_id int

Group id when save video in a group

thumb link

Video thumb

Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
id int Video id
Response  400
HideShow
{
                        "name": video category is missing.,
                        "message": video category is missing.,
                        "url": "http://addons.moosocial.com/api/video/create"
                      }
{
                        "name": No special characters ( /,?,#,%,...) allowed in Tags,
                        "message": No special characters ( /,?,#,%,...) allowed in Tags,
                        "url": "http://addons.moosocial.com/api/video/create"
                      }
Response  401
HideShow
{
                        "errorCode": "not_group_member",
						"name": You are not member of this group.,
                        "message": You are not member of this group.,
                        "url": "http://addons.moosocial.com/api/video/create"
                      }

Edit video

Edit video
POSTvideo/edit

Edit a video

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id string video id
title string OPTIONAL | IF title set blank , title of video will be set by title of url video
description string OPTIONAL | IF video description is blank , description will be set by description of url video
tags string

video tag , seperate by comma

ex : this,is,video,tag

category_id int

video category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
group_id int

video group id

Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": video category is missing.,
                        "message": video category is missing.,
                        "url": "http://addons.moosocial.com/api/video/edit"
                      }
{
                        "name": No special characters ( /,?,#,%,...) allowed in Tags,
                        "message": No special characters ( /,?,#,%,...) allowed in Tags,
                        "url": "http://addons.moosocial.com/api/video/edit"
                      }
Response  401
HideShow
{
                        "errorCode": "not_group_member",
						"name": You are not member of this group.,
                        "message": You are not member of this group.,
                        "url": "http://addons.moosocial.com/api/video/edit"
                      }

Edit video
PUTvideo/{id}

Edit a video

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id string video id
title string OPTIONAL | IF title set blank , title of video will be set by title of url video
description string OPTIONAL | IF video description is blank , description will be set by description of url video
tags string

video tag , seperate by comma

ex : this,is,video,tag

category_id int

video category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
group_id int

video group id

Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": video category is missing.,
                        "message": video category is missing.,
                        "url": "http://addons.moosocial.com/api/video/1"
                      }
{
                        "name": No special characters ( /,?,#,%,...) allowed in Tags,
                        "message": No special characters ( /,?,#,%,...) allowed in Tags,
                        "url": "http://addons.moosocial.com/api/video/1"
                      }
Response  401
HideShow
{
                        "errorCode": "not_group_member",
						"name": You are not member of this group.,
                        "message": You are not member of this group.,
                        "url": "http://addons.moosocial.com/api/video/1"
                      }

Delete video

Delete video

Delete video
POST/video/delete/{video_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
video_id int video id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/video/delete/2"
                      }
Response  404
HideShow
{
                        "name": "video not found",
                        "message": "video not found",
                        "url": "http://addons.moosocial.com/api/video/delete/20000"
                      }

Delete video
DELETE/video/{video_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
video_id int video id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/video/2"
                      }
Response  404
HideShow
{
                        "name": "video not found",
                        "message": "video not found",
                        "url": "http://addons.moosocial.com/api/video/20000"
                      }

Album

All action related to album plugin

album Object

Parameter Type Example Description
id int album id
published datetime Date created
publishedTranslated datetime The time the post was initially published with text translation
title string album title
description string Album description
thumbnail array A array of album thumbnail .
 {
                         http://addons.moosocial.com/uploads/photos/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/photos/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
caterogyId int album category id
type string Album type
url link Album link
privacy int 1 The privacy settings of the post.

                                        {
                                            description     :  "Number that describes the privacy settings, as they would appear on mooSocial"
                                            value     :  The actual privacy setting. enum{EVERYONE = 1 , ALL_FRIENDS = 2 , SELF = 3}
                                        }
                                        
commentCount int Total comment count on a album
likeCount int Total like count on a album
dislikeCount int Total dislike count on a album
userId int Owner id
userName string Owner name
shareAction string Action type when share detail of Album (album_item_detail)

It will be used in api album/{album_id}

isViewerLiked string Return TRUE if current user liked this album

It will be used in api album/{album_id}

isViewerDisliked string Return TRUE if current user disliked this album

It will be used in api album/{album_id}

photoCount string Number of photo
photoObject string

An array of photo in current album


                            {
                            id     :  "photo id"
                            published :  "date uploaded"
                            publishedTranslated :  "date uploaded translated"
                            targetId :  "album id"
                            thumbnail :  "An array of photo thumbnail"
                                                                        
 {
                                                                                                 http://addons.moosocial.com/uploads/photos/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                                                                                http://addons.moosocial.com/uploads/photos/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                                                                                http://addons.moosocial.com/uploads/photos/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                                                                                http://addons.moosocial.com/uploads/photos/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                                                                               http://addons.moosocial.com/uploads/photos/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                                                                                http://addons.moosocial.com/uploads/photos/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                                                                                                http://addons.moosocial.com/uploads/photos/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                                                                                                }
                                                                                                                
caption : "photo caption" privacy : "photo privacy" commentCount : "photo comment count" likeCount : "photo like count" dislikeCount : "photo dislike count" }
canUploadPhoto boolean Show If current user has permission to upload photo or not

Get All album

Get all album
GETalbum/all

Get an array of all albums

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Paging
Response  200
HideShow

An array of album object

Response  404
HideShow
{
                        "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/all"
                      }

Get My album

Get my album
GETalbum/my

Get an array of my albums

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of album object

Response  404
HideShow
{
                        "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/my"
                      }

Get Friends album

Get friends album
GETalbum/friends

Get an array of friends albums

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of album object

Response  404
HideShow
{
                        "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/friends"
                      }

Browse album from a category

Browse album from a category
GETalbum/category/{category_id}

Get album from a category

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
category_id int category id
page int Page number
Response  200
HideShow

An array of album object

Response  404
HideShow
{
							"name": "album not found",
                        "message": "album not found",
"url": "http://addons.moosocial.com/api/album/category/5"
						  }

Filter album

Filter album
POSTalbum/filter

Filter album by keyword

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
keyword string Keyword to search
page string Page number
Response  200
HideShow

An array ofalbum object

Response  404
HideShow
{
                       "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/filter"
                      }

View album Detail

Get album detail
GETalbum/{album_id}

View album detail by album id

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
album_id int album id
Response  200
HideShow
Parameter Type Example Description
Album object object

A album object

Photo object object

An array of photo belong to album id Photo object

Response  401
HideShow
{
			"errorCode": "friends_only",
            "name": "Only friends of the poster can view this item",
            "message": "Only friends of the poster can view this item",
            "url": "http://addons.moosocial.com/api/album/2"
          }
{
			"errorCode": "only_me",
            "name": "Only the poster can view this item",
            "message": "Only the poster can view this item",
            "url": "http://addons.moosocial.com/api/album/3"
          }
Response  404
HideShow
{
                        "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/4000"
                      }

Create album

Create album
POSTalbum/create

Create a album

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
title string REQUIRED | album title
description string REQUIRED | album description
tags string

album tag , seperate by comma

ex : this,is,album,tag

category_id int

REQUIRED | album category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "album title is missing.",
                        "message": "album title is missing.",
                        "url": "http://addons.moosocial.com/api/album/create"
                      }
{
                        "name": "album body is missing.",
                        "message": "album body is missing.",
                        "url": "http://addons.moosocial.com/api/album/create"
                      }
{
                        "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/album/create"
                      }

Edit album

Edit album
POSTalbum/edit

Edit a album

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id id album id
title string REQUIRED | album title
description string REQUIRED | album description
tags string

album tag , seperate by comma

ex : this,is,album,tag

category_id int

REQUIRED | album category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "album title is missing.",
                        "message": "album title is missing.",
                        "url": "http://addons.moosocial.com/api/album/edit"
                      }
{
                        "name": "album body is missing.",
                        "message": "album body is missing.",
                        "url": "http://addons.moosocial.com/api/album/edit"
                      }
{
                        "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/album/edit"
                      }

Edit album
PUTalbum/{id}

Edit a album

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id id album id
title string REQUIRED | album title
description string REQUIRED | album description
tags string

album tag , seperate by comma

ex : this,is,album,tag

category_id int

REQUIRED | album category id

privacy int The actual number privacy settings of the post.

                                        {

                                        EVERYONE    :  1
                                        ALL_FRIENDS    :  2
                                        SELF    :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "album title is missing.",
                        "message": "album title is missing.",
                        "url": "http://addons.moosocial.com/api/album/12"
                      }
{
                        "name": "album body is missing.",
                        "message": "album body is missing.",
                        "url": "http://addons.moosocial.com/api/album/12"
                      }
{
                        "name": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "message": "No special characters ( /,?,#,%,...) allowed in Tags",
                        "url": "http://addons.moosocial.com/api/album/1"
                      }

Set album cover image

Set album cover image
POSTalbum/setcover

Set album cover image

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
id int Album id
photo_id int Photo id
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Photo not belong to this album.",
                        "message": "Photo not belong to this album.",
                        "url": "http://addons.moosocial.com/api/album/setcover"
                      }
Response  404
HideShow
{
                        "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/setcover"
                      }
{
                        "name": "Photo not found",
                        "message": "Photo not found",
                        "url": "http://addons.moosocial.com/api/album/setcover"
                      }

Delete album

Delete album

Delete album
POST/album/delete/{album_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
album_id int album id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/album/delete/2"
                      }
Response  404
HideShow
{
                        "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/delete/20000"
                      }

Delete album
DELETE/album/{album_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
album_id int album id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/album/2"
                      }
Response  404
HideShow
{
                        "name": "album not found",
                        "message": "album not found",
                        "url": "http://addons.moosocial.com/api/album/20000"
                      }

Photo

All action related to photo plugin

Photo Object

Parameter Type Example Description
id int Photo id
published datetime photo date created
publishedTranslated datetime photo date created with translation
caption string photo caption
thumbnail array An array of photo thumbnail . .
 {
                         http://addons.moosocial.com/uploads/photos/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/photos/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/photos/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
privacy int 1 The privacy settings of the post.

                                        {
                                            description     :  "Number that describes the privacy settings, as they would appear on mooSocial"
                                            value     :  The actual privacy setting. enum{EVERYONE = 1 , ALL_FRIENDS = 2 , SELF = 3}
                                        }
                                        
type string Photo type
url link Photo url
commentCount int Total comment count on a photo
likeCount int Total like count on a photo
dislikeCount int Total dislike count on a photo
userId int Owner id
userName string Owner name
albumType string Type of Album
nextPhotoId int Photo Id of next photo in same album
prePhotoId int Photo Id of previous photo in same album
isViewerLiked boolean Return TRUE if current user liked this photo

It will be used in api photo/{photo_id}

isViewerDisliked boolean Return TRUE if current user disliked this photo

It will be used in api photo/{photo_id}

shareAction string Action type when share detail of Photo (photo_item_detail)

It will be used in api photo/{photo_id}

Browse photo from a group

Browse group photo
GETphoto/group/{group_id}

Browse group photo

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int Group id
page int Page number
Response  200
HideShow

An array of photo object

Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/group/{group_id}"
                      }

Browse photo from an album

Browse album photo
GETphoto/album/{album_id}

Browse album photo

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
album_id int Album id
page int Page number
Response  200
HideShow

An array of photo object

Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/album/{album_id}"
                      }

View tagged photo album by person

View tagged photo album by person
GETphoto/tagAlbumPhoto/{photo_id}?uid={uid}

View tagged photo album by person

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int Photo id
page int Page number
uid int User id that current user view
Response  200
HideShow

An array of photo object

Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/tagAlbumPhoto/5000?uid=100"
                      }
{
                        "name": "user not found",
                        "message": "user not found",
                        "url": "http://addons.moosocial.com/api/photo/tagAlbumPhoto/5?uid=10000"
                      }

View single photo

View single photo
GETphoto/{photo_id}

Browse a photo

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int Photo id
Response  200
HideShow

A photo object

Parameter Type Example Description
canView boolean Current user can view this photo or not
viewMessage string Display message when user do not have permission to view
Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/{photo_id}"
                      }

Upload photo in a group

Upload photo in a group
POSTphoto/group/upload

Upload photo in a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
target_id int group id
photos object An array of Photo path which is uploaded by using the api :/file
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Please select photo",
                        "message": "Please select photo",
                        "url": "http://addons.moosocial.com/api/photo/group/upload"
                      }
Response  401
HideShow
{
                        "name": "This is a private group",
                        "message": "This is a private group",
                        "url": "http://addons.moosocial.com/api/photo/group/upload"
                      }
Response  404
HideShow
{
                        "name": "Group not found",
                        "message": "Group not found",
                        "url": "http://addons.moosocial.com/api/photo/group/upload"
                      }

Tag people to a Photo

Tag people to a Photo
POSTphoto/tag

Tag people to a Photo

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int Photo id
user_id int User id
value string Text value when tagged
style string

Position of tagged user .

Ex : left: 458px; top:400px

Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
id int Return tagged id when success
Response  400
HideShow
{
                        "name": "Duplicated tag!",
                        "message": "Duplicated tag!",
                        "url": "http://addons.moosocial.com/api/photo/tag"
                      }
Response  404
HideShow
{
                        "name": "Photo not found",
                        "message": "Photo not found",
                        "url": "http://addons.moosocial.com/api/photo/tag"
                      }
{
                        "name": "User not found",
                        "message": "User not found",
                        "url": "http://addons.moosocial.com/api/photo/tag"
                      }

Remove tag people to a Photo

Remove tag people to a Photo
POSTphoto/removetag

Remove tag from a photo

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
tag_id int Tagged id
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow
{
                        "name": "Not tagged yet.",
                        "message": "Not tagged yet.",
                        "url": "http://addons.moosocial.com/api/photo/removetag"
                      }

Set Profile Cover Photo

Set Profile Cover Photo
POSTphoto/setcover

Set Profile Cover Photo

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int Photo id
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow
{
                        "name": "Photo not found",
                        "message": "Photo not found",
                        "url": "http://addons.moosocial.com/api/photo/setcover"
                      }

Set photo as profile picture

Set photo as profile picture
POSTphoto/setprofilepicture

Set photo as profile picture

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int Photo id
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  404
HideShow
{
                        "name": "Photo not found",
                        "message": "Photo not found",
                        "url": "http://addons.moosocial.com/api/photo/setprofilepicture"
                      }

Update Photo Caption

Update Photo Caption

Update Photo Caption
GET/photo/updatecaption

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int photo id
caption string Caption of photo
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/photo/updatecaption"
                      }
Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/updatecaption"
                      }

Update Photo Caption
PUT/photo/updatecaption

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int photo id
caption string Caption of photo
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/photo/updatecaption"
                      }
Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/updatecaption"
                      }

Delete photo

Delete photo

Delete photo
POST/photo/delete/{photo_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int photo id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/photo/delete/2"
                      }
Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/delete/20000"
                      }

Delete photo
DELETE/photo/{photo_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
photo_id int photo id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/photo/2"
                      }
Response  404
HideShow
{
                        "name": "photo not found",
                        "message": "photo not found",
                        "url": "http://addons.moosocial.com/api/photo/20000"
                      }

Save album photo

Save album photo
POSTphoto/album/save

Save album photo

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
type string REQUIRED Photo type
target_id int REQUIRED Id of album
photos string REQUIRED A list of photo url, separated by comma by using file/album
Response  200
HideShow
Parameter Type Example Description
success boolean Return TRUE when success
Response  400
HideShow
{
                        "name": "Missing parameter : Album cound not be found",
                        "message": "Missing parameter : Album cound not be found",
                        "url": "http://addons.moosocial.com/api/album/save"
                      }
Response  401
HideShow
{
                        "name": "Missing parameter : Type is REQUIRED",
                        "message": "Missing parameter : Type is REQUIRED",
                        "url": "http://addons.moosocial.com/api/album/save"
                      }
{
                        "name": "Target id is REQUIRED",
                        "message": "Target id is REQUIRED",
                        "url": "http://addons.moosocial.com/api/album/save"
                      }
{
                        "name": "Missing parameter : Photos is REQUIRED",
                        "message": "Missing parameter : Photos is REQUIRED",
                        "url": "http://addons.moosocial.com/api/album/save"
                      }

Group

All action related to group plugin

Group Object

Parameter Type Example Description
id int group id
name string group name
description string group description
thumbnail array An array of group thumbnail .
 {
                         http://addons.moosocial.com/uploads/groups/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/groups/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
url string group url
memberCount int Number of member in this group
privacy int 1 The privacy settings of the post.

												{
													description     :  Number that describes the privacy settings, as they would appear on mooSocial
													value     :  The actual privacy setting. enum{PUBLIC  = 1 , RESTRICTED  = 2 , PRIVATE  = 3}
												}
												
published datetime Group created datetime.
publishedTranslated datetime Group created datetime with translation.

Get All group

Get all group
GETgroup/all

Get an array of all groups

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of group object

Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/all"
                      }

Get My group

Get my group
GETgroup/my

Get an array of my groups

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of group object

Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/my"
                      }

Get Friends group

Get friends group
GETgroup/friends

Get an array of friends groups

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of group object

Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/friends"
                      }

Get Featured Group

Get featured group
GETgroup/featured

Get feature group

Permission

It's required a user access token. How to use

Response  200
HideShow

An array of group object

Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/featured"
                      }

Get group that current user joned

Get group that current user joned
GETgroup/join

Get group that current user joned

Permission

It's required a user access token. How to use

Response  200
HideShow

An array of group object

Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/join"
                      }

Browse group from a category

Browse group from a category
GETgroup/category/{category_id}

Get group from a category

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
category_id int category id
Response  200
HideShow

An array of group object

Response  404
HideShow
{
							"name": "group not found",
							"message": "group not found",
							"url": "http://addons.moosocial.com/api/group/category/5"
						  }

Browse group member

Browse group member
GETgroup/member/{group_id}

Browse group member

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow
Parameter Type Example Description
id int User id
name int User name
avatar object The list of person's image path of this person's avatar .
profile_url link Link to profile of user
Response  400
HideShow
{
									"name": "This is private group. Only group members can view",
									"message": "This is private group. Only group members can view",
									"url": "http://addons.moosocial.com/api/group/member/5"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/member/5"
								  }
{
									"name": "Group member not found",
									"message": "Group member not found",
									"url": "http://addons.moosocial.com/api/group/member/200"
								  }

Browse group activity

Browse group activity
GETgroup/activity/{group_id}

Browse group activity

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow

An array of activity feed

Response  400
HideShow
{
									"name": "This is private group. Only group activitys can view",
									"message": "This is private group. Only group activitys can view",
									"url": "http://addons.moosocial.com/api/group/activity/5"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/activity/5"
								  }
{
									"name": "There are no new feeds to view at this time.",
									"message": "There are no new feeds to view at this time.",
									"url": "http://addons.moosocial.com/api/group/activity/200"
								  }

Browse group admin

Browse group admin
GETgroup/admin/{group_id}

Browse group admin

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow
Parameter Type Example Description
id int User id
name int User name
avatar object The list of person's image path of this person's avatar .
profile_url link Link to profile of user
Response  400
HideShow
{
									"name": "This is private group. Only group admins can view",
									"message": "This is private group. Only group admins can view",
									"url": "http://addons.moosocial.com/api/group/admin/5"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/admin/5"
								  }

Get group detail by id

Get group detail by id
GETgroup/{group_id}

Get group detail by id

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow
Parameter Type Example Description
id int group id
name string group name
published datetime Group created datetime.
publishedTranslated datetime Group created datetime with translation.
description string group description
thumbnail string An array of group thumbnail .
 {
                         http://addons.moosocial.com/uploads/groups/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/groups/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/groups/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
featured boolean Return TRUE when group is featured , FALSE when not feature .
groupUserCount int Total member of this group
categoryId int Group category id
categoryName string Group category name
privacy int 1 The privacy settings of the post.

												{
													description     :  Number that describes the privacy settings, as they would appear on mooSocial
													value     :  The actual privacy setting. enum{PUBLIC  = 1 , RESTRICTED  = 2 , PRIVATE  = 3}
												}
												
joinRequest int Total join request count
photoCount int Total photo of group count
topicCount int Total topic of group count
videoCount int Total video of group count
userCreateId int Group create user id
userCreateName string Group create user name
shareAction string Action type when share detail of Group (group_item_detail)
type string Type of group (Group_Group)
Response  400
HideShow
{
									"name": "This is private group. Only group admins can view",
									"message": "This is private group. Only group admins can view",
									"url": "http://addons.moosocial.com/api/group/5"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/5"
								  }

Leave group

Leave group
GETgroup/leave/{group_id}

Leave group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
									"name": "You are group admin so can not leave this group.",
									"message": "You are group admin so can not leave this group.",
									"url": "http://addons.moosocial.com/api/group/leave/5"
								  }
Response  404
HideShow
{
									"name": "You not in this group.",
									"message": "You not in this group.",
									"url": "http://addons.moosocial.com/api/group/leave/5"
								  }
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/leave/200"
								  }

Feature group

Feature group
GETgroup/feature/{group_id}

Feature group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
									"name": "Only admin can feature group.",
									"message": "Only admin can feature group.",
									"url": "http://addons.moosocial.com/api/group/feature/5"
								  }
{
									"name": "You are not allowed feature private group.",
									"message": "You are not allowed feature private group.",
									"url": "http://addons.moosocial.com/api/group/feature/5"
								  }
{
									"name": "Group featured already.",
									"message": "Group featured already.",
									"url": "http://addons.moosocial.com/api/group/feature/5"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/feature/200"
								  }

Unfeature group

Unfeature group
GETgroup/unfeature/{group_id}

Unfeature group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int Group id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
									"name": "Only admin can unfeature group.",
									"message": "Only admin can unfeature group.",
									"url": "http://addons.moosocial.com/api/group/unfeature/5"
								  }
{
									"name": "You are not allowed unfeature private group.",
									"message": "You are not allowed unfeature private group.",
									"url": "http://addons.moosocial.com/api/group/unfeature/5"
								  }
{
									"name": "Group unfeatured already.",
									"message": "Group unfeatured already.",
									"url": "http://addons.moosocial.com/api/group/unfeature/5"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/unfeature/200"
								  }

Send request to join a group

Send request to join a group
GETgroup/join/request/{group_id}

Send request to join a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int Group id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
									"name": "Already joined..",
									"message": "Already joined..",
									"url": "http://addons.moosocial.com/api/group/join/request/5"
								  }
{
									"name": "This is a private group. You must be invited by a group admin in order to join",
									"message": "This is a private group. You must be invited by a group admin in order to join",
									"url": "http://addons.moosocial.com/api/group/join/request/5"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/join/request/200"
								  }

Browse all join request from a group

Browse all join request from a group
GETgroup/join/request/{group_id}

Browse all join request from a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int Group id
Response  200
HideShow
Parameter Type Example Description
id int User id
name string User name
avatar object The list of person's image path of this person's avatar .
profile_url link Link to profile of user
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/join/request/200"
								  }
{
									"name": "Group request not found",
									"message": "Group request not found",
									"url": "http://addons.moosocial.com/api/group/join/request/200"
								  }

Accept join request

Accept join request
GETgroup/join/accept/{request_id}

Accept join request

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
request_id int Group request id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
									"name": "Joined already.",
									"message": "Joined already.",
									"url": "http://addons.moosocial.com/api/group/join/accept/5"
								  }
Response  404
HideShow
{
									"name": "Group request not found",
									"message": "Group request not found",
									"url": "http://addons.moosocial.com/api/group/join/accept/200"
								  }

Turn group notification on

Turn group notification on
GETgroup/notification/on/{group_id}

Turn group notification on

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int Group id
Response  200
HideShow
Parameter Type Example Description
message string Return message when success
Response  400
HideShow
{
									"name": "This is private group. Only group members can view",
									"message": "This is private group. Only group members can view",
									"url": "http://addons.moosocial.com/api/group/notification/on/5"
								  }
{
									"name": "Group notification on already",
									"message": "Group notification on already",
									"url": "http://addons.moosocial.com/api/group/notification/on/200"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/notification/on/200"
								  }

Turn group notificatioff off

Turn group notificatioff off
GETgroup/notificatioff/off/{group_id}

Turn group notificatioff off

Permissioff

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Descriptioff
group_id int Group id
Response  200
HideShow
Parameter Type Example Descriptioff
message string Return message when success
Response  400
HideShow
{
									"name": "This is private group. Only group members can view",
									"message": "This is private group. Only group members can view",
									"url": "http://addons.moosocial.com/api/group/notificatioff/off/5"
								  }
{
									"name": "Group notification off already",
									"message": "Group notification off already",
									"url": "http://addons.moosocial.com/api/group/notificatioff/off/200"
								  }
Response  404
HideShow
{
									"name": "Group not found",
									"message": "Group not found",
									"url": "http://addons.moosocial.com/api/group/notificatioff/off/200"
								  }

Filter group

Filter group
POSTgroup/filter

Filter group by keyword

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
keyword string Keyword to search
page int Page number
Response  200
HideShow

An array of group object

Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/filter"
                      }

Invite friend to a group

Invite friend to a group
POSTgroup/invite

Invite friend to a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
emails string

Invite by email . Enter their emails below (separated by commas)

Limit 10 email addresses per request

friends string

Invite by user id . Enter their id (separated by commas)

group_id int

Group id

Response  200
HideShow
Parameter Type Example Description
meesage string

Return message when success

Response  400
HideShow
{
                        "name": "Please insert friend id  or email to invite .",
                        "message": "Please insert friend id  or email to invite .",
                        "url": "http://addons.moosocial.com/api/group/invite"
                      }
{
                        "name": "This is private group. Only group members can view",
                        "message": "This is private group. Only group members can view",
                        "url": "http://addons.moosocial.com/api/group/invite"
                      }
Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/filter"
                      }
{
                        "name": "You not in this group.",
                        "message": "You not in this group.",
                        "url": "http://addons.moosocial.com/api/group/filter"
                      }

Create group

Create group
POSTgroup/create

Create a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
name string REQUIRED | Group name
description string REQUIRED | Group description
photo file Thumbnail of group , is the path which is uploaded by using the api /file
category_id int

REQUIRED | Category Id

type int The privacy settings of group

                                        {

                                        PUBLIC     :  1
                                        RESTRICTED     :  2
                                        PRIVATE     :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "Group category is missing.",
                        "message": "Group category is missing.",
                        "url": "http://addons.moosocial.com/api/group/create"
                      }
{
                        "name": "Group name is missing.",
                        "message": "Group name is missing.",
                        "url": "http://addons.moosocial.com/api/group/create"
                      }
{
                        "name": "Group description  is missing.",
                        "message": "Group description  is missing.",
                        "url": "http://addons.moosocial.com/api/group/create"
                      }

Edit group

Edit group
POSTgroup/edit

Edit a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id string REQUIRED | Group id
name string REQUIRED | Group name
description string REQUIRED | Group description
photo file Thumbnail of group , is the path which is uploaded by using the api /file
category_id int

REQUIRED | Category Id

type int The privacy settings of group

                                        {

                                        PUBLIC     :  1
                                        RESTRICTED     :  2
                                        PRIVATE     :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "Group category is missing.",
                        "message": "Group category is missing.",
                        "url": "http://addons.moosocial.com/api/group/edit"
                      }
{
                        "name": "Group name is missing.",
                        "message": "Group name is missing.",
                        "url": "http://addons.moosocial.com/api/group/edit"
                      }
{
                        "name": "Group description  is missing.",
                        "message": "Group description  is missing.",
                        "url": "http://addons.moosocial.com/api/group/edit"
                      }
Response  404
HideShow
{
                       "name": "Group not found",
                        "message": "Group not found",
                        "url": "http://addons.moosocial.com/api/group/edit"
                    }

Edit group
PUTgroup/{group_id}

Edit a group

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int REQUIRED | Group id
name string REQUIRED | Group name
description string REQUIRED | Group description
photo file Thumbnail of group , is the path which is uploaded by using the api /file
category_id int

REQUIRED | Category Id

type int The privacy settings of group

                                        {

                                        PUBLIC     :  1
                                        RESTRICTED     :  2
                                        PRIVATE     :  3

                                        }
                                        
Response  200
HideShow
{
                        "success": true,
						"id": 10,
                        }
Response  400
HideShow
{
                        "name": "Group category is missing.",
                        "message": "Group category is missing.",
                        "url": "http://addons.moosocial.com/api/group/12"
                      }
{
                        "name": "Group name is missing.",
                        "message": "Group name is missing.",
                        "url": "http://addons.moosocial.com/api/group/11"
                      }
{
                        "name": "Group description  is missing.",
                        "message": "Group description  is missing.",
                        "url": "http://addons.moosocial.com/api/group/11"
                      }
Response  404
HideShow
{
                       "name": "Group not found",
                        "message": "Group not found",
                        "url": "http://addons.moosocial.com/api/group/edit"
                    }

Delete join request from a group

Delete join request from a group

Delete join request from a group
POST/group/join/delete/{request_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
request_id int Join request id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/join/group/delete/2"
                      }
Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/join/delete/20000"
                      }

Delete group
DELETE/group/join/{request_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
request_id int Join request id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/group/join/2"
                      }
Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/join/20000"
                      }

Delete group

Delete group

Delete group
POST/group/delete/{group_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/group/delete/2"
                      }
Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/delete/20000"
                      }

Delete group
DELETE/group/{group_id}

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
group_id int group id
Response  200
HideShow
{
                        "success": true,
                        }
Response  401
HideShow
{
                        "name": "Access denied",
                        "message": "Access denied",
                        "url": "http://addons.moosocial.com/api/group/2"
                      }
Response  404
HideShow
{
                        "name": "group not found",
                        "message": "group not found",
                        "url": "http://addons.moosocial.com/api/group/20000"
                      }

event

All action related to event plugin

event Object

Parameter Type Example Description
id int event id
eventDate datetime Event created date
title string event title
thumbnail string A array of event thumbnail .
 {
                         http://addons.moosocial.com/uploads/events/thumbnail/6/150_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/events/thumbnail/6/250_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/events/thumbnail/6/450_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/events/thumbnail/6/850_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                       http://addons.moosocial.com/uploads/events/thumbnail/6/1500_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/events/thumbnail/6/75_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg

                        http://addons.moosocial.com/uploads/events/thumbnail/6/300_square_f75d2b51a5ddceb130c3d52ca27f692b.jpg
                        }
                                        
totalAttending int Total user attending this event
privacy int 1 The privacy settings of the post.

                                        {
                                            description     :  Number that describes the privacy settings, as they would appear on mooSocial
                                            value     :  The actual privacy setting. enum{EVERYONE = 1 , ALL_FRIENDS = 2 , SELF = 3}
                                        }
                                        
fromTime datetime Time event start
fromTimeFormat datetime Time event start has been shortened
toTime datetime Time event end
toTimeFormat datetime Time event end has been shortened
location string Event location
address string Event address
url string Event url

Get upcoming event

Get upcoming event
GETevent/upcoming

Get an array of upcoming events

Permission

It's required a user access token. How to use

Fields
HideShow
Parameter Type Example Description
page int Page number
Response  200
HideShow

An array of event object

Response  404
HideShow
{
                        "name": "event not found",
                        "message