SocialEngine 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.
Below are the characteristics of the SocialEngineAddOns REST API:
-
When a request is sent to the REST API server, the server will return a response that contains either the data you requested, or the status code, or both.
-
oauth_consumer_key / oauth_consumer_secret? The
Consumer Key
andConsumer Secret Key
are used to make a connection between API client and server. These keys are also used for creatingOAuth Tokens
for site members to access server resources without sharing their credentials.
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
- oauth_token / oauth_secret? The
OAuth Token
andOAuth Secret
are used for identifying site members.
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Base URL
All requests to this REST API should have the base URL: [https://example.com/api/rest/]
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.
Supported Features
Official SocialEngine Plugins
-
Blogs Plugin
-
Photo Albums Plugin
-
Classifieds Plugin
-
Groups Plugin
-
Events Plugin
-
Forums Plugin
-
Polls Plugin
-
Video Sharing Plugin
-
Music Sharing Plugin
Core SocialEngine Features
-
Search
-
Member Links
-
Member Log-in
-
Member Sign-up With Profile Fields
-
Edit Member Profile Fields
-
Activity Feeds
-
Notifications
-
Friend Requests
-
Messages
-
Member Settings
-
Likes and Comments
-
Easy Implementation of Photo Lightbox.
-
Footer Menus
SocialEngineAddOns Plugins:
-
Advanced Activity Feeds / Wall Plugin
-
Geo-Location, Geo-Tagging, Check-Ins & Proximity Search Plugin [only for Advanced Activity Feed’s location features]
Groups / Communities Plugin ¶
List of all the API’s of Groups / Communities Plugin These are the APIs for the SocialEngineAddOns : Groups / Communities Plugin(https://www.socialengineaddons.com/socialengine-groups-communities-plugin).
Groups / Communities Browse ¶
Browse GroupsGET/advancedgroups/{?search}{&show}{&closed}{&orderby}{&page}{&limit}
Get the Advanced group listing. Groups can also be browsed and searched based on keywords, categories, etc.
In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of groups in response and use page for the page number. [i.e: If you have 100 groups and the first request has limit=20 and page=1, then in that case the recent 20 groups will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent groups will be returned.]
Example URI
- offer_type (optional, string, `offer_type
string
(required) Default: all`) ... gets listing of groups which have (`offer_type=All Offers`) , gets all hot offers (`offer_type=Hot Offers`) , gets Featured offers (`offer_type=Featured Offers`) or you can leave it empty which will have no effect of this field on searching .- search
string
(optional) Example: search=mobilestring to be matched with groups’ names.
- sitegroup_location (optional, string,`sitegroup_location
string
(required) Default: india`)string to be matched with group’s location.
- sitegroup_street (optional, string,`sitegroup_street
string
(required) Default: iffco`)string to be matched with groups’s street from location.
- sitegroup_city (optional, string,`sitegroup_city
string
(required) Default: gurgaon`)string to be matched with group’s city name evaluated from location.
- sitegroup_state (optional,string,`sitegroup_state
string
(required) Default: new delhi`)string to be matched with group’s state name evaluated from location.
- sitegroup_country (optional,string,`sitegroup_country
string
(required) Default: india`)string to be matched with group’s country name evaluated from location.
- show
int
(optional) Example: show=1gets listing of groups with options
show=Everyone\'s Groups
which show every user groups ,show=Only My Friends\' Groups
which shows groups owned by members present in your friend list ,show=Groups I Like
shows groups which the current user has liked ,show=Featured Groups
shows groups which have featured marked on them.- closed
int
(optional) Example: closed=1shows groups listing which are (
closed=closed
) or (closed=open
) or (closed=both
) .- orderby
string
(optional) Example: orderby=Most Recentorderby field shows groups considering some stats and the stats include
orderby=Most Recent
shows groups in descending order date with current date as maximum ,orderby=Most Viewed
shows the groups with view count in descending order,orderby=Most Commented
shows groups in the order of comments in descending order ,orderby=Most Liked
shows groups in the order of likes count in descending order , ‘orderby=Alphabetical’ shows groups in the alphabetical order of group titles,orderby=Most Reviewed
, the groups with the maximum review count will be shown first ,orderby=Most Rated
shows groups in the order of rating.- category_id (optional,int,category_id
string
(required) Default: 1)shows groups of a certain category .
- page
string
(required)gets the listings with the page number and the limit eg,
page=1
will show listings from 1 to limit depending on order by.- limit
string
(required)gets the listings with limit per page eg.
limit=10
will show 10 listing groups per page
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Body
{
"status_code": 200,
"body": {
"canCreate": 1,
"totalItemCount": 2,
"response": [
{
"group_id": 5,
"title": "Friends",
"page_url": "friends",
"body": "Group of my pals",
"overview": null,
"owner_id": 1,
"package_id": 1,
"category_id": 1,
"profile_type": 4,
"photo_id": 62,
"price": 0,
"location": "California",
"creation_date": "2016-04-26 11:33:30",
"modified_date": "2016-04-26 11:33:30",
"approved": 0,
"featured": 0,
"sponsored": 0,
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"review_count": 0,
"foursquare_text": null,
"search": 1,
"closed": 0,
"declined": 0,
"pending": 1,
"aprrove_date": null,
"draft": 1,
"subcategory_id": 0,
"userclaim": 1,
"offer": 0,
"email": "",
"website": "",
"phone": "",
"status": "initial",
"all_post": 1,
"payment_date": null,
"expiration_date": null,
"notes": null,
"gateway_id": null,
"gateway_profile_id": null,
"networks_privacy": null,
"subsubcategory_id": 0,
"subpage": 0,
"parent_id": 0,
"member_title": "",
"page_cover": 0,
"follow_count": 0,
"fbpage_url": null,
"badge_id": 0,
"member_invite": 1,
"member_approval": 1,
"member_count": 1,
"rating": 0,
"category_title": "Fashion",
"image": "http://example.com/seapi/public/siteevent_event/3e/003e_d126.png?c=b212",
"image_normal": "http://example.com/seapi/public/siteevent_event/40/0040_fd80.png?c=b631",
"image_profile": "http://example.com/seapi/public/siteevent_event/3f/003f_ba0f.png?c=6b8f",
"image_icon": "http://example.com/seapi/public/siteevent_event/41/0041_9754.png?c=ceb1",
"content_url": "http://example.com/seapi/pageitem/selling-my",
"owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Martina",
"owner_url": "http://example.com/seapi/profile/martina",
"allow_to_view": 1,
"edit": 1,
"delete": 1
},
{
"group_id": 4,
"title": "Recruitment Drive",
"page_url": "drive",
"body": "<p dir=\"ltr\">Recruitment drive to hire deserving candidates </p> ",
"overview": null,
"owner_id": 1,
"package_id": 1,
"category_id": 1,
"profile_type": 4,
"photo_id": 58,
"price": 0,
"location": null,
"creation_date": "2016-04-26 11:26:01",
"modified_date": "2016-04-26 11:26:02",
"approved": 0,
"featured": 0,
"sponsored": 0,
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"review_count": 0,
"foursquare_text": null,
"search": 1,
"closed": 0,
"declined": 0,
"pending": 1,
"aprrove_date": null,
"draft": 1,
"subcategory_id": 0,
"userclaim": 1,
"offer": 0,
"email": "",
"website": "",
"phone": "",
"status": "initial",
"all_post": 1,
"payment_date": null,
"expiration_date": null,
"notes": null,
"gateway_id": null,
"gateway_profile_id": null,
"networks_privacy": null,
"subsubcategory_id": 0,
"subpage": 0,
"parent_id": 0,
"member_title": "",
"page_cover": 0,
"follow_count": 0,
"fbpage_url": null,
"badge_id": 0,
"member_invite": 1,
"member_approval": 1,
"member_count": 1,
"rating": 0,
"category_title": "Jobs",
"image": "http://example.com/seapi/public/siteevent_event/3a/003a_d126.png?c=b212",
"image_normal": "http://example.com/seapi/public/siteevent_event/3c/003c_fd80.png?c=b631",
"image_profile": "http://example.com/seapi/public/siteevent_event/3b/003b_ba0f.png?c=6b8f",
"image_icon": "http://example.com/seapi/public/siteevent_event/3d/003d_9754.png?c=ceb1",
"content_url": "http://example.com/seapi/pageitem/selling-my-galaxy-s",
"owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Martina",
"owner_url": "http://example.com/seapi/profile/martina",
"allow_to_view": 1,
"edit": 1,
"delete": 1
}
]
}
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
Groups / Communities Manage Groups ¶
Manage GroupsGET/advancedgroups/manage/{&search}{&show}{&closed}{&orderby}{&category}{&page}{&limit}
Get the Manage Groups / Communities listing. Groups can also be browsed and searched based on keywords, categories, etc.
In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of groups in response and use page for the page number. [i.e: If you have 100 groups and the first request has limit=20 and page=1, then in that case the recent 20 groups will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent groups will be returned.]
Example URI
- offer_type (optional, string, `offer_type
string
(required) Default: all`) ... gets listing of groups which have (`offer_type=All Offers`) , gets all hot offers (`offer_type=Hot Offers`) , gets Featured offers (`offer_type=Featured Offers`) or you can leave it empty which will have no effect of this field on searching .- search
string
(optional) Example: search=mobilestring to be matched with groups’ names.
- sitegroup_location (optional, string,`sitegroup_location
string
(required) Default: india`)string to be matched with group’s location.
- sitegroup_street (optional, string,`sitegroup_street
string
(required) Default: iffco`)string to be matched with groups’s street from location.
- sitegroup_city (optional, string,`sitegroup_city
string
(required) Default: gurgaon`)string to be matched with group’s city name evaluated from location.
- sitegroup_state (optional,string,`sitegroup_state
string
(required) Default: new delhi`)string to be matched with group’s state name evaluated from location.
- sitegroup_country (optional,string,`sitegroup_country
string
(required) Default: india`)string to be matched with group’s country name evaluated from location.
- show
int
(optional) Example: show=1gets listing of groups with options
show=Everyone\'s Groups
which show every user groups ,show=Only My Friends\' Groups
which shows groups owned by members present in your friend list ,show=Groups I Like
shows groups which the current user has liked ,show=Featured Groups
shows groups which have featured marked on them.- closed
int
(optional) Example: closed=1shows groups listing which are (
closed=closed
) or (closed=open
) or (closed=both
) .- orderby
string
(optional) Example: orderby=Most Recentorderby field shows groups considering some stats and the stats include
orderby=Most Recent
shows groups in descending order date with current date as maximum ,orderby=Most Viewed
shows the groups with view count in descending order,orderby=Most Commented
shows groups in the order of comments in descending order ,orderby=Most Liked
shows groups in the order of likes count in descending order , ‘orderby=Alphabetical’ shows groups in the alphabetical order of group titles,orderby=Most Reviewed
, the groups with the maximum review count will be shown first ,orderby=Most Rated
shows groups in the order of rating.- category
string
(required)shows groups of a certain category .
- page
string
(required)gets the listings with the page number and the limit eg,
page=1
will show listings from 1 to limit depending on order by.- limit
string
(required)gets the listings with limit per page eg.
limit=10
will show 10 listing groups per page
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
200
Body
{
"status_code": 200,
"body": {
"canCreate": 1,
"totalItemCount": 2,
"response": [
{
"group_id": 5,
"title": "Friends",
"page_url": "friends",
"body": "Group of my pals",
"overview": null,
"owner_id": 1,
"package_id": 1,
"category_id": 1,
"profile_type": 4,
"photo_id": 62,
"price": 0,
"location": "California",
"creation_date": "2016-04-26 11:33:30",
"modified_date": "2016-04-26 11:33:30",
"approved": 0,
"featured": 0,
"sponsored": 0,
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"review_count": 0,
"foursquare_text": null,
"search": 1,
"closed": 0,
"declined": 0,
"pending": 1,
"aprrove_date": null,
"draft": 1,
"subcategory_id": 0,
"userclaim": 1,
"offer": 0,
"email": "",
"website": "",
"phone": "",
"status": "initial",
"all_post": 1,
"payment_date": null,
"expiration_date": null,
"notes": null,
"gateway_id": null,
"gateway_profile_id": null,
"networks_privacy": null,
"subsubcategory_id": 0,
"subpage": 0,
"parent_id": 0,
"member_title": "",
"page_cover": 0,
"follow_count": 0,
"fbpage_url": null,
"badge_id": 0,
"member_invite": 1,
"member_approval": 1,
"member_count": 1,
"rating": 0,
"category_title": "Social",
"image": "http://example.com/seapi/public/siteevent_event/3e/003e_d126.png?c=b212",
"image_normal": "http://example.com/seapi/public/siteevent_event/40/0040_fd80.png?c=b631",
"image_profile": "http://example.com/seapi/public/siteevent_event/3f/003f_ba0f.png?c=6b8f",
"image_icon": "http://example.com/seapi/public/siteevent_event/41/0041_9754.png?c=ceb1",
"content_url": "http://example.com/seapi/pageitem/selling-my",
"owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Martina",
"owner_url": "http://example.com/seapi/profile/martina",
"allow_to_view": 1,
"edit": 1,
"delete": 1,
"menu": [
{
"name": "edit",
"label": "Edit Group Details",
"url": "advancedgroup/edit/5"
},
{
"name": "close",
"label": "Close Group",
"url": "advancedgroup/close/5"
},
{
"name": "delete",
"label": "Delete Group",
"url": "advancedgroup/delete/5"
}
],
},
{
"group_id": 4,
"title": "Recruitment Drive",
"page_url": "drive",
"body": "<p dir=\"ltr\">Recruitment drive to hire deserving candidates </p> ",
"overview": null,
"owner_id": 1,
"package_id": 1,
"category_id": 1,
"profile_type": 4,
"photo_id": 58,
"price": 0,
"location": null,
"creation_date": "2016-04-26 11:26:01",
"modified_date": "2016-04-26 11:26:02",
"approved": 0,
"featured": 0,
"sponsored": 0,
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"review_count": 0,
"foursquare_text": null,
"search": 1,
"closed": 0,
"declined": 0,
"pending": 1,
"aprrove_date": null,
"draft": 1,
"subcategory_id": 0,
"userclaim": 1,
"offer": 0,
"email": "",
"website": "",
"phone": "",
"status": "initial",
"all_post": 1,
"payment_date": null,
"expiration_date": null,
"notes": null,
"gateway_id": null,
"gateway_profile_id": null,
"networks_privacy": null,
"subsubcategory_id": 0,
"subpage": 0,
"parent_id": 0,
"member_title": "",
"page_cover": 0,
"follow_count": 0,
"fbpage_url": null,
"badge_id": 0,
"member_invite": 1,
"member_approval": 1,
"member_count": 1,
"rating": 0,
"category_title": "Jobs",
"image": "http://example.com/seapi/public/siteevent_event/3a/003a_d126.png?c=b212",
"image_normal": "http://example.com/seapi/public/siteevent_event/3c/003c_fd80.png?c=b631",
"image_profile": "http://example.com/seapi/public/siteevent_event/3b/003b_ba0f.png?c=6b8f",
"image_icon": "http://example.com/seapi/public/siteevent_event/3d/003d_9754.png?c=ceb1",
"content_url": "http://example.com/seapi/pageitem/selling-my-galaxy-s",
"owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "raj",
"owner_url": "http://example.com/seapi/profile/raj",
"allow_to_view": 1,
"edit": 1,
"delete": 1,
"menu": [
{
"name": "edit",
"label": "Edit Group Details",
"url": "advancedgroup/edit/5"
},
{
"name": "close",
"label": "Close Group",
"url": "advancedgroup/close/5"
},
{
"name": "delete",
"label": "Delete Group",
"url": "advancedgroup/delete/5"
}
],
}
]
}
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Groups / Communities Create ¶
Get Create FormGET/advancedgroups/create
Returns the create Groups / Communities create form
Example URI
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Body
{
"status_code": 200,
"body": {
"form": [
{
"type": "Text",
"name": "title",
"label": "Title",
"hasValidator": true
},
{
"type": "Text",
"name": "page_url",
"label": "URL",
"hasValidator": true
},
{
"type": "Text",
"name": "location",
"description": "Eg: Fairview Park, Berkeley, CA",
"label": "Enter a location"
},
{
"type": "Select",
"name": "category_id",
"label": "Category",
"multiOptions": {
"1": "Automobile",
"6": "Jobs",
"12": "Movies - TV",
"17": "Fashion",
"23": "Real Estate",
"29": "Sports",
"34": "Travel",
"39": "Electronics",
"46": "Places"
},
"hasValidator": "true"
},
{
"type": "Text",
"name": "tags",
"label": "Tags (Keywords)",
"description": "Separate tags with commas."
},
{
"type": "File",
"name": "photo",
"label": "Main Photo"
},
{
"type": "Text",
"name": "price",
"label": "Price (US Dollar)"
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this Page?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Sitegroup Guests Only"
}
},
{
"type": "Select",
"name": "splcreate",
"label": "Poll Create Privacy",
"value": "member"
},
{
"type": "Select",
"name": "splcreate",
"label": "Poll Create Privacy",
"value": "member"
},
{
"type": "Select",
"name": "secreate",
"label": "Event Create Privacy",
"value": "member"
},
{
"type": "Select",
"name": "smcreate",
"label": "Music Create Privacy",
"value": "member"
},
{
"type": "Select",
"name": "auth_comment",
"label": "Comment Privacy",
"description": "Who may comment on this Page?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Sitegroup Guests Only"
},
"value": "everyone"
},
{
"type": "Select",
"name": "sdicreate",
"value": "member"
},
{
"type": "Select",
"name": "spcreate",
"label": "Photo Privacy",
"value": "member"
},
{
"type": "Select",
"name": "sdcreate",
"label": "Document Privacy",
"value": "member"
},
{
"type": "Checkbox",
"name": "search",
"label": "Show this Group on browse page and in various blocks.",
"value": 1
},
{
"label": "Create",
"type": "Submit",
"name": "submit"
}
],
"fields": {
"Default Type": [
{
"type": "Text",
"name": "1_1_40_field_40",
"label": "Specialties",
"description": ""
},
{
"type": "Text",
"name": "1_1_41_field_41",
"label": "Colors Available",
"description": ""
}
],
"Automobile": [
{
"type": "Text",
"name": "1_4_14_field_14",
"label": "Overall Length (mm)",
"description": ""
},
{
"type": "Text",
"name": "1_4_15_field_15",
"label": "Overall Width (mm)",
"description": ""
},
{
"type": "Text",
"name": "1_4_16_field_16",
"label": "Overall Height (mm)",
"description": ""
},
{
"type": "Text",
"name": "1_4_17_field_17",
"label": "Mileage Highway (km/liter)",
"description": ""
},
{
"type": "Text",
"name": "1_4_18_field_18",
"label": "Mileage City (km/liter)",
"description": ""
},
{
"type": "Text",
"name": "1_4_19_field_19",
"label": "Mileage Overall (km/liter)",
"description": ""
},
{
"type": "Text",
"name": "1_4_20_field_20",
"label": "Maximum Speed (kmph)",
"description": ""
},
{
"type": "Select",
"name": "1_4_21_field_21",
"label": "Wheel Type",
"description": "",
"multiOptions": {
"13": "Tube-less",
"14": "Normal"
}
}
],
"Jobs": [
{
"type": "Text",
"name": "1_5_37_field_37",
"label": "Designation",
"description": ""
},
{
"type": "Text",
"name": "1_5_38_field_38",
"label": "Salary",
"description": ""
}
],
"Movies - TV": [
{
"type": "Text",
"name": "1_6_39_field_39",
"label": "Duration (mins)",
"description": ""
},
{
"type": "Select",
"name": "1_6_35_field_35",
"label": "Genre",
"description": "",
"multiOptions": {
"17": "Action",
"18": "Comedy",
"19": "Crime",
"20": "Documentary",
"21": "Drama",
"22": "Family",
"23": "Foreign",
"24": "Horror",
"25": "Romance",
"26": "Sci-Fi",
"27": "Sports",
"28": "Suspense",
"29": "Teen",
"30": "War"
}
}
],
"Fashion": [
{
"type": "Text",
"name": "1_7_33_field_33",
"label": "Color",
"description": ""
},
{
"type": "Textarea",
"name": "1_7_34_field_34",
"label": "Care Instructions",
"description": ""
}
],
"Real Estate": [
{
"type": "Text",
"name": "1_8_30_field_30",
"label": "Unit Area",
"description": ""
},
{
"type": "Text",
"name": "1_8_31_field_31",
"label": "Basic Sale Price",
"description": ""
},
{
"type": "Textarea",
"name": "1_8_32_field_32",
"label": "Facilities",
"description": ""
}
],
"Sports": [
{
"type": "Text",
"name": "1_9_28_field_28",
"label": "Affiliation",
"description": ""
},
{
"type": "Text",
"name": "1_9_29_field_29",
"label": "Awards",
"description": ""
}
],
"Travel": [
{
"type": "Text",
"name": "1_10_27_field_27",
"label": "Specialty",
"description": ""
}
],
"Electronics": [
{
"type": "Text",
"name": "1_11_22_field_22",
"label": "Dimensions",
"description": ""
},
{
"type": "Text",
"name": "1_11_23_field_23",
"label": "Power",
"description": ""
},
{
"type": "Text",
"name": "1_11_24_field_24",
"label": "Colors Available",
"description": ""
}
],
"Places": [
{
"type": "Text",
"name": "1_12_25_field_25",
"label": "Opening Hours",
"description": ""
},
{
"type": "Select",
"name": "1_12_26_field_26",
"label": "Parking",
"description": "",
"multiOptions": {
"15": "Available",
"16": "Not-available"
}
}
]
},
"subCategories": {
"1": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"2": "Bikes",
"3": "Buses",
"4": "Cars",
"5": "Trucks"
}
}
},
"6": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"7": "Accounting",
"8": "Advertising",
"9": "Banking",
"10": "Engineering",
"11": "Law"
}
}
},
"12": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"13": "Movie",
"14": "Theater Show",
"15": "TV Channel",
"16": "TV Show"
}
}
},
"17": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"18": "Accessories",
"19": "Apparels",
"20": "Jewelery",
"21": "Shoes",
"22": "Watches"
}
}
},
"23": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"24": "Apartments",
"25": "Bungalows",
"26": "Commercial",
"27": "Penthouses",
"28": "Plots"
}
}
},
"29": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"30": "Athlete",
"31": "Coach",
"32": "League",
"33": "Team"
}
}
},
"34": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"35": "Destinations",
"36": "Guides",
"37": "Hotels",
"38": "Operators"
}
}
},
"39": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"40": "Air Conditioners",
"41": "Cameras",
"42": "Mobile Phones",
"43": "Music Players",
"44": "Refrigerators",
"45": "Televisions"
}
}
},
"46": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"47": "Restaurants",
"48": "Theatres",
"49": "Schools",
"50": "Hospitals",
"51": "Malls"
}
}
}
}
}
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Post Create FormPOST/advancedgroups/create
Add a Group / Community.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Happy world | The title of the group |
group_url |
yes | string | happiness | The user given group url |
location |
yes | string | Phoenix | The location taken from google location api suggestions |
category_id |
yes | int | 1 | Select category for Group |
subcategory_id |
no | int | 10 | Selected subcategory category for Group |
subsubcategory_id |
no | int | 21 | Selected subsubcategory category for Group |
tags |
no | string | database,mobile,data | Comma Separated string values relating to the subject of the Group |
photo |
no | file | image file | The front image of the Group |
price |
no | int | 112 | The price of the Item selling in this Group |
auth_view |
yes | string | “everyone” | Who can view the Group |
auth_comment |
yes | string | “everyone” | Who can comment the Group |
splcreate |
no | string | “everyone” | Privary setting for Poll creation in Group |
sspcreate |
no | string | “everyone” | Privary setting for Sub pages creation in Group |
secreate |
no | string | “everyone” | Privary setting for Event creation in Group |
smcreate |
no | string | “everyone” | Privary setting for Music creation in Group |
sdicreate |
no | string | “everyone” | Privary setting for Discussion creation in Group |
spcreate |
no | string | “everyone” | Privary setting for Photo creation in Group |
sdcreate |
no | string | “everyone” | Privary setting for Document creation in Group |
search |
no | int | 1 | Setting to show this page on search results |
draft |
no | int | 1 | Setting to keep this group on draft or not |
1_1_40_field_40 |
no | string | “The condition is good” | Specilities of the Group or the product |
1_4_14_field_14 |
no | int | 100 | overall length |
Example URI
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"title": "Please complete this field - it is required.",
"category_id": "Please complete this field - it is required."
}
}
204
Body
{
"status_code": 204
}
Groups / Communities Search ¶
Search FormGET/advancedgroups/search-form
Gets the Groups / Communities search form.
Example URI
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"status_code": 200,
"body": {
"form": [
{
"type": "Select",
"name": "offer_type",
"label": "Groups With Offers",
"multiOptions": {
"": "",
"all": "All Offers",
"hot": "Hot Offers",
"featured": "Featured Offers"
}
},
{
"type": "Text",
"name": "search",
"label": "Search Groups"
},
{
"type": "Text",
"name": "sitegroup_location",
"label": " Location "
},
{
"type": "Text",
"name": "sitegroup_street",
"label": "Street"
},
{
"type": "Text",
"name": "sitegroup_city",
"label": "City"
},
{
"type": "Text",
"name": "sitegroup_state",
"label": "State"
},
{
"type": "Text",
"name": "sitegroup_country",
"label": "Country"
},
{
"type": "Select",
"name": "show",
"label": "Show",
"multiOptions": {
"1": "Everyone's Groups",
"2": "Only My Friends' Groups",
"4": "Groups I Like",
"5": "Featured Groups"
}
},
{
"type": "Select",
"name": "closed",
"label": "Status",
"multiOptions": {
"0": "Only Open Groups",
"1": "Only Closed Groups",
"": "All Groups"
}
},
{
"type": "Select",
"name": "orderby",
"label": "Browse By",
"multiOptions": {
"": "",
"creation_date": "Most Recent",
"view_count": "Most Viewed",
"comment_count": "Most Commented",
"like_count": "Most Liked",
"title": "Alphabetical",
"review_count": "Most Reviewed",
"rating": "Most Rated"
}
},
{
"type": "Select",
"name": "category",
"label": "Category",
"multiOptions": {
"1": "Automobile",
"6": "Jobs",
"12": "Movies - TV",
"17": "Fashion",
"23": "Real Estate",
"29": "Sports",
"34": "Travel",
"39": "Electronics",
"46": "Places"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Search"
}
]
}
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
Group / Community Profile ¶
Group ProfileGET/advancedgroup/view/group_id
Gets the Particular Group / Community .
Example URI
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"viewer_id": 1,
"status_code": 200,
"body": {
"gutterMenu": [
{
"name":"edit",
"label":"Edit Group Details",
"url":"advancedgroup\/edit\/42"
},
{
"name":"share",
"label":"Share This Group",
"url":"activity\/share",
"urlParams":{
"type":"sitegroup_group",
"id":42
}
},
{
"name":"tellafriend",
"label":"Tell a friend",
"url":"advancedgroup\/tellafriend\/42"
},
{
"label":"Add People",
"name":"invite",
"url":"advancedgroups\/member\/invite-members\/42"
},
{
"name":"close",
"label":"Close Group",
"url":"advancedgroup\/close\/42"
},
{
"name":"delete",
"label":"Delete Group",
"url":"advancedgroup\/delete\/42"
},
{
"name":"report",
"label":"Report This Group",
"url":"report\/create\/subject\/sitegroup_group_42",
"urlParams":{
"type":"sitegroup_group",
"id":42
}
}
],
"profile_tabs":[
{
"totalItemCount":0,
"name":"update",
"label":"Updates"
},
{
"name":"information",
"label":"Info",
"url":"advancedgroup\/information\/42"
},
{
"totalItemCount":1,
"name":"photos",
"label":"Photos",
"url":"advancedgroups\/photos\/index\/42"
},
{
"totalItemCount":0,
"name":"reviews",
"label":"Reviews",
"url":"advancedgroups\/reviews\/42"
},
{
"totalItemCount":0,
"name":"videos",
"label":"Videos",
"url":"advancedgroups\/videos\/index\/42"
},
{
"totalItemCount":1,
"name":"members",
"label":"candidates",
"url":"advancedgroups\/members\/browse\/42"
}
]
"response": {
"group_id": 5,
"title": "Movies Loves",
"page_url": "movies",
"body": "Fan of movies",
"overview": null,
"owner_id": 1,
"package_id": 1,
"category_id": 1,
"profile_type": 4,
"photo_id": 62,
"price": 0,
"location": null,
"creation_date": "2016-04-26 11:33:30",
"modified_date": "2016-04-26 11:33:30",
"approved": 0,
"featured": 0,
"sponsored": 0,
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"review_count": 0,
"foursquare_text": null,
"search": 1,
"closed": 0,
"declined": 0,
"pending": 1,
"aprrove_date": null,
"draft": 1,
"subcategory_id": 0,
"userclaim": 1,
"offer": 0,
"email": "",
"website": "",
"phone": "",
"status": "initial",
"all_post": 1,
"payment_date": null,
"expiration_date": null,
"notes": null,
"gateway_id": null,
"gateway_profile_id": null,
"networks_privacy": null,
"subsubcategory_id": 0,
"subpage": 0,
"parent_id": 0,
"member_title": "",
"page_cover": 0,
"follow_count": 0,
"fbpage_url": null,
"badge_id": 0,
"member_invite": 1,
"member_approval": 1,
"member_count": 1,
"rating": 0,
"content_url": "http://example.com/seapi/pageitem/selling-my",
"image": "http://example.com/seapi/public/siteevent_event/3e/003e_d126.png?c=b212",
"image_normal": "http://example.com/seapi/public/siteevent_event/40/0040_fd80.png?c=b631",
"image_profile": "http://example.com/seapi/public/siteevent_event/3f/003f_ba0f.png?c=6b8f",
"image_icon": "http://example.com/seapi/public/siteevent_event/41/0041_9754.png?c=ceb1",
"owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Martina",
"is_like": false,
"tags": [],
"category_title": "Movies"
}
}
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
Groups / Communities Edit ¶
Get Group Edit FormGET/advancedgroup/edit/group_id
Returns the edit Group / Community form
Example URI
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": {
"form": [
{
"type": "Text",
"name": "title",
"label": "Title",
"hasValidator": true
},
{
"type": "Text",
"name": "page_url",
"label": "URL",
"hasValidator": true
},
{
"type": "Text",
"name": "location",
"description": "Eg: Fairview Park, Berkeley, CA",
"label": "Enter a location"
},
{
"type": "Select",
"name": "category_id",
"label": "Category",
"multiOptions": {
"1": "Automobile",
"6": "Jobs",
"12": "Movies - TV",
"17": "Fashion",
"23": "Real Estate",
"29": "Sports",
"34": "Travel",
"39": "Electronics",
"46": "Places"
},
"hasValidator": "true"
},
{
"type": "Text",
"name": "tags",
"label": "Tags (Keywords)",
"description": "Separate tags with commas."
},
{
"type": "File",
"name": "photo",
"label": "Main Photo"
},
{
"type": "Text",
"name": "price",
"label": "Price (US Dollar)"
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this Group?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Sitegroup Guests Only"
}
},
{
"type": "Select",
"name": "sspcreate",
"label": "Who may create sub groups in this group?",
"value": "member"
},
{
"type": "Select",
"name": "splcreate",
"label": "Poll Create Privacy",
"value": "member"
},
{
"type": "Select",
"name": "secreate",
"label": "Event Create Privacy",
"value": "member"
},
{
"type": "Select",
"name": "smcreate",
"label": "Music Create Privacy",
"value": "member"
},
{
"type": "Select",
"name": "auth_comment",
"label": "Comment Privacy",
"description": "Who may comment on this Group?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Groups Guests Only"
},
"value": "everyone"
},
{
"type": "Select",
"name": "sdicreate",
"label": "Discussion Topic Privacy",
"value": "member"
},
{
"type": "Select",
"name": "spcreate",
"label": "Photo Privacy",
"value": "member"
},
{
"type": "Select",
"name": "sdcreate",
"label": "Document Privacy",
"value": "member"
},
{
"type": "Checkbox",
"name": "search",
"label": "Show this Group on browse group and in various blocks.",
"value": 1
},
{
"label": "Create",
"type": "Submit",
"name": "submit"
}
],
"fields": {
"1": [
{
"type": "Text",
"name": "1_1_40_field_40",
"label": "Specialties",
"description": ""
},
{
"type": "Text",
"name": "1_1_41_field_41",
"label": "Colors Available",
"description": ""
}
],
"4": [
{
"type": "Text",
"name": "1_4_14_field_14",
"label": "Overall Length (mm)",
"description": ""
},
{
"type": "Text",
"name": "1_4_15_field_15",
"label": "Overall Width (mm)",
"description": ""
},
{
"type": "Text",
"name": "1_4_16_field_16",
"label": "Overall Height (mm)",
"description": ""
},
{
"type": "Text",
"name": "1_4_17_field_17",
"label": "Mileage Highway (km/liter)",
"description": ""
},
{
"type": "Text",
"name": "1_4_18_field_18",
"label": "Mileage City (km/liter)",
"description": ""
},
{
"type": "Text",
"name": "1_4_19_field_19",
"label": "Mileage Overall (km/liter)",
"description": ""
},
{
"type": "Text",
"name": "1_4_20_field_20",
"label": "Maximum Speed (kmph)",
"description": ""
},
{
"type": "Select",
"name": "1_4_21_field_21",
"label": "Wheel Type",
"description": "",
"multiOptions": {
"13": "Tube-less",
"14": "Normal"
}
}
],
"5": [
{
"type": "Text",
"name": "1_5_37_field_37",
"label": "Designation",
"description": ""
},
{
"type": "Text",
"name": "1_5_38_field_38",
"label": "Salary",
"description": ""
}
],
"6": [
{
"type": "Text",
"name": "1_6_39_field_39",
"label": "Duration (mins)",
"description": ""
},
{
"type": "Select",
"name": "1_6_35_field_35",
"label": "Genre",
"description": "",
"multiOptions": {
"17": "Action",
"18": "Comedy",
"19": "Crime",
"20": "Documentary",
"21": "Drama",
"22": "Family",
"23": "Foreign",
"24": "Horror",
"25": "Romance",
"26": "Sci-Fi",
"27": "Sports",
"28": "Suspense",
"29": "Teen",
"30": "War"
}
}
],
"7": [
{
"type": "Text",
"name": "1_7_33_field_33",
"label": "Color",
"description": ""
},
{
"type": "Textarea",
"name": "1_7_34_field_34",
"label": "Care Instructions",
"description": ""
}
],
"8": [
{
"type": "Text",
"name": "1_8_30_field_30",
"label": "Unit Area",
"description": ""
},
{
"type": "Text",
"name": "1_8_31_field_31",
"label": "Basic Sale Price",
"description": ""
},
{
"type": "Textarea",
"name": "1_8_32_field_32",
"label": "Facilities",
"description": ""
}
],
"9": [
{
"type": "Text",
"name": "1_9_28_field_28",
"label": "Affiliation",
"description": ""
},
{
"type": "Text",
"name": "1_9_29_field_29",
"label": "Awards",
"description": ""
}
],
"10": [
{
"type": "Text",
"name": "1_10_27_field_27",
"label": "Specialty",
"description": ""
}
],
"11": [
{
"type": "Text",
"name": "1_11_22_field_22",
"label": "Dimensions",
"description": ""
},
{
"type": "Text",
"name": "1_11_23_field_23",
"label": "Power",
"description": ""
},
{
"type": "Text",
"name": "1_11_24_field_24",
"label": "Colors Available",
"description": ""
}
],
"12": [
{
"type": "Text",
"name": "1_12_25_field_25",
"label": "Opening Hours",
"description": ""
},
{
"type": "Select",
"name": "1_12_26_field_26",
"label": "Parking",
"description": "",
"multiOptions": {
"15": "Available",
"16": "Not-available"
}
}
]
},
"subCategories": {
"1": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"2": "Bikes",
"3": "Buses",
"4": "Cars",
"5": "Trucks"
}
}
},
"6": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"7": "Accounting",
"8": "Advertising",
"9": "Banking",
"10": "Engineering",
"11": "Law"
}
}
},
"12": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"13": "Movie",
"14": "Theater Show",
"15": "TV Channel",
"16": "TV Show"
}
}
},
"17": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"18": "Accessories",
"19": "Apparels",
"20": "Jewelery",
"21": "Shoes",
"22": "Watches"
}
}
},
"23": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"24": "Apartments",
"25": "Bungalows",
"26": "Commercial",
"27": "Penthouses",
"28": "Plots"
}
}
},
"29": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"30": "Athlete",
"31": "Coach",
"32": "League",
"33": "Team"
}
}
},
"34": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"35": "Destinations",
"36": "Guides",
"37": "Hotels",
"38": "Operators"
}
}
},
"39": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"40": "Air Conditioners",
"41": "Cameras",
"42": "Mobile Phones",
"43": "Music Players",
"44": "Refrigerators",
"45": "Televisions"
}
}
},
"46": {
"form": {
"type": "Select",
"name": "subcategory_id",
"label": "Sub-Category",
"multiOptions": {
"47": "Restaurants",
"48": "Theatres",
"49": "Schools",
"50": "Hospitals",
"51": "Malls"
}
}
}
},
"formValues": {
"group_id": 1,
"title": "c++",
"group_url": "cpp",
"body": "this is a programming language which is used very widely",
"overview": "This is something i have been learning for a lot of time and hope u guys will also like it .",
"owner_id": 1,
"package_id": 1,
"category_id": 39,
"profile_type": 11,
"photo_id": 58,
"price": 0,
"location": "Gurgaon, Haryana, India",
"creation_date": "2016-04-05 07:49:32",
"modified_date": "2016-04-27 12:26:43",
"approved": 1,
"featured": 0,
"sponsored": 0,
"view_count": 5,
"comment_count": 0,
"like_count": 1,
"review_count": 2,
"foursquare_text": null,
"search": 1,
"closed": 0,
"declined": 0,
"pending": 0,
"aprrove_date": "2016-04-05 07:49:32",
"draft": 1,
"subcategory_id": 0,
"userclaim": 1,
"offer": 0,
"email": "",
"website": "",
"phone": "",
"status": "initial",
"all_post": 1,
"payment_date": null,
"expiration_date": "2250-01-01 00:00:00",
"notes": null,
"gateway_id": null,
"gateway_profile_id": null,
"networks_privacy": null,
"subsubcategory_id": 0,
"subgroup": 0,
"parent_id": 0,
"member_title": "",
"group_cover": 12,
"follow_count": 0,
"fbpage_url": null,
"badge_id": 0,
"member_invite": 1,
"member_approval": 1,
"member_count": 1,
"rating": 5
},
"field_values": {
"1": 11,
"22": "happy",
"23": "titanic",
"24": "Fault in our stars"
}
}
}
Post Group Edit FormPOST/advancedgroup/edit/group_id
Edit a Group.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Crazy movies | The title of the group |
group_url |
yes | string | movies | The user given group url |
location |
yes | string | Greece | The location taken from google location api suggestions |
category_id |
yes | int | 1 | Selected category for Groups |
subcategory_id |
no | int | 10 | Selected subcategory category for Groups |
subsubcategory_id |
no | int | 21 | Selected subsubcategory category for Groups |
tags |
no | string | database,mobile,data | Comma Separated string values relating to the subject of the Group |
photo |
no | file | image file | The front image of the Group |
price |
no | int | 112 | The price of the Item selling in this Group |
auth_view |
yes | string | “everyone” | Who can view the Groups |
auth_comment |
yes | string | “everyone” | Who can comment the Group |
splcreate |
no | string | “everyone” | Privary setting for Poll creation in Group |
sspcreate |
no | string | “everyone” | Privary setting for Sub pages creation in Group |
secreate |
no | string | “everyone” | Privary setting for Event creation in Group |
smcreate |
no | string | “everyone” | Privary setting for Music creation in Group |
sdicreate |
no | string | “everyone” | Privary setting for Discussion creation in Group |
spcreate |
no | string | “everyone” | Privary setting for Photo creation in Group |
sdcreate |
no | string | “everyone” | Privary setting for Document creation in Group |
search |
no | int | 1 | Setting to show this group on search results |
1_1_40_field_40 |
no | string | “The condition is good” | Specilities of the Directory page or the product |
1_4_14_field_14 |
no | int | 100 | overall length |
Example URI
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"title": "Please complete this field - it is required.",
"category_id": "Please complete this field - it is required."
}
}
204
Body
{
"status_code": 204
}
Group / Community Delete ¶
Delete GroupDELETE/advancedgroup/delete/group_id
Deletes the Particular Group / Community .
Example URI
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
500
Body
{
"status_code": 500,
"error": true,
"error_code": "internal_server_error",
"message": null
}
204
Body
{
"status_code": 204
}
Group / Community Close/Open ¶
Close/Open GroupPOST/advancedgroup/close/group_id
Close / Open the Particular Group / Community .
Example URI
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
500
Body
{
"status_code": 500,
"error": true,
"error_code": "internal_server_error",
"message": null
}
204
Body
{
"status_code": 204
}
Group / Community Publish ¶
Publish GroupPOST/advancedgroup/publish/group_id
Publish the Particular Group / Community .
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
search |
no | int | 1 | search=0 makes the page not searchable in the directory listings in browse action , search=1 makes the page searchable in the directory listings in browe action |
Example URI
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
400
Body
{
"status_code": 400,
"error": true,
"error_code": "oauth_parameter_missing",
"message": "Certain OAuth parameters are missing in your request."
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
500
Body
{
"status_code": 500,
"error": true,
"error_code": "internal_server_error",
"message": null
}
204
Body
{
"status_code": 204
}
Group / Community Message Owner ¶
Message Group OwnerGET/advancedgroup/messageowner/group_id
Returns the form fields for messaging the owner of Particular Group / Community
Example URI
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": [
{
"type": "Text",
"name": "title",
"label": "Subject",
"hasValidators": "true"
},
{
"type": "Textarea",
"name": "body",
"label": "Message"
},
{
"type": "Submit",
"name": "submit",
"label": "Send Message"
}
]
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Message Group OwnerPOST/advancedgroup/messageowner/group_id
Send the message to the owner of Particular Group / Community
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | request for phone number | The title of the message |
body |
yes | string | hey,there , please tell me your phone number | The description of the message |
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
500
Body
{
"status_code": 500,
"error": true,
"error_code": "internal_server_error",
"message": "Internal Server Error"
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"title": "Please complete this field - it is required."
}
}
204
Body
{
"status_code": 204
}
Group / Community Tell a friend ¶
Tell a friendGET/advancedgroup/tellafriend/group_id
Tell a friend about this Group / Community
Example URI
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 200,
"body": {
"form": [
{
"type": "Text",
"name": "sender_name",
"label": "Your Name",
"hasValidator": "true"
},
{
"type": "Text",
"name": "sender_email",
"label": "Your Email",
"has Validator": "true"
},
{
"type": "Text",
"name": "receiver_emails",
"label": "To",
"description": "Separate multiple addresses with commas",
"hasValidators": "true"
},
{
"type": "Textarea",
"name": "message",
"label": "Message",
"description": "You can send a personal note in the mail.",
"hasValidator": "true"
},
{
"type": "Checkbox",
"name": "send_me",
"label": "Send a copy to my email address."
},
{
"type": "Submit",
"name": "send",
"label": "Tell a Friend"
}
]
}
}
Tell a friendPOST/advancedgroup/tellafriend/group_id
Sends the mail containing the message to senders emails about the Group / Community
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
sender_name |
yes | string | raj | Name of the member sending the message |
sender_email |
yes | string | loren.ipsum@gmail.com | Email of the member sending the message |
receiver_emails |
yes | string | data.ipsum@gmail.com,noah.lemhoon@gmail.com | Email of the receivers which will be represented in comma seperated fashion |
message |
yes | string | This might be the group you like | Message which is to be sent. |
Example URI
200
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
204
Body
{
"status_code": 204
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"message": "Please complete this field - it is required."
}
}
Group / Community Information ¶
Group InformationGET/advancedgroup/information/group_id
Returns the basic information and profile fields data of the particular Group / Community
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
400
Body
{
"status_code": 200,
"body": {
"basic_information": {
"1": 1,
"Posted By:": {
"link": "/seapi/profile/martina",
"name": "Martina"
},
"Posted:": "Apr 05, 2016",
"Last Updated:": "Apr 05, 2016",
"Views:": 1,
"Likes:": 1,
"Category:": "Electronics",
"Location:": "Italy",
"Description:": "this is a programming language which is used very widely"
},
"profile_information": {
"Dimensions": "sasas",
"Power": "sasa",
"Colors Available": "sasa"
}
}
}
Group / Community Overview ¶
Group OverviewGET/advancedgroup/overview/group_id
Returns the overview of the particular Group / Community
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
400
Body
{
"status_code": 200,
"body": {
"overview": "Group is for people who are crazy movie lovers & addicts"
}
}
Groups / Communities Plugin / Album ¶
These are the APIs for the SocialEngineAddOns : Groups / Communities Plugin(https://www.socialengineaddons.com/socialengine-groups-communities-plugin).
Album Browse ¶
Album BrowseGET/advancedgroups/photos/index/group_id
Returns the album along with pagination for a Particular Group / Community
In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of albums in response and use page for the page number. [i.e: If you have 100 albums and the first request has limit=20 and page=1, then in that case the recent 20 albums will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent albums will be returned.]
Example URI
- itemCount
int
(optional) Example: itemCount=10Set the number of albums you want to display per page ,
itemCount=10
will show upto 10 albums per page- page
int
(optional) Example: page=1return albums according to page number ,
page=2
and we supposeitemcount=10
will return albums from 11-20 , similarlypage=3
will return albums from 21-30 and so on…
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": {
"totalItemCount": 2,
"response": [
{
"album_id": 6,
"group_id": 5,
"owner_id": 18787,
"order": 0,
"title": "Paul novels",
"search": 1,
"photo_id": 76883,
"view_count": 1,
"comment_count": 0,
"default_value": 0,
"like_count": 0,
"type": null,
"modified_date": "2016-06-13 08:50:00",
"creation_date": "2016-06-13 08:49:28",
"image": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"image_normal": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"image_profile": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"image_icon": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"content_url": "http://example.com/seapi/groupitems/album/view/group_id/5/album_id/6/slug/paul-novels/tab/14537",
"canUpload": 1,
"allow_to_view": 1,
"photo_count": 3
},
{
"album_id": 5,
"group_id": 5,
"owner_id": 0,
"order": 0,
"title": "Paul Choelho",
"search": 1,
"photo_id": 76874,
"view_count": 1,
"comment_count": 0,
"default_value": 1,
"like_count": 0,
"type": null,
"modified_date": "2016-06-13 06:57:21",
"creation_date": "2016-06-13 06:57:21",
"image": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"image_normal": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"image_profile": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"image_icon": "http://example.com/seapi/public/sitegroup_gr/2e/01/12c53_281e.png?c=2e7b",
"content_url": "http://example.com/seapi/groupitems/album/view/group_id/5/album_id/6/slug/paul-novels/tab/14537",
"canUpload": 1,
"allow_to_view": 1,
"photo_count": 6
}
]
}
}
Album Profile ¶
Album ProfileGET/advancedgroup/photos/viewalbum/group_id/album_id
Returns the album along with pagination for a Particular Group / Community
In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of pages in response and use page for the page number. [i.e: If you have 100 pages and the first request has limit=20 and page=1, then in that case the recent 20 pages will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent pages will be returned.]
Example URI
- itemCount_photo (optional, int, `itemCount_photo
string
(required) Default: 10`) ... Set the number of photos you want to display per page , `itemCount_photo=10` will show upto 10 photos of a particular album per page- page
int
(optional) Example: page=1return album photos according to page number ,
page=2
and we supposeitemCount_photo=10
will return album photos from 11-20 , similarlypage=3
will return album photos from 21-30 asn so on…
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": {
"album": {
"album_id": 1,
"group_id": 1,
"owner_id": 1,
"order": 0,
"title": "c++",
"description": "",
"creation_date": "2016-04-05 07:49:32",
"modified_date": "2016-04-05 07:53:42",
"search": 1,
"photo_id": 7,
"view_count": 0,
"comment_count": 0,
"collectible_count": 1,
"default_value": 1,
"like_count": 0,
"type": null,
"featured": 0,
"cover_params": null
},
"photos": {
"7": {
"album_id": 1,
"group_id": 1,
"user_id": 1,
"order": 2,
"title": "",
"description": "",
"photo_id": 7,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"modified_date": "2016-04-05 07:53:42",
"creation_date": "2016-04-05 07:53:07",
"photo_hide": 0,
"file_id": 7,
"collection_id": 1,
"images": {
"image": "http://example.com/seapi/public/sitegroup_group/07/0007_6f68.png?c=11a9",
"image_normal": "http://example.com/seapi/public/sitegroup_group/08/0008_8440.png?c=fc00",
"image_profile": "http://example.com/seapi/public/sitegroup_group/07/0007_6f68.png?c=11a9",
"image_icon": "http://example.com/seapi/public/sitegroup_group/07/0007_6f68.png?c=11a9",
"content_url": "http://example.com/seapi/pageitems/photo/view/group_id/1/album_id/1/photo_id/7"
}
},
"9": {
"album_id": 1,
"group_id": 1,
"user_id": 1,
"order": 3,
"title": "",
"description": "",
"photo_id": 9,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"modified_date": "2016-04-05 07:53:42",
"creation_date": "2016-04-05 07:53:08",
"photo_hide": 0,
"file_id": 9,
"collection_id": 1,
"images": {
"image": "http://example.com/seapi/public/sitegroup_group/09/0009_e16d.jpg?c=fe97",
"image_normal": "http://example.com/seapi/public/sitegroup_group/0a/000a_f028.jpg?c=9b02",
"image_profile": "http://example.com/seapi/public/sitegroup_group/09/0009_e16d.jpg?c=fe97",
"image_icon": "http://example.com/seapi/public/sitegroup_group/09/0009_e16d.jpg?c=fe97",
"content_url": "http://example.com/seapi/pageitems/photo/view/group_id/1/album_id/1/photo_id/9"
}
},
"total_count": 5
},
"gutterMenus": [
{
"title": "Delete Album",
"url": "advancedgroups/photos/deletealbum/1/1",
"name": "delete"
},
{
"title": "Edit Album",
"url": "advancedgroups/photos/editalbum/1/1",
"name": "edit"
},
{
"title": "Make Featured",
"url": "advancedgroups/photos/albumfeatured/1/1",
"name": "featured"
},
{
"title": "Make Album of the Day",
"url": "advancedgroups/photos/addalbumofday/1/1",
"name": "albumofday"
},
{
"title": "Add Photo",
"url": "advancedgroups/photos/addphoto/1/1",
"name": "addphoto"
},
{
"title": "View Photo",
"url": "advancedgroups/photos/viewphoto/1/1/photo_id",
"name": "viewphoto"
}
]
}
}
Edit Album ¶
Edit albumGET/advancedgroups/photos/editalbum/group_id/album_id
Returns the edit album form
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
200
Body
{
"status_code": 200,
"body": {
"form": [
{
"title": "Edit Title",
"name": "title",
"value": "database",
"hasValidator": true
},
{
"type": "select",
"name": "auth_tag",
"label": "Tag Post Privacy",
"description": "Who may tag photos in this album?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"owner": "Page Admins"
},
"value": "registered"
},
{
"label": "show this album in search results",
"value": 1,
"type": "checkbox",
"name": "search"
},
{
"type": "submit",
"name": "submit"
}
]
}
}
Edit AlbumPOST/advancedgroups/photos/editalbum/group_id/album_id
Submits the album edit form
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
no | string | Friend’s Party | The title of the album |
auth_tag |
no | string | registered | Permission for tag , in this example all registered users have the permission to tag |
search |
no | int | 1 | 1 will dhow this album while searching and 0 will not . |
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
204
Body
{
"status_code": 204
}
Delete Album ¶
Delete albumDELETE/advancedgroups/photos/deletealbum/group_id/album_id
Deletes the album
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
204
Body
{
"status_code": 204
}
Featured/UnFeatured Album ¶
Featured/UnFeatured AlbumGET/advancedgroups/photos/albumfeatured/group_id/album_id
Toggle the featured behaviour of the Group / Community Album
If the Album is Featured then calling this api will make it Unfeatured and if this album is Unfeatured then calling this api will make it Feaured.
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
204
Body
{
"status_code": 204
}
Album of the Day ¶
Album of the DayGET/advancedgroups/photos/addalbumofday/group_id/album_id
Returns the form for making the album - album of the day
Example URI
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": {
"form": [
{
"type": "date",
"name": "startdate",
"title": "Start Date",
"required": "true"
},
{
"type": "date",
"name": "enddate",
"title": "End Date",
"required": "true"
},
{
"type": "submit",
"name": "submit"
}
]
}
}
Album of the DayPOST/advancedgroups/photos/addalbumofday/group_id/album_id
Makes the album - album of the day
If the album is already present in the album of day list then it updates the startdate and enddate of the album In the albumofday listing.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
startdate |
yes | date | 2016-04-27 | The start Date of the album of the day |
starttime |
yes | date | 2016-04-27 | The end Date of the album of the day |
Example URI
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"startdate": "Please complete this field - it is required."
}
}
204
Body
{
"status_code": 204
}
View Album Photo ¶
View Album PhotoGET/advancedgroups/photos/viewphoto/group_id/album_id/photo_id
Returns the details of a particular photo in a Group / Community album.
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": {
"photo": {
"photo_id": 7,
"album_id": 1,
"group_id": 1,
"user_id": 1,
"order": 2,
"title": "",
"description": "",
"collection_id": 1,
"file_id": 7,
"creation_date": "2016-04-05 07:53:07",
"modified_date": "2016-04-05 07:53:42",
"comment_count": 0,
"like_count": 0,
"photo_hide": 0,
"featured": 0,
"view_count": 0,
"file_path": {
"image": "http://example.com/seapi/public/sitegroup_group/07/0007_6f68.png?c=11a9",
"image_normal": "http://example.com/seapi/public/sitegroup_group/08/0008_8440.png?c=fc00",
"image_profile": "http://example.com/seapi/public/sitegroup_group/07/0007_6f68.png?c=11a9",
"image_icon": "http://example.com/seapi/public/sitegroup_group/07/0007_6f68.png?c=11a9",
"content_url": "http://example.com/seapi/pageitems/photo/view/group_id/1/album_id/1/photo_id/7"
}
},
"gutterMenus": [
{
"title": "Edit Photo",
"name": "edit",
"url": "advancedgroups/photos/editphoto/1/1/7"
},
{
"title": "Delete Photo",
"name": "delete",
"url": "advancedgroups/photos/deletephoto/1/1/7"
}
]
}
}
Edit Photo ¶
Edit PhotoGET/advancedgroups/photos/editphoto/group_id/album_id/photo_id
Returns the form editing the photo title and description
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": [
{
"title": "Title",
"name": "title",
"type": "text"
},
{
"title": "Description",
"name": "title",
"type": "text"
},
{
"type": "submit",
"title": "submit",
"name": "submit"
}
]
}
Edit PhotoPOST/advancedgroups/photos/editphoto/group_id/album_id/photo_id
Updates the title and description of Group / Community album photo.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
no | string | Friend’s Party | Title of the Image |
description |
no | string | Friend’s Party and had a lot of fun in it | Description of the Image |
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
204
Body
{
"status_code": 204
}
Delete Photo ¶
Delete PhotoDELETE/advancedgroups/photos/deletephoto/group_id/album_id/photo_id
Deletes the photo from Group / Community album
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
204
Body
{
"status_code": 204
}
Add Photo ¶
Add PhotoPOST/advancedgroups/photos/addphoto/group_id/album_id
Adds a photo to the Group / Community album
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
data |
yes | file | file | A photo |
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
204
Body
{
"status_code": 204
}
Groups / Communities Plugin / Reviews ¶
These are the APIs for the SocialEngineAddOns : Groups / Communities - Reviews and Ratings Extension(https://www.socialengineaddons.com/groupextensions/socialengine-groups-communities-reviews-and-ratings).
Browse Reviews ¶
Browse ReviewsGET/advancedgroups/reviews/browse/group_id
Return paginated listing of reviews of a Group / Community
In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of reviews in response and use page for the page number. [i.e: If you have 100 reviews and the first request has limit=20 and page=1, then in that case the recent 20 reviews will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent reviews will be returned.]
Example URI
- search
string
(optional) Example: string=valuegets listing of reviews which have ‘value’ string in the title of their reviews
- Show
string
(optional) Example: show=friends_reviewsshow the reviews as per the specifications
show=''
shows reviews posted by everyone ,show=friends_reviews
only shows reviews of your friends ,show=self_reviews
shows reviews created by the current user ,show=featured
shows reviews which are featured- type
string
(optional) Example: type=editor- order
string
(optional) Example: order=recentorders the reviews listing ,
order=recent
shows rmost recenet review first ,order=rating_highest
shows highest rated review first ,order=rating_lowest
shows lowest rated review first ,order=helpfull_most
shows the reviews in the descending order of helpful count of the review ,order=replay_most
shows reviews in the order of most replied reviews desc ,order=view_most
shows the most viewed review at first- rating
int
(optional) Example: rating=1lists only specified reviews whose rating match the sent parameter ,
rating=1
shows only those reviews which have 1 rating .- recommend
int
(optional) Example: recommend=shows only those reviews which are recommended.
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
200
Body
{
"status_code": 200,
"body": {
"total_reviews": 1,
"reviews": [
{
"review_id": 1,
"group_id": 1,
"owner_id": 2,
"title": "Value of money",
"body": "Nice Group",
"creation_date": "2016-04-28 07:31:01",
"modified_date": "2016-04-28 07:31:01",
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"pros": "Value for money",
"cons": "Lack of cordination",
"recommend": 1,
"featured": 0,
"rating": 5,
"owner_title": "Matina James",
"owner_image": "http://example.com/seapi/public/user/42/0042_ea08.jpeg?c=9217",
"owner_image_normal": "http://example.com/seapi/public/user/44/0044_f13b.jpeg?c=cd4d",
"owner_image_profile": "http://example.com/seapi/public/user/43/0043_a531.jpeg?c=d865",
"owner_image_icon": "http://example.com/seapi/public/user/45/0045_8756.jpeg?c=f292",
"group_title": "c++",
"overall_rating": 5,
"category_name": "Electronics",
"image": "http://example.com/seapi/public/sitegroup_group/3a/003a_ea08.jpeg?c=9217",
"image_normal": "http://example.com/seapi/public/sitegroup_group/3c/003c_888d.jpeg?c=be21",
"image_profile": "http://example.com/seapi/public/sitegroup_group/3b/003b_a531.jpeg?c=d865",
"image_icon": "http://example.com/seapi/public/sitegroup_group/3d/003d_8756.jpeg?c=f292",
"content_url": "http://example.com/seapi/pageitem/cpp"
}
]
}
}
Reviews - Search Form ¶
Reviews - Search FormGET/advancedgroups/reviews/search/group_id
Returns the Group / Community review search form
Example URI
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": [
{
"type": "Text",
"name": "search",
"label": "Search"
},
{
"type": "Select",
"name": "show",
"label": "Show",
"multiOptions": {
"": "Everyone's Reviews",
"friends_reviews": "My Friends' Reviews",
"self_reviews": "My Reviews",
"featured": "Featured Reviews"
}
},
{
"type": "Select",
"name": "type",
"label": "Reviews Written By",
"multiOptions": {
"": "Everyone",
"editor": "Editors",
"user": "Users"
}
},
{
"type": "Select",
"name": "order",
"label": "Browse By",
"multiOptions": {
"recent": "Most Recent",
"rating_highest": "Highest Rating",
"rating_lowest": "Lowest Rating",
"helpfull_most": "Most Helpful",
"replay_most": "Most Reply",
"view_most": "Most Viewed"
}
},
{
"type": "Select",
"name": "rating",
"label": "Ratings",
"multiOptions": {
"1": "1 Star",
"2": "2 Star",
"3": "3 Star",
"4": "4 Star",
"5": "5 Star",
"": ""
}
},
{
"type": "Checkbox",
"name": "recommend",
"label": "Only Recommended Reviews"
},
{
"type": "Submit",
"name": "done",
"label": "Search"
}
]
}
Create Review ¶
Create ReviewGET/advancedgroups/reviews/create/group_id
Returns the review create form
Example URI
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "review_already_present",
"message": "You have already reviewed on this page"
}
200
Body
{
"status_code": 200,
"body": {
"form": [
{
"type": "Textarea",
"name": "pros",
"label": "Pros",
"description": "What do you like about this Group?",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "cons",
"label": "Cons",
"description": "What do you dislike about this Group?",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "title",
"label": "One-line summary"
},
{
"type": "Textarea",
"name": "body",
"label": "Summary"
},
{
"type": "Radio",
"name": "recommend",
"label": "Recommended",
"description": "Would you recommend this Group to a friend?",
"multiOptions": {
"0": "No",
"1": "Yes"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Submit"
}
],
"ratingParams": [
{
"type": "Rating",
"name": "review_rate_0",
"label": "Overall Rating"
}
]
}
}
Create ReviewPOST/advancedgroups/reviews/create/group_id
Posts Data and creates a review
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
pros |
yes | string | smart, lightweight | Some advantages of the Group / Community |
cons |
yes | string | over priced | Some disadvantages of the Group / Community |
title |
yes | string | value for money | Some catchy line |
body |
no | string | this is a great group | Full summary |
recommend |
yes | int | 1 | whether you want to recommend this group to someone |
review_rate_0 |
yes | float | 3 | overall rating of the group |
Example URI
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"pros": "Please complete this field - it is required.",
"cons": "Please complete this field - it is required.",
"review_rate_0": "Please complete this field - it is required."
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
204
Body
{
"status_code": 204
}
Profile Review ¶
Profile ReviewGET/advancedgroups/review/view/group_id/review_id
Returns the review data
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
200
Body
{
"status_code": 200,
"body": {
"response": {
"review_id": 1,
"group_id": 1,
"owner_id": 2,
"title": "Value of money",
"body": "Nice Group",
"creation_date": "2016-04-28 07:31:01",
"modified_date": "2016-04-28 07:31:01",
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"pros": "lightweight, fast , modest technology",
"cons": "priced high",
"recommend": 1,
"featured": 0,
"owner_title": "Martina James",
"tag": "c++, cpp, computer programming",
"categoryname": "Electronics",
"ratingParams": [
{
"rating": 5,
"reviewcat_name": null
}
]
}
}
}
Edit Review ¶
Edit ReviewGET/advancedgroups/review/edit/group_id/review_id
Returns the edit form of the review
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
200
Body
{
"status_code": 200,
"body": {
"data": {
"review_id": 1,
"group_id": 1,
"owner_id": 2,
"title": "Value of money",
"body": "Nice Group",
"creation_date": "2016-04-28 07:31:01",
"modified_date": "2016-04-28 07:31:01",
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"pros": "lightweight",
"cons": "overpriced",
"recommend": 1,
"featured": 0,
"owner_title": "Martina James",
"event_type_title": "Events",
"location": "California",
"tag": "c++, cpp, computer programming",
"categoryname": "Electronics",
"ratingParams": [
{
"rating": 5,
"reviewcat_name": null
}
]
},
"form": [
{
"type": "Textarea",
"name": "pros",
"label": "Pros",
"description": "What do you like about this Group?",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "cons",
"label": "Cons",
"description": "What do you dislike about this Group?",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "title",
"label": "One-line summary"
},
{
"type": "Textarea",
"name": "body",
"label": "Summary"
},
{
"type": "Radio",
"name": "recommend",
"label": "Recommended",
"description": "Would you recommend this Group to a friend?",
"multiOptions": {
"0": "No",
"1": "Yes"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Submit"
}
],
"ratingParams": [
{
"type": "Rating",
"name": "review_rate_0",
"label": "Overall Rating"
}
]
}
}
Edit ReviewPOST/advancedgroups/review/edit/group_id/review_id
Submits the form updating the review params
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
pros |
yes | string | smart, lightweight | Some advantages of the Group / Community |
cons |
yes | string | over priced | Some disadvantages of the group |
title |
yes | string | value for money | Some catchy line |
body |
no | string | this is a great group | Full summary |
recommend |
yes | int | 1 | whether you want to recommend this group to someone |
review_rate_0 |
yes | float | 3 | overall rating of the group |
Example URI
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"pros": "Please complete this field - it is required.",
"cons": "Please complete this field - it is required.",
"review_rate_0": "Please complete this field - it is required."
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
204
Body
{
"status_code": 204
}
Delete Review ¶
Delete ReviewDELETE/advancedgroups/review/delete/group_id/review_id
deletes the review
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
204
Body
{
"status_code": 204
}
List Comments and Likes Review ¶
List Comments and Likes ReviewGET/advancedgroups/review/listcomments/group_id/review_id
Lists the comments and on Particular review
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
400
Body
{
"status_code": 400,
"error": true,
"error_code": "invalid_method",
"message": "Incorrect method"
}
200
Body
{
"status_code": 200,
"body": {
"comments": {
"1": {
"comment_id": 1,
"resource_type": "sitegroupreview_review",
"resource_id": 2,
"poster_type": "user",
"poster_id": 1,
"body": "this is awesome",
"creation_date": "2016-04-28 11:31:05",
"like_count": 0,
"owner_images": {
"owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
},
"owner_title": "martina"
}
},
"likes": {
"6": {
"like_id": 6,
"resource_type": "sitegroupreview_review",
"resource_id": 2,
"poster_type": "user",
"poster_id": 1,
"creation_date": "2016-04-28 10:33:10",
"owner_images": {
"owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
},
"owner_title": "dilip"
}
}
}
}
Create comment on Review ¶
Create comment on ReviewGET/advancedgroups/review/comment/group_id/review_id
Returns the reviews comment form
Example URI
200
Body
{
"status_code": 200,
"body": [
{
"type": "text",
"name": "body",
"label": "Comment"
}
]
}
Create comment on Group / Community ReviewPOST/advancedgroups/review/comment/group_id/review_id
Posts the comment form
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
body |
yes | string | yeah | the comment body |
Example URI
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"body": "Please complete this field - it is required."
}
}
204
Body
{
"status_code": 204
}
Like / Unlike on Review ¶
Like / Unlike on ReviewGET/advancedgroups/review/like/group_id/review_id
Like a review or unlikes (if review already liked by user)
Example URI
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
204
Body
{
"status_code": 204
}
Groups / Communities Plugin / Video ¶
These are the APIs for the SocialEngineAddOns : Groups / Communities - Videos Extension(https://www.socialengineaddons.com/groupextensions/socialengine-groups-communities-videos).
Browse Videos ¶
Browse VideosGET/advancedgroups/videos/browse/group_id
Get the listing’s video listing.
In case of pagination, we need to use 2 parameters limit
and page
. Use limit
to set the number of videos in response and use page
for the page number. [i.e: If you have 100 videos and the first request has limit=20
and page=1
, then in that case the recent 20 videos will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent videos will be returned.]
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 58`)group_id
- page
integer
(optional) Example: page=2return the ‘limit’ number of videos of that page of videos listings.
- limit
integer
(optional) Example: limit=20number of videos. Default limit is 10.
- menu
boolean
(optional) Example: menu=1 OR 0get gutter menu’s array. Default value is 1.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"canCreate": 0,
"canEdit": 0,
"videos": [
{
"video_id": 1,
"group_id": 14,
"title": "Video",
"description": "Trip Video",
"search": 1,
"owner_id": 4,
"creation_date": "2016-02-02 11:06:20",
"modified_date": "2016-02-02 11:06:20",
"view_count": 1,
"comment_count": 0,
"type": 2,
"code": 153283760,
"photo_id": 106,
"rating": 0,
"like_count": 0,
"status": 1,
"file_id": 0,
"duration": 1244,
"is_import": 0,
"rotation": 0,
"image": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"image_normal": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"image_profile": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"image_icon": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"content_url": "http://example.com/listings/video/14/4/1/slug/video",
"owner_image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Martina James",
"allow_to_view": 1,
"rating_count": 0,
"video_url": "player.vimeo.com/video/153283760?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Create Group Video ¶
Get Video Create FormGET/advancedgroups/video/create/
Get the Group video creation form.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 58`)group_id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Content-Type: application/json
Body
[
{
"type":"Text",
"name":"title",
"label":"Video Title",
"hasValidator":true
},
{
"type":"Text",
"name":"tags",
"label":"Tags (Keywords)",
"description":"Separate tags with commas."
},
{
"type":"Textarea",
"name":"description",
"label":"Video Description",
},
{
"type":"Checkbox",
"name":"search",
"label":"Show this video entry in search results"
},
{
"type":"Select",
"name":"type",
"label":"Video Source",
"multiOptions":{
"1":"YouTube",
"2":"Vimeo"
},
"hasValidator":true
},
{
"type":"Text",
"name":"url",
"label":"Video Link (URL)",
"description":"Paste the web address of the video here."
},
{
"type":"File",
"name":"filedata",
"label":"Add Video"
},
{
"type":"Submit",
"name":"submit",
"label":"Post Video"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create VideoPOST/advancedgroups/video/create/
Create a new group video by posting the group video creation form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Anthony Horowitz’s Official Sherlock Holmes Novel | video title |
description |
no | string | Seems like this is going to be a good year for us book lovers… | video description |
tags |
no | string | happy,fun,trip | |
search |
no | boolean | 1 | make video searchable (1 ) or not (0 ) |
type |
yes | integer | 2 | upload video from YouTube (1 ) or Vimeo (2 ) or from device (3 ) |
url |
no | string | https://www.youtube.com/watch?v=SbPsiau32WI | video url for YouTube and Vimeo. |
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 58`)group_id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "How To Use AF-On And Back Button Autofocus",
"tags": "entertainment",
"description": "Check out my website and sign up for my e-mail newsletter: http://www.backcountrygallery.com Try a better way to focus your DSLR! Using back button autofocus is a faster, easier, smarter way to get great AF results from your DSLR.",
"search": 1,
"type": 1,
"url": https://www.youtube.com/watch?v=SbPsiau32WI
}
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Group Video Profile ¶
Group Video ProfileGET/advancedgroups/video/{?menu}
Get a video post and its gutter menu’s (create, edit, delete, share, etc) information.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 25`)group_id
- video_id (required, integer, `video_id
string
(required) Default: 25`)video id
- menu
boolean
(optional) Example: menu=1 OR 0get gutter menu’s array. Default value is 1.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Body
{
"gutterMenu": [
{
"label": "Post New Video",
"name": "create",
"url": "advancedgroups/videos/create/262"
},
{
"label": "Edit Video",
"name": "edit",
"url": "advancedgroups/video/edit/262/13"
},
{
"label": "Delete Video",
"name": "delete",
"url": "advancedgroups/video/delete/262/13"
},
{
"label": "Share",
"name": "share",
"url": "activity/share",
"urlParams": {
"type": "sitegroup_video",
"id": 13
}
}
],
"response": {
"video_id": 13,
"group_id": 262,
"title": "hello",
"description": "An animation based on the magazine cover, co-produced by The New Yorker and “This American Life.” Created by Chris Ware and John Kuramoto, with interviews and narration by Ira Glass and music by Nico Muhly.",
"search": 1,
"owner_id": 5,
"creation_date": "2016-02-06 05:12:19",
"modified_date": "2016-02-06 05:12:21",
"view_count": 1,
"comment_count": 0,
"type": 2,
"code": "154206876",
"photo_id": 758,
"rating": 0,
"like_count": 0,
"status": 1,
"file_id": 0,
"duration": 211,
"is_import": 0,
"rotation": 0,
"categoryname": "conventions",
"subcategoryname": "educational",
"location": "",
"group": "magazine cover",
"tags": {
"27": "fvf"
},
"can_edit": 1,
"can_delete": 1,
"can_embed": true,
"rating_count": 0,
"rated": false,
"videoEmbedded": "",
"video_url": "player.vimeo.com/video/154206876?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
}
}
Edit Video ¶
Get Edit Video FormGET/advancedgroups/video/edit/
Get the form for editing a video-post.
Returns the form
and formValues
as response. In form
we get the complete video form and in formValues
we get the form’s values.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 124`)group_id
- video_id (required, integer, `video_id
string
(required) Default: 124`)video id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Content-Type: application/json
Body
{
"form":[
{
"type":"Text",
"name":"title",
"label":"Video Title",
"hasValidator":true
},
{
"type":"Text",
"name":"tags",
"label":"Tags (Keywords)",
"description":"Separate tags with commas."
},
{
"type":"Textarea",
"name":"description",
"label":"Video Description",
},
{
"type":"Checkbox",
"name":"search",
"label":"Show this video entry in search results"
},
{
"type":"Submit",
"name":"submit",
"label":"Save Video"
}
],
"formValues":{
"video_id":6,
"title":"Uploaded From Computer",
"description":"Uploaded From Computer",
"search":1,
"owner_type":"",
"owner_id":1,
"parent_type":null,
"parent_id":null,
"creation_date":"2015-04-15 06:36:21",
"modified_date":"2015-04-15 06:37:00",
"view_count":3,
"comment_count":0,
"type":3,
"code":"3gp",
"photo_id":164,
"rating":0,
"category_id":2,
"status":1,
"file_id":163,
"duration":139,
"rotation":270,
"location":"",
"auth_view":"everyone",
"auth_comment":"everyone",
"tags":""
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Edit VideoPUT/advancedgroups/video/edit/
Edit a video-post.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | How To Use AF-On And Back Button | video title |
tags |
no | string | banking, operations | video tags (comma separated) |
description |
no | string | Check out my website and sign up for my e-mail… | video content |
search |
no | boolean | 1 | make video searchable (1 ) or not (0 ) |
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 124`)group_id
- video_id (required, integer, `video_id
string
(required) Default: 124`)video id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "How To Use AF-On And Back Button Autofocus",
"tags": "entertainment",
"description": "Check out my website and sign up for my e-mail newsletter: http://www.backcountrygallery.com Try a better way to focus your DSLR! Using back button autofocus is a faster, easier, smarter way to get great AF results from your DSLR.",
"category_id": 3,
"search": 1,
"auth_view": "everyone",
"auth_comment": "everyone"
}
204
400
Body
{
"status_code":400,
"error":true,
"error_code":"validation_fail",
"message":{
"title":"Please complete this field - it is required.",
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Delete Video ¶
Delete VideoDELETE/advancedgroups/video/delete/
Delete a video-post.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 124`)group_id
- video_id (required, integer, `video_id
string
(required) Default: 124`)video id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Groups / Communities Plugin / Members ¶
These are the APIs for the SocialEngineAddOns : Groups / Communities Plugin(https://www.socialengineaddons.com/socialengine-groups-communities-plugin).
Browser Member List ¶
Member Guest ListGET/advancedgroups/members/browse/{?search}{?waiting}{&menu}{&page}{&limit}
Get the group members listing. Members can also be browsed and searched based on keywords etc.
In case of pagination, we need to use 2 parameters limit
and page
. Use limit
to set the number of members in response and use page
for the page number. [i.e: If you have 100 members and the first request has limit=20
and page=1
, then in that case the recent 20 members will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent members will be returned.]
Example URI
- search
string
(optional) Example: search=teacherget members that contain this keyword in name.
- menu
integer
(optional) Example: menu=1to get the menu options along with each guest.
- group_id (required, integer, `group_id
string
(required) Default: 124`)group_id
- waiting
integer
(optional) Example: waiting=1to get the list of waiting members.
- page
integer
(optional) Example: page=2return the ‘limit’ number of members of that page of group listings.
- limit
integer
(optional) Example: limit=20number of members. Default limit is 20.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"members": [
{
"user_id": 1,
"username": "John",
"displayname": "John Adams",
"photo_id": 23,
"status": null,
"status_date": null,
"locale": "auto",
"language": "en_US",
"timezone": "US/Pacific",
"search": 1,
"show_profileviewers": 1,
"level_id": 1,
"invites_used": 0,
"extra_invites": 0,
"enabled": 1,
"verified": 1,
"approved": 1,
"creation_date": "2016-01-07 08:45:34",
"modified_date": "2016-02-05 10:10:15",
"lastlogin_date": "2016-02-05 09:25:43",
"update_date": null,
"member_count": 1,
"view_count": 13,
"image": "http://example.com/public/public/user/17/0017_2d0f.png?c=30f5",
"image_normal": "http://example.com/public/public/user/19/0019_964a.png?c=1b80",
"image_profile": "http://example.com/public/public/user/18/0018_d2ab.png?c=b069",
"image_icon": "http://example.com/public/public/user/1a/001a_c6a5.png?c=67f4",
"content_url": "http://example.com/public/profile/john",
"is_owner": 0,
"menu": [
{
"label": "Remove Member",
"name": "remove_member",
"url": "advancedgroups/members/remove/14",
"urlParams": {
"user_id": 1
}
}
]
},
{
"user_id": 4,
"username": "Martina",
"displayname": "Martina James",
"photo_id": 0,
"status": null,
"status_date": null,
"locale": "English",
"language": "English",
"timezone": "US/Pacific",
"search": 1,
"show_profileviewers": 1,
"level_id": 4,
"invites_used": 0,
"extra_invites": 0,
"enabled": 1,
"verified": 1,
"approved": 1,
"creation_date": "2016-02-01 06:11:09",
"modified_date": "2016-02-05 09:41:11",
"lastlogin_date": "2016-02-05 09:24:12",
"update_date": null,
"member_count": 0,
"view_count": 1,
"occurrence_id": 14,
"rsvp": 2,
"image": "http://example.com/public/nophoto_user_thumb_profile.png",
"image_normal": "http://example.com/public/nophoto_user_thumb_profile.png",
"image_profile": "http://example.com/public/nophoto_user_thumb_profile.png",
"image_icon": "http://example.com/public/nophoto_user_thumb_icon.png",
"content_url": "http://example.com/public/profile/martina",
"is_owner": 1,
"menu": null
}
],
"waiting": false,
"getTotalItemCount": 2,
"canEdit": 0
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Search Form ¶
Search FormGET/advancedgroups/members/search-form
Get the group search form.
Example URI
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"label":"Member Keywords",
"type":"Text",
"name":"search_member"
},
{
"label":"Browse By",
"type":"Select",
"name":"orderby",
"multiOptions":{
"":"",
"join_date":"Most Recent",
"member_count":"Top Group Joiners",
"featured_member":"Featured Members"
}
},
{
"label":"Roles",
"type":"Select",
"name":"role_id",
"multiOptions":{
"1":"Guide",
"4":"Traveller"
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Invite Members ¶
Get Members Invite FormGET/advancedgroups/member/invite-members/
Get the member invite form.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Content-Type: application/json
Body
[
{
"type": "Text",
"name": "user_ids",
"label": "Start typing the names of the members that you want to invite."
},
{
"type": "Submit",
"name": "submit",
"label": "Send Invites"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Invite MembersPOST/advancedgroups/member/invite-members/
Invite a friends to join the group by posting the invite members form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
user_ids |
yes | string | 123,54,235 | comma-separated IDs of friends. |
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)event id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"user_ids": "123,54,235"
}
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Join a Group ¶
Join a Group FormGET/advancedgroups/member/join/
Join a Group Form.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Content-Type: application/json
Body
{
"status_code": 200,
"body": [
{
"label": "Role",
"type": "Multiselect",
"name": "role_id",
"multiOptions": {
"1": "Guide",
"4": "Traveller"
},
"value": [
1,
4
]
},
{
"label": "Year",
"type": "Select",
"name": "year",
"multiOptions": {
"0": "Year",
"1906": 1906,
"1907": 1907,
"1908": 1908,
"1909": 1909,
"1910": 1910,
"1911": 1911,
"1912": 1912,
"1913": 1913,
"1914": 1914,
"1915": 1915,
"1916": 1916,
"1917": 1917,
"1918": 1918,
"1919": 1919,
"1920": 1920,
"1921": 1921,
"1922": 1922,
"1923": 1923,
"1924": 1924,
"1925": 1925,
"1926": 1926,
"1927": 1927,
"1928": 1928,
"1929": 1929,
"1930": 1930,
"1931": 1931,
"1932": 1932,
"1933": 1933,
"1934": 1934,
"1935": 1935,
"1936": 1936,
"1937": 1937,
"1938": 1938,
"1939": 1939,
"1940": 1940,
"1941": 1941,
"1942": 1942,
"1943": 1943,
"1944": 1944,
"1945": 1945,
"1946": 1946,
"1947": 1947,
"1948": 1948,
"1949": 1949,
"1950": 1950,
"1951": 1951,
"1952": 1952,
"1953": 1953,
"1954": 1954,
"1955": 1955,
"1956": 1956,
"1957": 1957,
"1958": 1958,
"1959": 1959,
"1960": 1960,
"1961": 1961,
"1962": 1962,
"1963": 1963,
"1964": 1964,
"1965": 1965,
"1966": 1966,
"1967": 1967,
"1968": 1968,
"1969": 1969,
"1970": 1970,
"1971": 1971,
"1972": 1972,
"1973": 1973,
"1974": 1974,
"1975": 1975,
"1976": 1976,
"1977": 1977,
"1978": 1978,
"1979": 1979,
"1980": 1980,
"1981": 1981,
"1982": 1982,
"1983": 1983,
"1984": 1984,
"1985": 1985,
"1986": 1986,
"1987": 1987,
"1988": 1988,
"1989": 1989,
"1990": 1990,
"1991": 1991,
"1992": 1992,
"1993": 1993,
"1994": 1994,
"1995": 1995,
"1996": 1996,
"1997": 1997,
"1998": 1998,
"1999": 1999,
"2000": 2000,
"2001": 2001,
"2002": 2002,
"2003": 2003,
"2004": 2004,
"2005": 2005,
"2006": 2006,
"2007": 2007,
"2008": 2008,
"2009": 2009,
"2010": 2010,
"2011": 2011,
"2012": 2012,
"2013": 2013,
"2014": 2014,
"2015": 2015,
"2016": 2016
},
"value": 2016,
"hasValidator": "true"
},
{
"label": "Month",
"type": "Select",
"name": "month",
"multiOptions": [
"Month",
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December"
],
"hasValidator": "true"
},
{
"label": "Day",
"type": "Select",
"name": "day",
"multiOptions": [
"Day",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"hasValidator": "true"
},
{
"label": "Submit",
"type": "Submit",
"name": "submit"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Join a GroupPOST/advancedgroups/member/join/
Join a Group request.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
role_id |
yes | integer | 2 | post for roles of joining. |
year |
yes | integer | 2016 | post for year of joining . |
month |
yes | integer | april | post for month of joining . |
day |
yes | integer | 2 | post for day of joining . |
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)event id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Leave Group ¶
Leave GroupPOST/advancedgroups/member/leave/
Leave a group.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Reject Membership Request ¶
Reject Membership RequestPOST/advancedgroups/members/reject/
Reject a invite request.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
- user_id (required, integer, `user_id
string
(required) Default: 129`)user id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Approve Membership Request ¶
Approve Membership RequestPOST/advancedgroups/members/approve/
Approve a event membership request.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
member_id |
yes | integer | 78 | member id |
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Remove Member ¶
Remove MemberDELETE/advancedgroups/members/remove/
Remove member from the group membership.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
member_id |
yes | integer | 78 | member id |
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Message Members ¶
Get Message Members FormGET/advancedgroups/members/compose/
Get the Message Members form.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Content-Type: application/json
Body
[
{
"label": "Message Who?",
"type": "Select",
"name": "coupon_mail",
"multiOptions": {
"0": "All Group Members",
"1": "Particular Members (You can enter the members using the auto-suggest below.)"
},
"value": 0
},
{
"label": "Members to Message",
"type": "Text",
"name": "toValues",
"hasValidator": "true"
},
{
"label": "Subject",
"type": "Text",
"name": "title",
"hasValidator": "true"
},
{
"label": "Message",
"type": "Textarea",
"name": "body",
"hasValidator": "true"
},
{
"label": "Submit",
"type": "Submit",
"name": "submit"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Message MembersPOST/advancedgroups/members/compose/
Message Owner of the diary by posting the message owner form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Nice Collection | title |
coupon_mail |
yes | integer | coupon_mail = 0 | selected members |
toValues |
yes | integer | toValues = 1,78 | member ids |
body |
no | string | Very nice collection of events | message body |
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Suggest Members ¶
Suggest MembersGET/advancedgroups/members/getmembers/{?text}{&limit}
Get the list of all members of a group. This API call is useful for auto-suggest fields.
Example URI
- text
string
(optional) Example: text=alenstring to be matched with members’ names.
- limit
integer
(optional) Example: limit=10number of friends. Default limit is 10.
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
[
{
"type": "user",
"id": 2,
"guid": "user_2",
"label": "James Robert",
"photo": "http://example.com/public/user/41/02/023f_eabf.jpg"
},
{
"type": "user",
"id": 1,
"guid": "user_1",
"label": "Jennifer Aniston",
"photo": "http://example.com/public/user/41/02/023f_eabf.jpg"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Group Membership Request ¶
Group Membership RequestPOST/advancedgroups/member/request/
Request for the membership in group.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Cancel Group Membership Request ¶
Cancel Group Membership RequestPOST/advancedgroups/member/cancel/
Cancel Membership Request Sent for a group.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Accept Group Membership Invitation ¶
Accept Group Membership InvitationPOST/advancedgroups/member/accept/
Accept Group membership invitations sent by the group owner.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Reject Group Membership Invitation ¶
Reject Group Membership InvitationPOST/advancedgroups/member/reject/
Reject Group membeship invitations sent by the group owner.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Make Group Admin ¶
Make Group AdminPOST/advancedgroups/member/makeadmin/
Make a group member group Admin.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
- user_id (required, integer, `user_id
string
(required) Default: 129`)user id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Remove Group Admin ¶
Remove Group AdminPOST/advancedgroups/member/removeadmin/
Make a group member group from admin.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 129`)group id
- user_id (required, integer, `user_id
string
(required) Default: 129`)user id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
204
401
Headers
Content-Type: application/json
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Groups / Communities Plugin / Offers ¶
These are the APIs for the SocialEngineAddOns : Groups / Communities - Offers Extension(https://www.socialengineaddons.com/groupextensions/socialengine-groups-communities-offers).
Browse Offers ¶
Browse OffersGET/advancedgroups/offers/browse/group_id
Return paginated listing of offers of a Group / Community
In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of offers in response and use page for the page number. [i.e: If you have 100 offers and the first request has limit=20 and page=1, then in that case the recent 20 offers will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent offers will be returned.]
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 58`)get the list of offers
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"totalItemCount": 2,
"offers": [
{
"offer_id": 5,
"group_id": 23,
"owner_id": 18787,
"title": "SALE 40",
"description": "SALE 40",
"claim_count": -1,
"claimed": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"creation_date": "2016-07-01 07:40:25",
"sticky": 0,
"hotoffer": 0,
"url": "",
"coupon_code": "SALE 40",
"end_settings": 1,
"end_time": "2016-07-07 00:00:00",
"photo_id": 0,
"image": "http://example.com/public/images/nophoto_offer_thumb_profile.png",
"image_normal": "http://example.com/public/images/nophoto_offer_thumb_normal.png",
"image_profile": "http://example.com/public/images/nophoto_offer_thumb_profile.png",
"image_icon": "http://example.com/public/images/nophoto_offer_thumb_icon.png",
"content_url": "http://example.com/group-offers/18787/5/sale-40/tab/14765"
},
{
"offer_id": 4,
"group_id": 23,
"owner_id": 18787,
"title": "Sale 30",
"description": "FLAT 30% off on no minimum purchase.",
"claim_count": -1,
"claimed": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"creation_date": "2016-07-01 04:53:13",
"sticky": 0,
"hotoffer": 0,
"url": "",
"coupon_code": "SALE30",
"end_settings": 0,
"end_time": "0000-00-00 00:00:00",
"photo_id": 0,
"image": "http://example.com/public/images/nophoto_offer_thumb_profile.png",
"image_normal": "http://example.com/public/images/nophoto_offer_thumb_normal.png",
"image_profile": "http://example.com/public/images/nophoto_offer_thumb_profile.png",
"image_icon": "http://example.com/public/images/nophoto_offer_thumb_icon.png",
"content_url": "http://example.com/group-offers/18787/4/sale-30/tab/14765"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
View Offer ¶
View OfferGET/advancedgroups/offers/view/
Get the group offer view page information.
Example URI
- group_id (required, integer, `group_id
string
(required) Default: 947`)group id
- offer_id (required, integer, `offer_id
string
(required) Default: 947`)offer id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"offer_id": 4,
"group_id": 23,
"owner_id": 18787,
"title": "Sale 30",
"description": "FLAT 30% off on no minimum purchase.",
"claim_count": -1,
"claimed": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"creation_date": "2016-07-01 04:53:13",
"sticky": 0,
"hotoffer": 0,
"url": "",
"coupon_code": "SALE30",
"end_settings": 0,
"end_time": "0000-00-00 00:00:00",
"photo_id": 0,
"image": "http://example.com/public/images/nophoto_offer_thumb_profile.png",
"image_normal": "http://example.com/public/images/nophoto_offer_thumb_normal.png",
"image_profile": "http://example.com/images/nophoto_offer_thumb_profile.png",
"image_icon": "http://example.com/public/images/nophoto_offer_thumb_icon.png",
"content_url": "http://example.com/public/images/group-offers/18787/4/sale-30/tab/14765"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Groups / Communities Plugin / Events ¶
These are the APIs for the SocialEngineAddOns : Groups / Communities - Events Extension Plugin(https://www.socialengineaddons.com/groupextensions/socialengine-groups-communities-events).
Group Events Browse ¶
Group Events BrowseGET/advancedevents/index/
Get the Group Events listing.
Example URI
- parent_type (required, integer, `parent_id
string
(required) Default: sitegroup_group`)get the type of group events
- parent_id (required, integer, `parent_id
string
(required) Default: 58`)get the id of group events
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"canCreate": 1,
"getTotalItemCount": 2,
"response": [
{
"event_id": 1,
"title": "Watch Gallery",
"body": "Watch Gallery",
"owner_id": 1,
"profile_type": 8,
"photo_id": 5,
"category_id": 35,
"subcategory_id": 36,
"subsubcategory_id": 0,
"creation_date": "2016-01-05 06:34:13",
"modified_date": "2016-01-05 06:34:13",
"host_type": "user",
"host_id": 2,
"approved": 1,
"featured": 0,
"sponsored": 0,
"newlabel": 0,
"rating_avg": 0,
"rating_editor": 0,
"rating_users": 0,
"location": "Chicago, IL, United States",
"price": "0.00",
"review_count": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"member_count": 2,
"search": 1,
"closed": 0,
"approved_date": "2016-01-05 06:34:13",
"draft": 0,
"networks_privacy": null,
"venue_name": "naperville",
"approval": 1,
"parent_id": 1,
"parent_type": "user",
"is_online": 0,
"repeat_params": "",
"capacity": null,
"follow_count": 0,
"starttime": "2016-01-12 07:00:00",
"endtime": "2016-01-25 10:00:00",
"occurrence_id": 1,
"category_name": "Social",
"owner_image": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Jhon",
"image": "http://example.com/advancedevent/public/siteevent_event/05/0005_619d.jpg?c=6b22",
"image_normal": "http://example.com/advancedevent/public/siteevent_event/07/0007_34e6.jpg?c=5538",
"image_profile": "http://example.com/advancedevent/public/siteevent_event/06/0006_54bb.jpg?c=7af1",
"image_icon": "http://example.com/advancedevent/public/siteevent_event/09/0009_c8fb.jpg?c=57ad",
"content_url": "http://example.com/advancedevent/event-item/watch-gallery/1",
"hosted_by": {
"user_id": 2,
"username": "test1",
"displayname": "Alen J",
"photo_id": 1,
"status": null,
"status_date": null,
"locale": "English",
"language": "English",
"timezone": "US/Pacific",
"search": 1,
"show_profileviewers": 1,
"level_id": 4,
"invites_used": 0,
"extra_invites": 0,
"enabled": 1,
"verified": 1,
"approved": 1,
"creation_date": "2016-01-05 06:33:46",
"modified_date": "2016-01-05 06:33:46",
"lastlogin_date": "2016-01-05 06:33:46",
"update_date": null,
"member_count": 0,
"view_count": 0,
"image": "http://example.com/advancedevent/public/user/01/0001_2fb2.jpg?c=ac64",
"image_normal": "http://example.com/advancedevent/public/user/03/0003_08b4.jpg?c=9a1f",
"image_profile": "http://example.com/advancedevent/public/user/02/0002_4da1.jpg?c=5e42",
"image_icon": "http://example.com/advancedevent/public/user/04/0004_31cb.jpg?c=d10d",
"content_url": "http://example.com/advancedevent/profile/test1"
},
"ledby": [
{
"title": "Jhon",
"type": "user",
"id": 827
}
],
"allow_to_view": 1,
"edit": 1,
"delete": 1
},
{
"event_id": 2,
"title": "Spain Carnival is Back",
"body": "Spain Carnival is Back!!!:",
"owner_id": 1,
"profile_type": 6,
"photo_id": 10,
"category_id": 28,
"subcategory_id": 29,
"subsubcategory_id": 0,
"creation_date": "2016-01-05 06:36:29",
"modified_date": "2016-01-05 06:36:30",
"host_type": "user",
"host_id": 1,
"approved": 1,
"featured": 0,
"sponsored": 0,
"newlabel": 0,
"rating_avg": 0,
"rating_editor": 0,
"rating_users": 0,
"location": "Chicago, IL, United States",
"price": "0.00",
"review_count": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"member_count": 1,
"search": 1,
"closed": 0,
"approved_date": "2016-01-05 06:36:29",
"draft": 0,
"networks_privacy": null,
"venue_name": "naperville",
"approval": 1,
"parent_id": 1,
"parent_type": "user",
"is_online": 0,
"repeat_params": "",
"capacity": null,
"follow_count": 0,
"starttime": "2016-01-26 07:00:00",
"endtime": "2016-02-23 10:00:00",
"occurrence_id": 2,
"category_name": "Education",
"owner_image": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Jhon",
"image": "http://example.com/advancedevent/public/siteevent_event/0a/000a_87c8.jpg?c=7efd",
"image_normal": "http://example.com/advancedevent/public/siteevent_event/0c/000c_6c64.jpg?c=1db9",
"image_profile": "http://example.com/advancedevent/public/siteevent_event/0b/000b_3302.jpg?c=9d74",
"image_icon": "http://example.com/advancedevent/public/siteevent_event/0e/000e_35d8.jpg?c=3421",
"content_url": "http://example.com/advancedevent/event-item/spain-carnival-is-back/2",
"hosted_by": {
"host_type": "user",
"host_id": 5,
"host_title": "Michal",
"image": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"image_normal": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"image_profile": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"image_icon": "http://example.com/advancedevent/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"content_url": "http://example.com/advancedevent/profile/admin"
},
"ledby": [
{
"title": "Michal",
"type": "user",
"id": 562
}
],
"allow_to_view": 1,
"edit": 1,
"delete": 1
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Groups / Communities Plugin / Integration ¶
These are the APIs for the SocialEngineAddOns : Groups / Communities - Multiple Listings and Products Showcase Extension(https://www.socialengineaddons.com/groupextensions/socialengine-groups-communities-multiple-listings-products-showcase).
Group Listings Browse ¶
Group Listings BrowseGET/advancedgrouplistings/
Get the Group Listings listing.
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)get the type of listing
- group_id (required, integer, `group_id
string
(required) Default: 58`)get the products of particular group
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"totalItemCount":27,
"canCreate":1,
"response":[
{
"listing_id":28,
"title":"csc",
"body":"sc",
"owner_id":2,
"listingtype_id":1,
"profile_type":0,
"photo_id":0,
"category_id":10,
"subcategory_id":0,
"subsubcategory_id":0,
"creation_date":"2016-03-08 08:20:47",
"modified_date":"2016-03-08 08:20:47",
"end_date":null,
"approved":1,
"featured":0,
"sponsored":0,
"newlabel":0,
"rating_avg":0,
"rating_editor":0,
"rating_users":0,
"location":"",
"price":0,
"review_count":0,
"view_count":4,
"comment_count":0,
"like_count":0,
"search":1,
"closed":0,
"approved_date":"2016-03-08 08:20:47",
"draft":0,
"main_video":"",
"video_snapshot_id":0,
"networks_privacy":null,
"owner_image":"http://example.com/public/user/5f/005f_edbe.jpg?c=45ea",
"owner_image_normal":"http://example.com/public/user/61/0061_d6e4.jpg?c=761b",
"owner_image_profile":"http://example.com/public/user/60/0060_e6b3.jpg?c=73a2",
"owner_image_icon":"http://example.com/public/user/62/0062_8868.jpg?c=000a",
"owner_title":"William Thomas",
"image":"",
"image_normal":"",
"image_profile":"",
"image_icon":"",
"content_url":"http://example.com/product/28/csc",
"allow_to_view":1,
"edit":0,
"delete":0
},
{
"listing_id":23,
"title":"Super Car",
"body":"Super Car",
"owner_id":1,
"listingtype_id":1,
"profile_type":0,
"photo_id":440,
"category_id":33,
"subcategory_id":34,
"subsubcategory_id":35,
"creation_date":"2016-03-07 11:00:12",
"modified_date":"2016-03-07 11:00:12",
"end_date":null,
"approved":1,
"featured":0,
"sponsored":0,
"newlabel":0,
"rating_avg":0,
"rating_editor":0,
"rating_users":0,
"location":"Gurgaon, Haryana, India",
"price":20000,
"review_count":0,
"view_count":0,
"comment_count":0,
"like_count":0,
"search":1,
"closed":1,
"approved_date":"2016-03-07 11:00:12",
"draft":0,
"main_video":"",
"video_snapshot_id":0,
"networks_privacy":null,
"owner_image":"http://example.com/public/album_photo/1b/001b_2d0f.png?c=30f5",
"owner_image_normal":"http://example.com/public/album_photo/1c/001c_964a.png?c=1b80",
"owner_image_profile":"http://example.com/public/user/06/03/0303_d2ab.png?c=b069",
"owner_image_icon":"http://example.com/public/user/07/03/0304_c6a5.png?c=67f4",
"owner_title":"Admin",
"image":"http://example.com/public/sitereview_listing/b9/01/01b8_53a2.jpg?c=5c70",
"image_normal":"http://example.com/public/sitereview_listing/bb/01/01ba_1f8d.jpg?c=548f",
"image_profile":"http://example.com/public/sitereview_listing/ba/01/01b9_4ddb.jpg?c=2eac",
"image_icon":"http://example.com/public/sitereview_listing/bd/01/01bc_0304.jpg?c=fafb",
"content_url":"http://example.com/product/23/super-car",
"allow_to_view":1,
"edit":0,
"delete":0
},
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}