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]
Advanced Events Plugin ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Browse Events ¶
Browse EventsGET/advancedevents{?search}{&orderby}{&showEventType}{&1_5_23_field_23}{&1_8_37_field_98}{&page}{&limit}
Get the events listing. Events 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 events in response and use page
for the page number. [i.e: If you have 100 events and the first request has limit=20
and page=1
, then in that case the recent 20 events will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent events will be returned.]
Example URI
- search
string
(optional) Example: search=teacherget events that contain this keyword in title or description.
- category_id (optional, integer, `category_id
string
(required) Default: 13`)get all events of a particular category ID.
- orderby
string
(optional) Example: orderby=starttimeget event listings in the order of start time (
orderby=starttime
) or ascending order of price (orderby=priceLTH
) or descending order of price (orderby=priceHTL
) or order of title (orderby=title
) or order of sponsored and featured (orderby=fespfe
) or order of featured and sponsored (orderby=spfesp
) or order of viewcount (orderby=viewcount
).- showEventType
integer
(optional) Example: showEventType=upcomingget upcoming and ongoing events (
showEventType=upcoming
) or get upcoming events (showEventType=onlyUpcoming
) or get ongoing events (showEventType=onlyOngoing
) or get past events (showEventType=past
) or get all events (showEventType=all
)- 1_5_23_field_23
string
(optional) Example: 1_5_23_field_23=michalget events with matching value for this profile field. You can get the key name for profile field from the response of advanced event search form.
- 1_8_37_field_98
string
(optional) Example: 1_8_37_field_98=52get events with matching value for this profile field. You can get the key name for profile field from the response of advanced event search form.
- location
string
(optional) Example: location=Chicago, IL, United Statesget events belong to this location.
- locationmiles
integer
(optional) Example: locationmiles=100get events belong to within miles.
- latitude
string
(optional) Example: latitude=37.42245get events belong to this latitude.
- longitude
string
(optional) Example: longitude=-122.084086get events belong to this longitude.
- user_id (optional, integer, `user_id
string
(required) Default: 125`)user id of profile owner. Default value is logged-in user’s ID.
- page
integer
(optional) Example: page=2return the ‘limit’ number of events of that page of event listings.
- limit
integer
(optional) Example: limit=20number of events. Default limit is 20.
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."
}
My Events ¶
My EventsGET/advancedevents/manage{?search_text}{&rsvp}{&orderby}{&showEventType}{&1_5_23_field_23}{&1_8_37_field_98}{&location}{&locationmiles}{&latitude}{&longitude}{&page}{&limit}
Get the events of a member. Events 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 events in response and use page
for the page number. [i.e: If you have 100 events and the first request has limit=20
and page=1
, then in that case the recent 20 events will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent events will be returned.]
Example URI
- search_text
string
(optional) Example: search=teacherget events that contain this keyword in title or description.
- rsvp_form (optional, boolean, `rsvp_form
string
(required) Default: 1`)get the rsvp form with each event.
- category_id (optional, integer, `category_id
string
(required) Default: 13`)get all events of a particular category ID.
- rsvp
integer
(optional) Example: rsvp=-1get all events listing (
rsvp=-1
) or get leading events listing (rsvp=-4
) or get hosting events listing (rsvp=-2
) or get attending events listing (rsvp=2
) or get maybe attending events listing (rsvp=1
) or get not attending events listing (rsvp=0
) or get liked events listing (rsvp=-3
)- orderby
string
(optional) Example: orderby=starttimeget event listings in the order of start time (
orderby=starttime
) or ascending order of price (orderby=priceLTH
) or descending order of price (orderby=priceHTL
) or order of title (orderby=title
) or order of sponsored and featured (orderby=fespfe
) or order of featured and sponsored (orderby=spfesp
) or order of viewcount (orderby=viewcount
).- showEventType
integer
(optional) Example: showEventType=upcomingget upcoming and ongoing events (
showEventType=upcoming
) or get upcoming events (showEventType=onlyUpcoming
) or get ongoing events (showEventType=onlyOngoing
) or get past events (showEventType=past
) or get all events (showEventType=all
)- 1_5_23_field_23
string
(optional) Example: 1_5_23_field_23=michalget events with matching value for this profile field. You can get the key name for profile field from the response of advanced event search form.
- 1_8_37_field_98
string
(optional) Example: 1_8_37_field_98=52get events with matching value for this profile field. You can get the key name for profile field from the response of advanced event search form.
- location
string
(optional) Example: location=Chicago, IL, United Statesget events belong to this location.
- locationmiles
integer
(optional) Example: locationmiles=100get events belong to within miles.
- latitude
string
(optional) Example: latitude=37.42245get events belong to this latitude.
- longitude
string
(optional) Example: longitude=-122.084086get events belong to this longitude.
- user_id (optional, integer, `user_id
string
(required) Default: 125`)user id of profile owner. Default value is logged-in user’s ID.
- page
integer
(optional) Example: page=2return the ‘limit’ number of events of that page of event listings.
- limit
integer
(optional) Example: limit=20number of events. Default limit is 20.
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
{
"invite_count": 0,
"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,
"rsvp": 2,
"membership_userid": 1,
"category_name": "Social",
"ledby": [
{
"title": "Jhon",
"type": "user",
"id": 873
}
],
"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",
"hostText": "You are owner.",
"allow_to_view": 1,
"edit": 1,
"delete": 1,
"profile_rsvp_form": [
{
"type": "Select",
"name": "rsvp",
"multiOptions": {
"0": "Not Attending",
"1": "Maybe Attending",
"2": "Attending"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Submit"
}
],
"menu": [
{
"label": "Dashboard",
"name": "edit",
"url": "advancedevents/edit/1"
},
{
"label": "Cancel Event",
"name": "close",
"url": "advancedevents/index/close/1"
},
{
"label": "Delete",
"name": "delete",
"url": "advancedevents/index/delete/1"
},
{
"label": "Invite Guests",
"name": "invite",
"url": "advancedevents/member/invite1/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,
"rsvp": 2,
"membership_userid": 1,
"category_name": "Education",
"ledby": [
{
"title": "Michal",
"type": "user",
"id": 1
}
],
"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": "admin",
"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",
"hostText": "You are owner.",
"allow_to_view": 1,
"edit": 1,
"delete": 1,
"profile_rsvp_form": [
{
"type": "Select",
"name": "rsvp",
"multiOptions": {
"0": "Not Attending",
"1": "Maybe Attending",
"2": "Attending"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Submit"
}
],
"menu": [
{
"label": "Dashboard",
"name": "edit",
"url": "advancedevents/edit/2"
},
{
"label": "Cancel Event",
"name": "close",
"url": "advancedevents/index/close/2"
},
{
"label": "Delete",
"name": "delete",
"url": "advancedevents/index/delete/2"
},
{
"label": "Invite Guests",
"name": "invite",
"url": "advancedevents/member/invite2/2"
}
]
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Event Search Form ¶
Event Search FormGET/advancedevents/search-form
Get the events search form.
Example URI
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"form": [
{
"type": "Text",
"name": "search",
"label": "Search Events"
},
{
"type": "Select",
"name": "show",
"label": "Show",
"multiOptions": {
"1": "Everyone's Events",
"2": "Only My Friends' Events",
"4": "Events I Like"
}
},
{
"type": "Select",
"label": "View",
"name": "showEventType",
"multiOptions": {
"upcoming": "Upcoming & Ongoing",
"onlyUpcoming": "Upcoming",
"onlyOngoing": "Ongoing",
"past": "Past"
}
},
{
"type": "Select",
"label": "Occuring",
"name": "event_time",
"multiOptions": {
"": "",
"today": "Today",
"tomorrow": "Tomorrow",
"this_weekend": "This Weekend",
"this_week": "This Week",
"this_month": "This Month"
}
},
{
"type": "Text",
"name": "venue_name",
"label": "Venue"
},
{
"type": "Text",
"name": "location",
"label": "Location"
},
{
"type": "Select",
"label": "Proximity Within Miles",
"name": "proximity",
"multiOptions": {
"0": "",
"1": "1 Mile",
"2": "2 Miles",
"5": "5 Miles",
"10": "10 Miles",
"20": "20 Miles",
"50": "50 Miles",
"100": "100 Miles",
"250": "250 Miles",
"500": "500 Miles",
"750": "750 Miles",
"1000": "1000 Miles"
},
"value": 0
},
{
"type": "Text",
"name": "Siteevent_street",
"label": "Street"
},
{
"type": "Text",
"name": "Siteevent_city",
"label": "City"
},
{
"type": "Text",
"name": "Siteevent_state",
"label": "State"
},
{
"type": "Text",
"name": "Siteevent_country",
"label": "Country"
},
{
"type": "Select",
"label": "category_id",
"name": "Category",
"multioptions": {
"0": "",
"1": "Business & Technology",
"2": "Conferences",
"3": "Skill Development",
"4": "Trade Fair",
"6": "Conventions",
"7": "Educational",
"8": "Alumni Reunions",
"9": "Clubs",
"10": "Parties",
"11": "Travel",
"12": "Historical",
"13": "Educational",
"14": "Adventure",
"15": "Leisure",
"16": "Sports",
"18": "General Fitness",
"19": "Basketball",
"20": "Baseball",
"21": "Football",
"22": "Hockey",
"23": "Cricket",
"24": "Running",
"25": "Cycling",
"26": "Boxing",
"28": "Education",
"29": "Seminars & Webinars",
"30": "Classes & Workshops",
"35": "Social",
"36": "Fund Raising",
"37": "Social Events",
"38": "Charity",
"39": "Shopping",
"40": "Shopping Festival",
"41": "Discount Sale",
"42": "Product Launch",
"43": "Employment",
"44": "Job Fair",
"45": "Walk-in Recruitment",
"46": "On-campus Recruitment",
"47": "Festivals & Carnivals",
"48": "National",
"49": "Neighbourhood"
}
},
{
"type": "Date",
"name": "start",
"label": "From"
},
{
"type": "Date",
"name": "end",
"label": "To"
},
{
"type": "Submit",
"name": "submit",
"label": "Search"
}
],
"fields": {
"2": [
{
"type": "Text",
"name": "1_2_2_field_2",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_2_3_field_3",
"label": "Domain",
"description": ""
}
],
"3": [
{
"type": "Text",
"name": "1_3_4_field_4",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_3_5_field_5",
"label": "Agenda",
"description": ""
},
{
"type": "Select",
"name": "1_3_6_field_6",
"label": "Age Group",
"description": "",
"multiOptions": {
"12": "10-19",
"13": "20-29",
"14": "30-39",
"15": "40-49",
"16": "50-59",
"17": "60-99"
}
}
],
"4": [
{
"type": "Text",
"name": "1_4_7_field_7",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_4_8_field_8",
"label": "Things to get",
"description": ""
},
{
"type": "Radio",
"name": "1_4_9_field_9",
"label": "Guided",
"description": "",
"multiOptions": {
"18": "Escorted",
"19": "Self"
}
}
],
"5": [
{
"type": "Text",
"name": "1_5_10_field_10",
"label": "Custom Field",
"description": ""
}
],
"6": [
{
"type": "Text",
"name": "1_6_12_field_12",
"label": "Topic",
"description": ""
},
{
"type": "Text",
"name": "1_6_11_field_11",
"label": "Custom Field",
"description": ""
}
],
"8": [
{
"type": "Text",
"name": "1_8_15_field_15",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_8_16_field_16",
"label": "Name of NGO",
"description": ""
},
{
"type": "Select",
"name": "1_8_17_field_17",
"label": "Cause",
"description": "",
"multiOptions": {
"27": "Environmental",
"28": "Helping under-privileged",
"29": "Blood Donation",
"30": "General Awareness"
}
}
],
"9": [
{
"type": "Text",
"name": "1_9_18_field_18",
"label": "Custom Field",
"description": ""
}
],
"10": [
{
"type": "Text",
"name": "1_10_19_field_19",
"label": "Custom Field",
"description": ""
},
{
"type": "Select",
"name": "1_10_20_field_20",
"label": "Domain",
"description": "",
"multiOptions": {
"31": "Computer Engineering",
"32": "Banking",
"33": "Civil Engineering",
"34": "Education"
}
}
],
"11": [
{
"type": "Text",
"name": "1_11_21_field_21",
"label": "Custom Field",
"description": ""
}
]
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create Event ¶
Get Event Creation FormGET/advancedevents/create
Get the event creation form. Form divide in form
, host
and fields
section. Get the creation form in form
section, host information in host
section and profile fields information in fields
section.
Returns the form
, host
, and fields
as response. In form
we get the complete event form, in host
get host information and in fields
get profile fields information.
Example URI
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": "Event Title",
"hasValidator": "true"
},
{
"type": "Text",
"name": "venue_name",
"label": "Venue Name",
"hasValidator": "true"
},
{
"type": "Checkbox",
"name": "is_online",
"label": "Online"
},
{
"type": "Text",
"name": "location",
"description": "Eg: Fairview Park, Berkeley, CA",
"label": "Enter a location",
"autocomplete": "off",
"hasValidator": "true"
},
{
"type": "Select",
"name": "category_id",
"allowEmpty": 0,
"label": "Category",
"multiOptions": {
"1": "Business & Technology",
"6": "Conventions",
"11": "Travel",
"16": "Sports",
"28": "Education",
"35": "Social",
"39": "Shopping",
"43": "Employment",
"47": "Festivals & Carnivals"
},
"hasValidator": "true"
},
{
"Type": "Text",
"name": "tags",
"label": "Tags (Keywords)",
"description": "Separate tags with commas."
},
{
"type": "Date",
"name": "starttime",
"label": "Start Time",
"hasValidator": true
},
{
"type": "Date",
"name": "endtime",
"label": "End Time",
"hasValidator": true
},
{
"type": "file",
"name": "photo",
"label": "Main Photo"
},
{
"type": "textarea",
"name": "body",
"label": "Short Description",
"has Validators": "true"
},
{
"type": "textarea",
"name": "overview",
"label": "Overview",
"description": "Create a rich, attractive overview for your event. Switch the editor to Fullscreen mode by clicking on its icon below to comfortably create the overview.",
"editorOptions": {
"elements": "overview"
}
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this event?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"type": "Select",
"name": "auth_comment",
"label": "Comment Privacy",
"description": "Who may comment on this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
},
"value": "registered"
},
{
"type": "Select",
"name": "auth_topic",
"label": "Discussion Topic Privacy",
"description": "Who may post discussion topics for this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"type": "Select",
"name": "auth_photo",
"label": "Photo Privacy",
"description": "Who may upload photos for this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"Type": "Select",
"name": "auth_video",
"label": "Video Privacy",
"value": "member",
"description": "Who may add videos for this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"type": "Select",
"name": "draft",
"label": "Status",
"multiOptions": [
"Published",
"Saved As Draft"
],
"value": 0,
"description": "If this event is published, it cannot be switched back to draft mode."
},
{
"type": "Radio",
"name": "approval",
"label": "Approve members?",
"description": "When people try to join this event, should they be allowed to join immediately, or should they be forced to wait for approval?",
"multiOptions": [
"New members can join immediately this event.",
"New members must be approved to join this event."
],
"value": "1"
},
{
"Type": "Checkbox",
"name": "auth_invite",
"value": true,
"label": "Invited guests can invite other people as well."
},
{
"type": "Checkbox",
"name": "search",
"label": "Show this event on browse page and in various blocks.",
"value": 1
},
{
"label": "Create",
"type": "Submit",
"name": "submit"
}
],
"host": {
"host_type": "user",
"host_id": 1,
"host_title": "Michal",
"image_icon": {
"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"
}
},
"fields": {
"2": [
{
"type": "Text",
"name": "1_2_2_field_2",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_2_3_field_3",
"label": "Domain",
"description": ""
}
],
"3": [
{
"type": "Text",
"name": "1_3_4_field_4",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_3_5_field_5",
"label": "Agenda",
"description": ""
},
{
"type": "Select",
"name": "1_3_6_field_6",
"label": "Age Group",
"description": "",
"multiOptions": {
"12": "10-19",
"13": "20-29",
"14": "30-39",
"15": "40-49",
"16": "50-59",
"17": "60-99"
}
}
],
"4": [
{
"type": "Text",
"name": "1_4_7_field_7",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_4_8_field_8",
"label": "Things to get",
"description": ""
},
{
"type": "Radio",
"name": "1_4_9_field_9",
"label": "Guided",
"description": "",
"multiOptions": {
"18": "Escorted",
"19": "Self"
}
}
],
"5": [
{
"type": "Text",
"name": "1_5_10_field_10",
"label": "Custom Field",
"description": ""
}
],
"6": [
{
"type": "Text",
"name": "1_6_12_field_12",
"label": "Topic",
"description": ""
},
{
"type": "Text",
"name": "1_6_11_field_11",
"label": "Custom Field",
"description": ""
}
],
"8": [
{
"type": "Text",
"name": "1_8_15_field_15",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_8_16_field_16",
"label": "Name of NGO",
"description": ""
},
{
"type": "Select",
"name": "1_8_17_field_17",
"label": "Cause",
"description": "",
"multiOptions": {
"27": "Environmental",
"28": "Helping under-privileged",
"29": "Blood Donation",
"30": "General Awareness"
}
}
],
"9": [
{
"type": "Text",
"name": "1_9_18_field_18",
"label": "Custom Field",
"description": ""
}
],
"10": [
{
"type": "Text",
"name": "1_10_19_field_19",
"label": "Custom Field",
"description": ""
},
{
"type": "Select",
"name": "1_10_20_field_20",
"label": "Domain",
"description": "",
"multiOptions": {
"31": "Computer Engineering",
"32": "Banking",
"33": "Civil Engineering",
"34": "Education"
}
}
],
"11": [
{
"type": "Text",
"name": "1_11_21_field_21",
"label": "Custom Field",
"description": ""
}
]
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create EventPOST/advancedevents/create
Create a new event by posting the event creation form.
To upload the event photo, send the file in multipart / form-data
format with the photo
API request parameters.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Blood Donation Camp | event title |
is_online |
no | boolean | 0 | make an event online (1 ) or not (0 ) |
venue_name |
no | string | S-3 Square, New York | event venue name |
location |
no | string | New York, NY, United States | event location |
category_id |
yes | integer | 5 | category id |
tags |
no | string | banking, operations | video tags (comma separated) |
starttime |
no | string | 2015-06-12 12:42:45 | event start time |
endtime |
no | string | 2015-10-12 12:42:45 | event end time |
body |
no | string | Donated blood is a lifeline for many people needing… | event short description |
overview |
no | string | Donated blood is a lifeline for many people needing… | event overview |
auth_view |
yes | string | everyone | view authorization (owner, owner_member, owner_network, etc.) |
auth_comment |
yes | string | everyone | comment authorization (owner, owner_member, owner_network, etc.) |
auth_topic |
yes | string | owner_network | post discussion topic authorization (registered, owner_network, owner_member_member, etc.) |
auth_photo |
yes | string | officer | upload photo authorization (owner, owner_member, owner_network, etc.) |
auth_video |
yes | string | member | upload video authorization (registered, owner_member, owner_network, etc.) |
1_2_24_field_24 |
no | string | How are you Michal? | Get the profile field value. |
draft |
yes | boolean | 1 | make an event published (0 ) or saved as draft (1 ) |
approval |
yes | boolean | 1 | new members can join immediately this event (0 ) or new members must be approved to join this event (1 ) |
auth_invite |
no | boolean | 1 | invited guests can invite other people as well. |
search |
no | boolean | 1 | show this event on browse page and in various blocks. |
Example URI
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Blood Donation Camp",
"is_online": "0",
"venue_name": "S-3 Square, New York",
"location": "New York, NY, United States",
"category_id": 3,
"tags":"banking, operations",
"starttime": "2015-06-12 12:42:45",
"endtime": "2015-10-12 12:42:45",
"body": "Donated blood is a lifeline for many people needing long-term treatments.",
"overview": "Donated blood is a lifeline for many people needing long-term treatments, not just in emergencies. Your blood's main components: red cells, plasma and platelets are vital for many different uses. ",
"auth_view": "everyone",
"auth_comment": "everyone"
"auth_topic": "owner_network",
"auth_photo": "owner_network",
"auth_video": "owner_network",
"1_2_24_field_24": "How are you Michal?",
"draft": "1",
"approval": "1",
"auth_invite": "1",
"search": "1"
}
200
Headers
Content-Type: application/json
Body
{
"gutterMenu": [
{
"name": "invite",
"label": "Invite Guests",
"url": "advancedevents/member/invite/129",
"urlParams": {}
},
{
"label": "Edit",
"name": "edit",
"url": "advancedevents/edit/129",
"urlParams": []
},
{
"name": "editoverview",
"label": "Edit Overview",
"url": "advancedevents/edit-overview/129",
"urlParams": []
},
{
"name": "share",
"label": "Share",
"url": "activity/share",
"urlParams": {
"type": "event",
"id": 129
}
},
{
"name": "tellafriend",
"label": "Tell a friend",
"url": "advancedevents/tellafriend/129",
"urlParams": []
},
{
"label": "Cancel Event",
"name": "close",
"url": "advancedevents/close/129",
"urlParams": []
},
{
"name": "delete",
"label": "Delete",
"url": "advancedevents/delete/129",
"urlParams": {}
},
{
"name": "report",
"label": "Report This Event",
"url": "report/create/subject/siteevent_event_129",
"urlParams": {}
},
{
"name": "diary",
"label": "Add To Diary",
"url": "advancedevents/add-diary/129",
"urlParams": {}
}
],
"profile_tabs": [
{
"label": "Updates",
"name": "update",
"totalItemCount": 0
},
{
"label": "Guests",
"name": "members",
"totalItemCount": 1,
"url": "events/member/list/2",
"urlParams": []
},
{
"label": "Photos",
"name": "photos",
"totalItemCount": 1,
"url": "events/photo/list",
"urlParams": {
"event_id": 2
}
},
{
"label": "Discussions",
"name": "discussion",
"body": [],
"totalItemCount": 0
},
{
"label": "Videos",
"name": "video",
"totalItemCount": 0
},
{
"label": "Description",
"name": "description"
},
{
"label": "Information",
"name": "information"
},
{
"label": "Map",
"name": "map"
}
],
"profile_rsvp_form": [
{
"type": "Select",
"name": "rsvp",
"multiOptions": {
"0": "Not Attending",
"1": "Maybe Attending",
"2": "Attending"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Submit"
}
],
"response": {
"event_id": 129,
"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,
"isMember": 1,
"canUpload": 1,
"starttime": "2016-01-26 07:00:00",
"endtime": "2016-02-23 10:00:00",
"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/michal"
},
"ledby": [
{
"title": "Michal",
"type": "user",
"id": 562
}
],
"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",
"owner_title": "Michal",
"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",
"get_attending_count": 1,
"get_maybe_count": 0,
"get_not_attending_count": 0,
"get_awaiting_reply_count": 0
}
}
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."
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Event Profile ¶
Event ProfileGET/advancedevents/view/
Get a event post and its gutter menu’s (edit, invite, share, delete) and profile tab’s (update, members, photos) with count information and event RSVP form.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 878`)event id
- gutter_menu (optional, boolean, `gutter_menu
string
(required) Default: 1 OR 0`)get gutter menu’s array. Default valus is 1.
- profile_tabs (optional, boolean, `profile_tabs
string
(required) Default: 1 OR 0`)get profile tab’s array. Default valus is 1.
- rsvp_form (optional, boolean, `rsvp_form
string
(required) Default: 1 OR 0`) ... get RSVP form (`rsvp_form=1`) or not (`rsvp_form=0`). Default valus is 0.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"gutterMenu": [
{
"name": "invite",
"label": "Invite Guests",
"url": "advancedevents/member/invite/129",
"urlParams": {}
},
{
"label": "Edit",
"name": "edit",
"url": "advancedevents/edit/129",
"urlParams": []
},
{
"name": "editoverview",
"label": "Edit Overview",
"url": "advancedevents/edit-overview/129",
"urlParams": []
},
{
"name": "share",
"label": "Share",
"url": "activity/share",
"urlParams": {
"type": "event",
"id": 129
}
},
{
"name": "tellafriend",
"label": "Tell a friend",
"url": "advancedevents/tellafriend/129",
"urlParams": []
},
{
"label": "Cancel Event",
"name": "close",
"url": "advancedevents/close/129",
"urlParams": []
},
{
"name": "delete",
"label": "Delete",
"url": "advancedevents/delete/129",
"urlParams": {}
},
{
"name": "report",
"label": "Report This Event",
"url": "report/create/subject/siteevent_event_129",
"urlParams": {}
},
{
"name": "diary",
"label": "Add To Diary",
"url": "advancedevents/add-diary/129",
"urlParams": {}
}
],
"profile_tabs": [
{
"label": "Updates",
"name": "update",
"totalItemCount": 0
},
{
"label": "Guests",
"name": "members",
"totalItemCount": 1,
"url": "events/member/list/2",
"urlParams": []
},
{
"label": "Photos",
"name": "photos",
"totalItemCount": 1,
"url": "events/photo/list",
"urlParams": {
"event_id": 2
}
},
{
"label": "Discussions",
"name": "discussion",
"body": [],
"totalItemCount": 0
},
{
"label": "Videos",
"name": "video",
"totalItemCount": 0
},
{
"label": "Description",
"name": "description"
},
{
"label": "Information",
"name": "information"
},
{
"label": "Map",
"name": "map"
}
],
"profile_rsvp_form": [
{
"type": "Select",
"name": "rsvp",
"multiOptions": {
"0": "Not Attending",
"1": "Maybe Attending",
"2": "Attending"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Submit"
}
],
"response": {
"event_id": 129,
"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,
"isMember": 1,
"canUpload": 1,
"starttime": "2016-01-26 07:00:00",
"endtime": "2016-02-23 10:00:00",
"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/michal"
},
"ledby": [
{
"title": "Michal",
"type": "user",
"id": 567
}
],
"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",
"owner_title": "Michal",
"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",
"get_attending_count": 1,
"get_maybe_count": 0,
"get_not_attending_count": 0,
"get_awaiting_reply_count": 0
}
}
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"
}
Edit Event ¶
Get Edit Event FormGET/advancedevents/edit/
Get the form for editing a event-post.
Returns the form
, host
, fields
and formValues
as response. In form
we get the complete event form, in host
get host information, in fields
get profile fields information and in formValues
we get the form’s values.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 878`)event id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Accept: application/json
Body
{
"form": [
{
"type": "Text",
"name": "title",
"label": "Event Title",
"hasValidator": "true"
},
{
"type": "Text",
"name": "venue_name",
"label": "Venue Name",
"hasValidator": "true"
},
{
"type": "Checkbox",
"name": "is_online",
"label": "Online"
},
{
"type": "Select",
"name": "category_id",
"allowEmpty": 0,
"label": "Category",
"multiOptions": {
"1": "Business & Technology",
"6": "Conventions",
"11": "Travel",
"16": "Sports",
"28": "Education",
"35": "Social",
"39": "Shopping",
"43": "Employment",
"47": "Festivals & Carnivals"
},
"hasValidator": "true"
},
{
"Type": "Text",
"name": "tags",
"label": "Tags (Keywords)",
"description": "Separate tags with commas."
},
{
"type": "Date",
"name": "starttime",
"label": "Start Time",
"hasValidator": true
},
{
"type": "Date",
"name": "endtime",
"label": "End Time",
"hasValidator": true
},
{
"type": "textarea",
"name": "body",
"label": "Short Description",
"has Validators": "true"
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this event?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"type": "Select",
"name": "auth_comment",
"label": "Comment Privacy",
"description": "Who may comment on this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
},
"value": "registered"
},
{
"type": "Select",
"name": "auth_post",
"label": "Posting Updates Privacy",
"description": "Who may post updates on this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"type": "Select",
"name": "auth_topic",
"label": "Discussion Topic Privacy",
"description": "Who may post discussion topics for this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"type": "Select",
"name": "auth_photo",
"label": "Photo Privacy",
"description": "Who may upload photos for this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"Type": "Select",
"name": "auth_video",
"label": "Video Privacy",
"value": "member",
"description": "Who may add videos for this event?",
"multiOptions": {
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"member": "Event Guests Only",
"leader": "Owner and Leaders Only"
}
},
{
"type": "Radio",
"name": "approval",
"label": "Approve members?",
"description": "When people try to join this event, should they be allowed to join immediately, or should they be forced to wait for approval?",
"multiOptions": [
"New members can join immediately this event.",
"New members must be approved to join this event."
],
"value": "1"
},
{
"Type": "Checkbox",
"name": "auth_invite",
"value": true,
"label": "Invited guests can invite other people as well."
},
{
"type": "Checkbox",
"name": "search",
"label": "Show this event on browse page and in various blocks.",
"value": 1
},
{
"label": "Create",
"type": "Submit",
"name": "submit"
}
],
"hosted_by": {
"host_type": "user",
"host_id": 5,
"host_title": "Michal",
"image_icon": {
"image": "http://example.com/siteapi/public/user/19/0019_0473.png?c=8e31",
"image_normal": "http://example.com/siteapi/public/user/1b/001b_def2.png?c=d1d0",
"image_profile": "http://example.com/siteapi/public/user/1a/001a_eb9b.png?c=84b4",
"image_icon": "http://example.com/siteapi/public/user/1c/001c_ed2f.png?c=5bd9",
"content_url": "http://example.com/siteapi/profile/admin"
}
},
"fields": {
"2": [
{
"type": "Text",
"name": "1_2_2_field_2",
"label": "Custom",
"description": ""
},
{
"type": "Text",
"name": "1_2_3_field_3",
"label": "Domain",
"description": ""
},
{
"type": "Text",
"name": "1_2_24_field_24",
"label": "Location",
"description": "",
"hasValidator": true
}
],
"3": [
{
"type": "Text",
"name": "1_3_4_field_4",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_3_5_field_5",
"label": "Agenda",
"description": ""
},
{
"type": "Select",
"name": "1_3_6_field_6",
"label": "Age Group",
"description": "",
"multiOptions": {
"12": "10-19",
"13": "20-29",
"14": "30-39",
"15": "40-49",
"16": "50-59",
"17": "60-99"
}
}
],
"4": [
{
"type": "Text",
"name": "1_4_7_field_7",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_4_8_field_8",
"label": "Things to get",
"description": ""
},
{
"type": "Radio",
"name": "1_4_9_field_9",
"label": "Guided",
"description": "",
"multiOptions": {
"18": "Escorted",
"19": "Self"
}
}
],
"5": [
{
"type": "Textarea",
"name": "1_5_23_field_23",
"label": "test2",
"description": ""
},
{
"type": "Text",
"name": "1_5_10_field_10",
"label": "Custom Field",
"description": ""
},
{
"type": "Radio",
"name": "1_5_22_field_22",
"label": "test",
"description": "test",
"multiOptions": {
"36": "yes",
"37": "no"
}
}
],
"6": [
{
"type": "Text",
"name": "1_6_12_field_12",
"label": "Topic",
"description": ""
},
{
"type": "Text",
"name": "1_6_11_field_11",
"label": "Custom Field",
"description": ""
}
],
"8": [
{
"type": "Text",
"name": "1_8_15_field_15",
"label": "Custom Field",
"description": ""
},
{
"type": "Text",
"name": "1_8_16_field_16",
"label": "Name of NGO",
"description": ""
},
{
"type": "Select",
"name": "1_8_17_field_17",
"label": "Cause",
"description": "",
"multiOptions": {
"27": "Environmental",
"28": "Helping under-privileged",
"29": "Blood Donation",
"30": "General Awareness"
}
}
],
"9": [
{
"type": "Text",
"name": "1_9_18_field_18",
"label": "Custom Field",
"description": ""
}
],
"10": [
{
"type": "Text",
"name": "1_10_19_field_19",
"label": "Custom Field",
"description": ""
},
{
"type": "Select",
"name": "1_10_20_field_20",
"label": "Domain",
"description": "",
"multiOptions": {
"31": "Computer Engineering",
"32": "Banking",
"33": "Civil Engineering",
"34": "Education"
}
}
],
"11": [
{
"type": "Text",
"name": "1_11_21_field_21",
"label": "Custom Field",
"description": ""
}
],
"35": [
{
"type": "Text",
"name": "1_35_2_field_2",
"label": "Custom",
"description": ""
}
]
},
"formValues": {
"event_id": 268,
"package_id": 0,
"title": "Watch Gallery",
"body": "Watch Gallery",
"owner_id": 5,
"profile_type": 35,
"photo_id": 0,
"category_id": 1,
"subcategory_id": 0,
"subsubcategory_id": 0,
"creation_date": "2016-01-09 10:06:37",
"modified_date": "2016-01-09 10:06:37",
"expiration_date": "2250-01-01 00:00:00",
"payment_date": null,
"host_type": "user",
"host_id": 5,
"approved": 1,
"featured": 0,
"sponsored": 0,
"newlabel": 0,
"rating_avg": 0,
"rating_editor": 0,
"rating_users": 0,
"location": "",
"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-09 10:06:37",
"draft": 0,
"networks_privacy": null,
"venue_name": "",
"approval": 1,
"parent_id": 5,
"parent_type": "user",
"is_online": 0,
"repeat_params": "",
"capacity": null,
"follow_count": 0,
"status": "initial",
"pending": 0,
"1_2_24_field_24": "How are you Michal?"
}
}
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"
}
Edit EventPUT/advancedevents/edit/
Edit a event-post.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Blood Donation Camp | event title |
is_online |
no | boolean | 0 | make an event online (1 ) or not (0 ) |
venue_name |
no | string | S-3 Square, New York | event venue name |
location |
no | string | New York, NY, United States | event location |
category_id |
yes | integer | 5 | category id |
tags |
no | string | banking, operations | video tags (comma separated) |
starttime |
no | string | 2015-06-12 12:42:45 | event start time |
endtime |
no | string | 2015-10-12 12:42:45 | event end time |
body |
no | string | Donated blood is a lifeline for many people needing… | event short description |
overview |
no | string | Donated blood is a lifeline for many people needing… | event overview |
auth_view |
yes | string | everyone | view authorization (owner, owner_member, owner_network, etc.) |
auth_comment |
yes | string | everyone | comment authorization (owner, owner_member, owner_network, etc.) |
auth_topic |
yes | string | owner_network | post discussion topic authorization (registered, owner_network, owner_member_member, etc.) |
auth_photo |
yes | string | officer | upload photo authorization (owner, owner_member, owner_network, etc.) |
auth_video |
yes | string | member | upload video authorization (registered, owner_member, owner_network, etc.) |
1_2_24_field_24 |
no | string | How are you Michal? | Get the profile field value. |
draft |
yes | boolean | 1 | make an event published (0 ) or saved as draft (1 ) |
approval |
yes | boolean | 1 | new members can join immediately this event (0 ) or new members must be approved to join this event (1 ) |
auth_invite |
no | boolean | 1 | invited guests can invite other people as well. |
search |
no | boolean | 1 | show this event on browse page and in various blocks. |
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 878`)event id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Blood Donation Camp",
"is_online": "0",
"venue_name": "S-3 Square, New York",
"location": "New York, NY, United States",
"category_id": 3,
"tags":"banking, operations",
"starttime": "2015-06-12 12:42:45",
"endtime": "2015-10-12 12:42:45",
"body": "Donated blood is a lifeline for many people needing long-term treatments.",
"overview": "Donated blood is a lifeline for many people needing long-term treatments, not just in emergencies. Your blood's main components: red cells, plasma and platelets are vital for many different uses. ",
"auth_view": "everyone",
"auth_comment": "everyone"
"auth_topic": "owner_network",
"auth_photo": "owner_network",
"auth_video": "owner_network",
"1_2_24_field_24": "How are you Michal?",
"draft": "1"
"approval": "1"
"auth_invite": "1"
"search": "1"
}
204
400
Body
{
"status_code": 400,
"error": true,
"error_code": "validation_fail",
"message": {
"title": "Please complete this field - it is required.",
"description": "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."
}
Delete Event ¶
Delete EventDELETE/advancedevents/delete/
Delete a event-post.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 878`)event 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"
}
Event Organizer Profile ¶
Event Organizer ProfileGET/advancedevents/organizer/
Get event organizer profile and its events.
Example URI
- organizer_id (required, integer, `organizer_id
string
(required) Default: 878`)organizer id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"organizer_id": 1,
"title": "Make My Trip",
"description": "",
"creator_id": 4,
"facebook_url": null,
"twitter_url": null,
"web_url": null,
"photo_id": 0,
"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",
"countOrganizedEvent": 1,
"totalRating": 5,
"canCreate": 0,
"getTotalItemCount": 1,
"events": [
{
"event_id": 14,
"title": "Thailand Trip",
"body": "Super Awesome trip",
"owner_id": 4,
"profile_type": 3,
"photo_id": 133,
"category_id": 6,
"subcategory_id": 0,
"subsubcategory_id": 0,
"creation_date": "2016-02-02 07:31:36",
"modified_date": "2016-02-05 14:17:22",
"host_type": "siteevent_organizer",
"host_id": 1,
"approved": 1,
"featured": 0,
"sponsored": 0,
"newlabel": 0,
"rating_avg": 5,
"rating_editor": 0,
"rating_users": 5,
"location": "",
"price": 0,
"review_count": 1,
"view_count": 24,
"comment_count": 0,
"like_count": 0,
"member_count": 2,
"search": 1,
"closed": 0,
"approved_date": "2016-02-02 07:31:36",
"draft": 0,
"networks_privacy": null,
"venue_name": "",
"approval": 1,
"parent_id": 4,
"parent_type": "user",
"is_online": 0,
"repeat_params": "",
"capacity": null,
"follow_count": 0,
"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",
"image": "http://example.com/public/siteevent_event/85/0085_a752.png?c=d6a5",
"image_normal": "http://example.com/public/siteevent_event/86/0086_3c2e.png?c=9fa6",
"image_profile": "http://example.com/public/siteevent_event/85/0085_a752.png?c=d6a5",
"image_icon": "http://example.com/public/siteevent_event/88/0088_3612.png?c=99b3",
"content_url": "http://example.com/event-item/sample/14"
}
]
}
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"
}
Event Categories Listing ¶
Event Categories ListingsGET/advancedevents/categories{&showEvents}
Get event categories, sub-categories or subsub-categories listings and its events.
Example URI
- category_id (optional, integer, `category_id
string
(required) Default: 878`)category_id
- subCategory_id (optional, integer, `subCategory_id
string
(required) Default: 878`)subCategory_id
- subsubcategory_id (optional, integer, `subsubcategory_id
string
(required) Default: 878`)subsubcategory_id
- showEvents
boolean
(optional) Example: showEvents=0By default 1
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"categories":[
{
"category_id":1,
"category_name":"Business & Technology",
"order":0,
"images":{
"image":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png",
"image_normal":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png",
"image_profile":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png",
"image_icon":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png"
}
},
{
"category_id":43,
"category_name":"Employment",
"order":0,
"images":{
"image":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png",
"image_normal":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png",
"image_profile":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png",
"image_icon":"http://example.com/application/modules/Sitevent/externals/images/nophoto_event_caregory.png"
}
},
"subCategories":[
{
"sub_cat_id":2,
"sub_cat_name":"Conferences",
"order":0
},
{
"sub_cat_id":3,
"sub_cat_name":"Skill Development",
"order":0
},
{
"sub_cat_id":4,
"sub_cat_name":"Trade Fair",
"order":0
}
],
"events":[
{
"event_id":16,
"imageSrc":{
"image":"http://example.com/public/siteevent_event/71/0071_19a9.jpg?c=fb22",
"image_normal":"http://example.com/public/siteevent_event/73/0073_90ac.jpg?c=29db",
"image_profile":"http://example.com/public/siteevent_event/72/0072_f4de.jpg?c=01e6",
"image_icon":"http://example.com/public/siteevent_event/75/0075_95c4.jpg?c=958c",
"content_url":"http://example.com/event-item/international-conference-on-computer-science/16"
},
"event_title":"International Conference on Computer science",
"owner_id":1,
"popularityCount":6,
"slug":"international-conference-on-computer-science",
"starttime":"2016-03-31 00:00:00",
"endtime":"2016-03-31 03:00:00",
"host":{
"host_type":"user",
"host_id":1,
"host_title":"Martina",
"image_icon":{
"image":"http://example.com/public/user/17/0017_2d0f.png?c=30f5",
"image_normal":"http://example.com/public/user/19/0019_964a.png?c=1b80",
"image_profile":"http://example.com/public/user/18/0018_d2ab.png?c=b069",
"image_icon":"http://example.com/public/user/1a/001a_c6a5.png?c=67f4",
"content_url":"http://example.com/profile/admin"
},
"event_hosted":11
}
}
]
}
Advanced Events Plugin / Diary ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Diaries Browse ¶
Diaries BrowseGET/advancedevents/diaries{?search}{&orderby}{&member}{&page}{&limit}
Get the diaries listing. Diaries 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 diaries in response and use page
for the page number. [i.e: If you have 100 diaries and the first request has limit=20
and page=1
, then in that case the recent 20 diaries will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent diaries will be returned.]
Example URI
- search
string
(optional) Example: search=teacherget diaries that contain this keyword in title or description.
- search_diaries (optional, string, `search_diaries
string
(required) Default: my_diaries`) ... get My Diaries(`search_diaries=my_diaries`) or get Friends Diaries (`search_diaries=friends_diaries`).- orderby
string
(optional) Example: orderby=diary_idget video listings in the order Recent Diaries created (
orderby=diary_id
) or the total no of Events in the diary (orderby=total_item
) or the maximum no of user views (orderby=view_count
).- member
string
(optional) Example: member=Alenget Alen J’s Daries(
member=Alen
)- page
integer
(optional) Example: page=2return the ‘limit’ number of diaries of that page of diary listings.
- limit
integer
(optional) Example: limit=20number of events. Default limit is 20.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"totalItemCount": 3,
"can_create": 0,
"response": [
{
"diary_id": 7,
"title": "Marriage",
"body": "Collection of marriage events",
"owner_id": 2,
"event_id": 15,
"creation_date": "2016-02-02 06:18:37",
"modified_date": "2016-02-02 07:36:29",
"view_count": 0,
"total_item": 3,
"event_images_1": {
"image": "http://example.com/public/siteevent_event/6b/006b_df74.jpg?c=43dd",
"image_normal": "http://example.com/public/siteevent_event/6d/006d_8e9f.jpg?c=eb71",
"image_profile": "http://example.com/public/siteevent_event/6c/006c_873e.jpg?c=c205",
"image_icon": "http://example.com/public/siteevent_event/6f/006f_128c.jpg?c=230e",
"content_url": "http://example.com/event-item/trip-to-dehradun/15"
},
"event_images_2": {
"image": "http://example.com/public/siteevent_event/65/0065_2b5a.jpg?c=14d5",
"image_normal": "http://example.com/public/siteevent_event/67/0067_9faa.jpg?c=0d77",
"image_profile": "http://example.com/public/siteevent_event/66/0066_45f9.jpg?c=6c24",
"image_icon": "http://example.com/public/siteevent_event/69/0069_0c32.jpg?c=1942",
"content_url": "http://example.com/event-item/trip-to-sitlakhet/13"
},
"event_images_3": {
"image": "http://example.com/public/siteevent_event/5a/005a_c18e.jpg?c=bff3",
"image_normal": "http://example.com/public/siteevent_event/5c/005c_d7b6.jpg?c=fd5b",
"image_profile": "http://example.com/public/siteevent_event/5b/005b_6815.jpg?c=f3b2",
"image_icon": "http://example.com/public/siteevent_event/5e/005e_813c.jpg?c=0e70",
"content_url": "http://example.com/event-item/world-t20-2016/12"
}
},
{
"diary_id": 2,
"title": "Harry Series",
"body": "Collection of HP",
"owner_id": 2,
"event_id": 11,
"creation_date": "2016-01-29 05:23:39",
"modified_date": "2016-01-29 05:23:39",
"view_count": 68,
"total_item": 1,
"event_images_1": {
"image": "http://example.com/public/siteevent_event/55/0055_92b8.jpg?c=c3a4",
"image_normal": "http://example.com/public/siteevent_event/57/0057_784b.jpg?c=d26c",
"image_profile": "http://example.com/public/siteevent_event/56/0056_92b8.jpg?c=c3a4",
"image_icon": "http://example.com/public/siteevent_event/59/0059_e8fa.jpg?c=1d66",
"content_url": "http://example.com/event-item/harry-potter-diaries/11"
}
},
{
"diary_id": 1,
"title": "My Trip ",
"body": "Trips thats are organised by me",
"owner_id": 1,
"event_id": 8,
"creation_date": "2016-01-21 06:34:52",
"modified_date": "2016-01-21 06:34:52",
"view_count": 83,
"total_item": 2,
"event_images_1": {
"image": "http://example.com/public/siteevent_event/55/0055_92b8.jpg?c=c3a4",
"image_normal": "http://example.com/public/siteevent_event/57/0057_784b.jpg?c=d26c",
"image_profile": "http://example.com/public/siteevent_event/56/0056_92b8.jpg?c=c3a4",
"image_icon": "http://example.com/public/siteevent_event/59/0059_e8fa.jpg?c=1d66",
"content_url": "http://example.com/event-item/harry-potter-diaries/11"
},
"event_images_2": {
"image": "http://example.com/public/siteevent_event/38/0038_80c3.jpg?c=e911",
"image_normal": "http://example.com/public/siteevent_event/3a/003a_dbc4.jpg?c=88a6",
"image_profile": "http://example.com/public/siteevent_event/39/0039_4278.jpg?c=c810",
"image_icon": "http://example.com/public/siteevent_event/3c/003c_ab2f.jpg?c=ae97",
"content_url": "http://example.com/event-item/international-kites-festival/8"
}
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Diary Search Form ¶
Diary Search FormGET/advancedevents/diaries/search-form
Get diares search form.
Example URI
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
[
{
"type": "Text",
"name": "search",
"label": "Search"
},
{
"type": "Select",
"name": "search_diary",
"label": "Diaries",
"multiOptions": {
"": "",
"my_diaries": "My Event Diaries",
"friends_diaries": "My Friends Event Diaries"
}
},
{
"type": "Text",
"name": "member",
"label": "Member's Name/Email"
},
{
"type": "Select",
"name": "orderby",
"label": "Browse By",
"multiOptions": {
"diary_id": "Most Recent",
"total_item": "Maximum Events",
"view_count": "Most Viewed"
}
},
{
"type": "Submit",
"name": "done",
"label": "Search"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create Diary ¶
Get Diary Create FormGET/advancedevents/diaries/create
Get Diary creation form.
Example URI
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": "Diary Name",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "body",
"label": "Description"
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this diary?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"owner": "Just Me"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Save"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create DiaryPOST/advancedevents/diaries/create
Create a new Diary by posting the diary creation form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Adventure Events | event title |
body |
no | string | Collection of adventurous events | event content |
auth_view |
yes | string | everyone | view authorization (owner, owner_member, owner_network, etc.) |
Example URI
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Adventure Events",
"body": "Collection of adventurous events ",
"auth_view": "everyone"
}
200
Headers
Content-Type: application/json
Body
{
"response": {
"diary_id": 8,
"title": "Adventure Events",
"body": "Collection of adventurous events",
"owner_id": 4,
"event_id": 0,
"creation_date": "2016-02-04 12:55:17",
"modified_date": "2016-02-04 12:55:17",
"view_count": 0,
"diary_creator_name": "John Adams",
"owner_image": "http://example.com/public/siteevent_event/39/0039_4278.jpg",
"owner_image_normal": "http://example.com/public/siteevent_event/39/0039_4278.jpg",
"owner_image_profile": "http://example.com/public/siteevent_event/39/0039_4278.jpg",
"owner_image_icon": "http://example.com/public/siteevent_event/39/0039_4278.jpg",
"auth_view": "everyone",
"total_events": 0
},
"gutterMenus": [
{
"name": "memberDiaries",
"label": "John Adams Event Diaries",
"url": "advancedevents/diaries",
"urlParams": {
"member": "John Adams"
}
},
{
"name": "create",
"label": "Create New Event Diary",
"url": "advancedevents/diaries/create"
},
{
"name": "edit",
"label": "Edit Diary",
"url": "advancedevents/diary/edit/8"
},
{
"name": "delete",
"label": "Delete Diary",
"url": "advancedevents/diary/delete/8"
},
{
"name": "tellAFriend",
"label": "Tell A Friend",
"url": "advancedevents/diaries/tell-a-friend",
"urlParams": {
"diary_id": 8
}
}
]
}
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."
}
Edit Diary ¶
Get Edit Diary FormGET/advancedevents/diary/edit/
Get the form for editing a Diary.
Returns the form
and formValues
as response. In form
we get the complete diary form and in formValues
we get the form’s values.
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 878`)diary id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Accept: application/json
Body
{
"form":[
{
"type":"Text",
"name":"title",
"label":"Diary Name",
"hasValidator":"true"
},
{
"type":"Textarea",
"name":"body",
"label":"Description"
},
{
"type":"Select",
"name":"auth_view",
"label":"View Privacy",
"description":"Who may see this diary?",
"multiOptions":{
"everyone":"Everyone",
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me",
}
"hasValidator":"true"
},
{
"type":"Submit",
"name":"submit",
"label":"Save"
}
],
"formValues":{
"diary_id":14,
"title":"latest",
"body":"",
"owner_id":5,
"event_id":261,
"creation_date":"2015-11-27 10:58:33",
"modified_date":"2015-11-27 10:58:33",
"view_count":0,
"auth_view":"owner"
}
}
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"
}
Edit DiaryPUT/advancedevents/diary/edit/
Edit a diary-post.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Adventure Events | event title |
body |
no | string | Collection of adventurous events | event content |
auth_view |
yes | string | everyone | view authorization (owner, owner_member, owner_network, etc.) |
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 878`)diary id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Adventure Events",
"body": "Collection of adventurous events ",
"auth_view": "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."
}
Diary Profile ¶
Diary ProfileGET/advancedevents/diary/
Get a Diary post and its gutter menu’s (edit, create, message-owner, delete) and the listing of events in the diary.
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 878`)diary id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"response": {
"diary_id": 1,
"title": "Thailand Trip ",
"body": "Enjoyed at lot with friends in Thailand Trip",
"owner_id": 1,
"event_id": 8,
"creation_date": "2016-01-21 06:34:52",
"modified_date": "2016-01-21 06:34:52",
"view_count": 86,
"diary_creator_name": "John Adams",
"owner_image": "http://example.com/public/user/17/0017_2d0f.png?c=30f5",
"owner_image_normal": "http://example.com/public/user/19/0019_964a.png?c=1b80",
"owner_image_profile": "http://example.com/public/user/18/0018_d2ab.png?c=b069",
"owner_image_icon": "http://example.com/public/user/1a/001a_c6a5.png?c=67f4",
"auth_view": "everyone",
"total_events": 2,
"event": [
{
"event_id": 11,
"title": "Harry Potter Diaries",
"body": "Harry Potter Stories full of adventure",
"category_name": "Festivals & Carnivals",
"featured": 0,
"sponsored": 0,
"like_count": 0,
"comment_count": 0,
"member_count": 1,
"starttime": "2016-01-21 08:00:00",
"endtime": "2016-01-31 11:00:00",
"image": "http://example.com/public/siteevent_event/55/0055_92b8.jpg?c=c3a4",
"image_normal": "http://example.com/public/siteevent_event/57/0057_784b.jpg?c=d26c",
"image_profile": "http://example.com/public/siteevent_event/56/0056_92b8.jpg?c=c3a4",
"image_icon": "http://example.com/public/siteevent_event/59/0059_e8fa.jpg?c=1d66",
"content_url": "http://example.com/event-item/harry-potter-diaries/11",
"owner_id": 1,
"owner_title": "John Adams",
"owner_image": "http://example.com/public/user/17/0017_2d0f.png?c=30f5",
"owner_image_normal": "http://example.com/public/user/19/0019_964a.png?c=1b80",
"owner_image_profile": "http://example.com/public/user/18/0018_d2ab.png?c=b069",
"owner_image_icon": "http://example.com/public/user/1a/001a_c6a5.png?c=67f4",
"get_attending_count": 1,
"get_maybe_count": 0,
"get_not_attending_count": 0,
"get_awaiting_reply_count": 1
},
{
"event_id": 8,
"title": "International kites festival",
"body": "International kites fesival",
"category_name": "Conventions",
"featured": 0,
"sponsored": 0,
"like_count": 0,
"comment_count": 0,
"member_count": 1,
"starttime": "2016-01-15 22:00:00",
"endtime": "2016-01-30 04:00:00",
"image": "http://example.com/public/siteevent_event/38/0038_80c3.jpg?c=e911",
"image_normal": "http://example.com/public/siteevent_event/3a/003a_dbc4.jpg?c=88a6",
"image_profile": "http://example.com/public/siteevent_event/39/0039_4278.jpg?c=c810",
"image_icon": "http://example.com/public/siteevent_event/3c/003c_ab2f.jpg?c=ae97",
"content_url": "http://example.com/event-item/international-kites-festival/8",
"owner_id": 1,
"owner_title": "John Adams",
"owner_image": "http://example.com/public/user/17/0017_2d0f.png?c=30f5",
"owner_image_normal": "http://example.com/public/user/19/0019_964a.png?c=1b80",
"owner_image_profile": "http://example.com/public/user/18/0018_d2ab.png?c=b069",
"owner_image_icon": "http://example.com/public/user/1a/001a_c6a5.png?c=67f4",
"get_attending_count": 0,
"get_maybe_count": 0,
"get_not_attending_count": 1,
"get_awaiting_reply_count": 2
}
]
},
"gutterMenus": [
{
"name": "memberDiaries",
"label": "admin Event Diaries",
"url": "advancedevents/diaries",
"urlParams": {
"member": "John"
}
},
{
"name": "create",
"label": "Create New Event Diary",
"url": "advancedevents/diaries/create"
},
{
"name": "messageOwner",
"label": "Message Owner",
"url": "advancedevents/diaries/message-owner",
"urlParams": {
"diary_id": 1
}
},
{
"name": "tellAFriend",
"label": "Tell A Friend",
"url": "advancedevents/diaries/tell-a-friend",
"urlParams": {
"diary_id": 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"
}
Delete Diary ¶
Delete DiaryDELETE/advancedevents/diary/delete/
Delete a diary-post.
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 878`)diary 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"
}
Add an Event to Diary ¶
Get Add to Diary FormGET/advancedevents/diaries/add/event_id/
Get the add to diary form.
Returns the diaries
and form
as response.diaries
we get the complete listing of user diaries and the information if the event is already present in respective diary.form
we get the new diary creation form.By sending the values of checkboxes user can add or remove an event from a diary.
Example URI
- event_id (required, integer, `event_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
200
Headers
Accept: application/json
Body
[
{
"type": "Checkbox",
"name": "diary_20",
"label": "dv",
"value": 0
},
{
"type": "Text",
"name": "title",
"label": "Diary Name",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "body",
"label": "Description"
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this diary?",
"multiOptions": {
"everyone": "Everyone",
"registered": "All Registered Members",
"owner_network": "Friends and Networks",
"owner_member_member": "Friends of Friends",
"owner_member": "Friends Only",
"owner": "Just Me"
},
"hasValidator": "true"
},
{
"type": "Submit",
"name": "submit",
"label": "Save"
}
]
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"
}
Add an Event to DiaryPOST/advancedevents/diaries/add/event_id/
Add event to diary post.
User can either add an event to an existing diary or create a new diary using this request.
To add an event to an existing diary
add the diary name with value 1 in parameter (diary_16=1
).In that case user need not to pass title
,body
and auth_view
along with the request.
To create a new diary send title
,body
and auth_view
along with the request
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Social work | diary title |
body |
no | string | Collection of events for social cause | |
auth_view |
yes | string | owner | view privacy |
diary_name |
no | integer | diary_16=1 | add event to existing diary |
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 878`)event id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"diary_16": "1",
}
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."
}
Remove Event From Diary ¶
Remove Event from DiaryPOST/advancedevents/diaries/remove/diary_id/{diary_id}/event_id/{event_id}
Remove an event from his own diary
Example URI
- diary_id
integer
(required) Example: 244diary id
- event_id
integer
(required) Example: 1event 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"
}
Tell a Friends ¶
Get Tell a Friend FormGET/advancedevents/diaries/tell-a-friend/diary_id/
Get the tell a friend form.
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 129`)diary 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": "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"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Tell a FriendPOST/advancedevents/diaries/tell-a-friend/diary_id/
tell a friend to view the diary by posting the tell a friend form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
sender_name |
yes | string | Michal | your name |
sender_email |
yes | string | michal@testing.com | your email address |
receiver_emails |
yes | string | tom@testing.com, tom21@testing.com | receiver email address |
message |
yes | string | how are you? | you can send a personal note in the mail |
send_me |
no | boolean | 1 | send a copy to my email address |
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 129`)diary 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."
}
Message Owner ¶
Get Message Owner FormGET/advancedevents/diaries/message-owner/diary_id/
Get the Message Owner form.
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 129`)diary 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": "Subject",
"hasValidators": "true"
},
{
"type": "Textarea",
"name": "body",
"label": "Message"
},
{
"type": "Submit",
"name": "submit",
"label": "Send Message"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Message OwnerPOST/advancedevents/diaries/message-owner/diary_id/
Message Owner of the diary by posting the message owner form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Nice Collection | title |
body |
no | string | Very nice collection of events | message body |
Example URI
- diary_id (required, integer, `diary_id
string
(required) Default: 129`)diary 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."
}
Advanced Events Plugin / Members ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Event Guest List ¶
Event Guest ListGET/advancedevents/member/list/{?search}{&rsvp}{&menu}{&page}{&limit}
Get the event’s guest listing. Guest can also be browsed and searched based on keywords, rsvp, etc.
In case of pagination, we need to use 2 parameters limit
and page
. Use limit
to set the number of guest in response and use page
for the page number. [i.e: If you have 100 guest and the first request has limit=20
and page=1
, then in that case the recent 20 guest will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent guest will be returned.]
Example URI
- search
string
(optional) Example: search=teacherget guest that contain this keyword in name.
- rsvp
integer
(optional) Example: rsvp=2get guest listings for Attending(
rsvp=2
) or Maybe Attending(rsvp=1
) or Not attending (rsvp=0
) .- menu
integer
(optional) Example: menu=1to get the menu options along with each guest.
- page
integer
(optional) Example: page=2return the ‘limit’ number of guest of that page of event listings.
- limit
integer
(optional) Example: limit=20number of guest. 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,
"occurrence_id": 14,
"rsvp": 2,
"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": "advancedevents/member/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."
}
Join Event ¶
Join EventPOST/advancedevents/member/join/
Join an event.
Member can join any event if the approval is not required from the owner of the event.
Example URI
- event_id (required, integer, `event_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."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Leave Event ¶
Leave EventPOST/advancedevents/member/leave/
Leave a event.
Example URI
- event_id (required, integer, `event_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."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Invite Members ¶
Get Members Invite FormGET/advancedevents/member/invite/
Get the member invite form.
Example URI
- event_id (required, integer, `event_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
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/advancedevents/member/invite/
Invite a friends to join the event 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
- event_id (required, integer, `event_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."
}
Accept Member Request ¶
Accept Member Request FormGET/advancedevents/member/accept/
Accept a member request Form.
Example URI
- event_id (required, integer, `event_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
200
Headers
Content-Type: application/json
Body
[
{
"type": "Radio",
"name": "rsvp",
"label": "RSVP",
"multiOptions": {
"0": "Not Attending",
"1": "Maybe Attending",
"2": "Attending"
},
"hasValidators": "true"
},
{
"type": "Submit",
"name": "submit",
"label": "Join Event"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Accept Member RequestPOST/advancedevents/member/accept/
Accept a member request.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
rsvp |
yes | integer | 2 | post for Attending(rsvp=2 ) or Maybe Attending(rsvp=1 ) or Not attending (rsvp=0 ) . |
Example URI
- event_id (required, integer, `event_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."
}
Ignore Member Request ¶
Ignore Member RequestPOST/advancedevents/member/reject/
Ignore a invite request.
Example URI
- event_id (required, integer, `event_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."
}
Event Membership Request ¶
Event Membership RequestPOST/advancedevents/member/request/
Request for the membership in event.
Example URI
- event_id (required, integer, `event_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."
}
Approve Membership Request ¶
Approve Membership RequestPOST/advancedevents/member/approve/
Approve a event membership request.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
user_id |
yes | integer | 78 | member id |
Example URI
- event_id (required, integer, `event_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."
}
Cancel Membership Request ¶
Cancel Membership RequestPOST/advancedevents/member/cancel/
Cancel a membership request.
Example URI
- event_id (required, integer, `event_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."
}
Remove Member ¶
Remove MemberDELETE/advancedevents/member/remove/
Remove member from the event membership.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
user_id |
yes | integer | 78 | member id |
Example URI
- event_id (required, integer, `event_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."
}
Publish Event ¶
Publish EventPOST/advancedevents/publish/
Publish a event.
Example URI
- event_id (required, integer, `event_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."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Open / Close Event ¶
Open / Close EventPOST/advancedevents/close/{event_id}
Open / close a event-post. If event is open then it will be close by default and If event is close then it will be open by default, there are no need for extra params.
Example URI
- event_id
integer
(required) Example: 244event 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"
}
Tell a Friends ¶
Get Tell a Friend FormGET/advancedevents/tellafriend/
Get the tell a friend form.
Example URI
- event_id (required, integer, `event_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
200
Headers
Content-Type: application/json
Body
[
{
"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"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Tell a FriendPOST/advancedevents/tellafriend/
tell a friend to join the event by posting the tell a friend form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
sender_name |
yes | string | Michal | your name |
sender_email |
yes | string | michal@testing.com | your email address |
receiver_emails |
yes | string | tom@testing.com, tom21@testing.com | receiver email address |
message |
yes | string | how are you? | you can send a personal note in the mail |
send_me |
no | boolean | 1 | send a copy to my email address |
Example URI
- event_id (required, integer, `event_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
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Advanced Events Plugin / Announcements ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Announcement Browse ¶
Announcement BrowseGET/advancedevents/announcement/index/
Get the event’s announcements listing.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)get the list of announcements
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
[
{
"announcement_id": 1,
"title": "We will come back in 2017",
"body": "Hello fans we will be back with a new series"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create Announcement ¶
Get Announcement Create FormGET/advancedevents/announcement/create/
Get the event announcement creation form.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)event 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": "Title",
"type": "Text",
"name": "title",
"hasValidator": "true"
},
{
"label": "Body",
"type": "Textarea",
"name": "body",
"hasValidator": "true"
},
{
"label": "Start Date",
"type": "date",
"name": "startdate",
"hasValidator": "true"
},
{
"label": "Expiry Date",
"type": "date",
"name": "expirydate",
"hasValidator": "true"
},
{
"label": "Activate Announcement",
"type": "Checkbox",
"name": "status",
"value": 1
},
{
"label": "Post Announcement",
"type": "Submit",
"name": "submit"
}
]
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create AnnouncementPOST/advancedevents/announcement/create/
Create a new event discussion by posting the event discussion creation form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Event will be back soon | discussion title |
body |
no | string | Seems like this is going to be a good year for us book lovers… | announcement body |
startdate |
yes | string | 2015-06-12 12:42:45 | announcement start time |
expirydate |
yes | string | 2015-10-12 12:42:45 | announcement end time |
status |
yes | boolean | 1 | activate announcement or not |
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)event id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Event will be back soon",
"body": "Seems like this is going to be a good year for us book lovers, ",
"startdate": "2015-06-12 12:42:45",
"expirydate": "2015-10-12 12:42:45",
"status": 1,
}
201
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Delete Announcement ¶
Delete AnnouncementDELETE/advancedevents/announcement/delete/{event_id}/{announcement_id}
Delete a Announcement-post.
Example URI
- event_id
integer
(required) Example: 148event id
- announcement_id
integer
(required) Example: 148announcement 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"
}
Advanced Events Plugin / Photos ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Event Photo List ¶
Event Photo ListGET/advancedevents/photo/list/{&page}{&limit}
Get the event’s photo listing.
In case of pagination, we need to use 2 parameters limit
and page
. Use limit
to set the number of photos in response and use page
for the page number. [i.e: If you have 100 photos and the first request has limit=20
and page=1
, then in that case the recent 20 photos will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent photos will be returned.]
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)get the list of photos
- menu
integer
(optional) Example: menu=1return the menu options like edit,delete etc if (
menu=1
) or nothing when (menu=0
).Default value is 1- page
integer
(optional) Example: page=2return the ‘limit’ number of guest of that page of event listings.
- limit
integer
(optional) Example: limit=20number of guest. Default limit is 20.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"canUpload": 1,
"totalItemCount": 2,
"images": [
{
"photo_id": 133,
"album_id": 13,
"event_id": 14,
"user_id": 4,
"title": "",
"description": "",
"collection_id": 13,
"file_id": 133,
"creation_date": "2016-02-05 12:46:44",
"modified_date": "2016-02-05 12:46:44",
"show_slidishow": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"order": 13,
"image": "http://example.com/public/siteevent_event/85/0085_a752.png?c=d6a5",
"image_normal": "http://example.com/public/siteevent_event/86/0086_3c2e.png?c=9fa6",
"image_profile": "http://example.com/public/siteevent_event/85/0085_a752.png?c=d6a5",
"image_icon": "http://example.com/public/siteevent_event/88/0088_3612.png?c=99b3",
"content_url": "http://example.com/event-item/photo/view/event_id/14/photo_id/133",
"user_title": "Martina James",
"likes_count": 0,
"is_like": 0
},
{
"photo_id": 137,
"album_id": 13,
"event_id": 14,
"user_id": 4,
"title": "",
"description": "",
"collection_id": 13,
"file_id": 137,
"creation_date": "2016-02-05 12:46:52",
"modified_date": "2016-02-05 12:46:52",
"show_slidishow": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"order": 14,
"image": "http://example.com/public/siteevent_event/89/0089_9eb8.png?c=857e",
"image_normal": "http://example.com/public/siteevent_event/8a/008a_f4f6.png?c=7bcf",
"image_profile": "http://example.com/public/siteevent_event/89/0089_9eb8.png?c=857e",
"image_icon": "http://example.com/public/siteevent_event/8c/008c_216f.png?c=1078",
"content_url": "http://example.com/event-item/photo/view/event_id/14/photo_id/137",
"user_title": "Martina James",
"likes_count": 0,
"is_like": 0
}
],
"menu": [
{
"label": "Edit",
"name": "edit",
"url": "advancedevents/photo/edit/137"
},
{
"label": "Delete",
"name": "delete",
"url": "advancedevents/photo/delete/137"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Upload PhotosPOST/advancedevents/photo/list/{&page}{&limit}
Upload the photos into the event.
To upload the event photos, send the files as an array of multipart / form-data
elements with the photo
API request parameters.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)get the list of photos
- page
integer
(optional) Example: page=2use page to get next limit of photos
- limit
integer
(optional) Example: limit=20number of photos. Default limit is 10
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Event Photo View ¶
Event Photo ViewGET/advancedevents/photo/view/{?menu}
Get the event photo view page information.
Example URI
- photo_id (required, integer, `photo_id
string
(required) Default: 947`)photo id
- menu
integer
(optional) Example: menu=0menu in response. Default value is 1
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"photo_id": 137,
"album_id": 13,
"event_id": 14,
"user_id": 4,
"title": "",
"description": "",
"collection_id": 13,
"file_id": 137,
"creation_date": "2016-02-05 12:46:52",
"modified_date": "2016-02-05 12:46:52",
"show_slidishow": 0,
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"order": 14,
"image": "http://example.com/public/siteevent_event/89/0089_9eb8.png?c=857e",
"image_normal": "http://example.com/public/siteevent_event/8a/008a_f4f6.png?c=7bcf",
"image_profile": "http://example.com/public/siteevent_event/89/0089_9eb8.png?c=857e",
"image_icon": "http://example.com/public/siteevent_event/8c/008c_216f.png?c=1078",
"content_url": "http://example.com/event-item/photo/view/event_id/14/photo_id/137",
"menu": [
{
"label": "Edit",
"name": "edit",
"url": "advancedevents/photo/edit/137"
},
{
"label": "Delete",
"name": "delete",
"url": "advancedevents/photo/delete/137"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Edit Event Photo Info ¶
Get Event Photo Info FormGET/advancedevents/photo/edit/
Get edit event photo form.
Returns the form
and formValues
as response. In form we get the complete edit photo form
and in formValues
we get the form values.
Example URI
- photo_id (required, integer, `photo_id
string
(required) Default: 523`)photo id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
200
Headers
Accept: application/json
Body
{
"form":[
{
"type":"Text",
"name":"title",
"label":"Title",
},
{
"type":"Textarea",
"name":"description",
"label":"Description",
},
{
"type":"Submit",
"name":"submit",
"label":"Submit"
}
],
"formValues":{
"photo_id":137,
"album_id":13,
"event_id":14,
"user_id":4,
"title":"",
"description":"",
"collection_id":13,
"file_id":137,
"creation_date":"2016-02-05 12:46:52",
"modified_date":"2016-02-05 12:46:52",
"show_slidishow":0,
"view_count":1,
"comment_count":0,
"like_count":0,
"order":14
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Put Photo Info FormPUT/advancedevents/photo/edit/
Put the edit photo form values
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
no | string | Harry Potter Series-1 Photo | photo title |
description |
no | string | This photo is from harry potter first… | photo description |
Example URI
- photo_id (required, integer, `photo_id
string
(required) Default: 523`)photo id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Harry Potter Series-1 Photo",
"description": "This photo is from harry potter first series."
}
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Delete Photo ¶
Delete PhotoDELETE/advancedevents/photo/delete/
Delete the event photo by log-in user.
Example URI
- photo_id (required, integer, `photo_id
string
(required) Default: 947`)photo id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"photo_id": 873,
}
204
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Advanced Events Plugin / Videos ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Event Video List ¶
Event Video ListGET/advancedevents/videos/{?page}{&limit}{&menu}
Get the event’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
- event_id (required, integer, `event_id
string
(required) Default: 58`)event 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,
"event_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/siteevent_video/6a/006a_2429.jpg?c=dc09",
"image_normal": "http://example.com/public/siteevent_video/6a/006a_2429.jpg?c=dc09",
"image_profile": "http://example.com/public/siteevent_video/6a/006a_2429.jpg?c=dc09",
"image_icon": "http://example.com/public/siteevent_video/6a/006a_2429.jpg?c=dc09",
"content_url": "http://example.com/advancedevents/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 Event Video ¶
Get Video Create FormGET/advancedevents/video/create/
Get the event video creation form.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)event 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/advancedevents/video/create/
Create a new event video by posting the event 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
- event_id (required, integer, `event_id
string
(required) Default: 58`)event 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"
}
Event Video Profile ¶
Event Video ProfileGET/advancedevents/video/{?menu}
Get a video post and its gutter menu’s (create, edit, delete, share, etc) information.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 25`)event 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": "advancedevent/video/create/262"
},
{
"label": "Edit Video",
"name": "edit",
"url": "advancedevent/video/edit/262/13"
},
{
"label": "Delete Video",
"name": "delete",
"url": "advancedevent/video/delete/262/13"
},
{
"label": "Share",
"name": "share",
"url": "activity/share",
"urlParams": {
"type": "siteevent_video",
"id": 13
}
}
],
"response": {
"video_id": 13,
"event_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": "",
"event_type_title": "Events",
"event_title": "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 Event Video ¶
Get Edit Event Video FormGET/advancedevents/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
- event_id (required, integer, `event_id
string
(required) Default: 124`)event 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 Event VideoPUT/advancedevents/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
- event_id (required, integer, `event_id
string
(required) Default: 124`)event 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 Event Video ¶
Delete Event VideoDELETE/advancedevents/video/delete/
Delete a video-post.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 124`)event 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"
}
Advanced Events Plugin / Reviews ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Event Reviews List ¶
Event Review ListGET/advancedevents/reviews/browse/{&order}{&show}{&getRating}{&page}{&limit}
Get the event’s review listing.
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
- event_id (required, integer, `event_id
string
(required) Default: 58`)event id
- show
string
(optional) Example: show=friends_reviewsget friends review listings (
show=friends_reviews
) or get self review listings (show=self_reviews
) or get featured review listings (show=featured
)- order
string
(optional) Example: order=recentget review listings in the descending order of creation date (
order=recent
) or descending order of ratings (order=rating_highest
) or ascending number of ratings (order=rating_lowest
) or descending order of helpful count (order=helpfull_most
) or descending number of reply count (order=replay_most
) or descending number of views (order=view_most
).- page
integer
(optional) Example: page=2return the ‘limit’ number of reviews of that page of reviews listings.
- limit
integer
(optional) Example: limit=20number of reviews. Default limit is 10.
- getRating
boolean
(optional) Example: getRating=1 OR 0get Reting array. Default value is 0.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"ratings": {
"rating_avg": 5,
"rating_users": 5,
"breakdown_ratings_params": {
"1": 0,
"2": 0,
"3": 0,
"4": 0,
"5": 1
},
"myRatings": [
{
"ratingparam_id": 0,
"rating": 5,
"user_id": 4
},
{
"ratingparam_id": 3,
"rating": 5,
"user_id": 4
},
{
"ratingparam_id": 4,
"rating": 3,
"user_id": 4
}
],
"recomended": 1
},
"total_reviews": 1,
"reviews": [
{
"review_id": 1,
"type": "user",
"resource_id": 14,
"resource_type": "siteevent_event",
"profile_type_review": 0,
"owner_id": 4,
"title": "Nice",
"body": "Nice event.Had a great time",
"pros": "Event was good.",
"cons": "Too much crowd.\n",
"body_pages": "",
"update_reason": "",
"creation_date": "2016-02-03 05:39:05",
"modified_date": "2016-02-03 05:39:05",
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"reply_count": 0,
"helpful_count": 1,
"recommend": 1,
"status": 1,
"featured": 0,
"owner_title": "Martina James",
"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",
"event_title": "Sample",
"category_name": "Conventions",
"is_helful": 1,
"image": "http://example.com/public/siteevent_event/85/0085_a752.png?c=d6a5",
"image_normal": "http://example.com/public/siteevent_event/86/0086_3c2e.png?c=9fa6",
"image_profile": "http://example.com/public/siteevent_event/85/0085_a752.png?c=d6a5",
"image_icon": "http://example.com/public/siteevent_event/88/0088_3612.png?c=99b3",
"content_url": "http://example.com/event-item/sample/14"
}
]
}
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"
}
Review Create Form ¶
Get Review Create FormGET/advancedevents/review/create/
Get the review create form and rating form.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 14`)event 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":"Textarea",
"name":"pros",
"label":"Pros",
"description":"What do you like about this Event?",
"hasValidator":"true"
},
{
"type":"Textarea",
"name":"cons",
"label":"Cons",
"description":"What do you dislike about this Event?",
"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 to a friend?",
"multiOptions":{
"1":"Yes",
"0":"No"
}
},
{
"type":"Submit",
"name":"submit",
"label":"Submit"
}
],
"ratingParams":[
{
"type":"Text",
"name":0,
"label":"Overall Rating"
},
{
"type":"Text",
"name":15,
"label":"Ambience"
},
{
"type":"Text",
"name":16,
"label":"Organization"
}
]
}
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"
}
Post Review Create FormPOST/advancedevents/review/create/
Post review in event.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Nice event and good managment | post title |
pros |
yes | string | nice stories, create a so much fiction | post pros |
cons |
yes | string | team coordination to is not good | post cons |
body |
no | string | team coordination to is not good | post cons |
recommend |
no | boolean | 1 | if event is recommend (recommend=1) or no(recommend=0) |
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 14`)event id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Nice event and good managment",
"body": "Happy time",
"pros": "nice stories, create a so much fiction",
"cons": "team coordination to people are not good",
"recommend": "1"
}
201
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"
}
Review Profile ¶
Review ProfileGET/advancedevents/review/
Get a event review post’s
Example URI
- review_id (required, integer, `review_id
string
(required) Default: 14`)review id
- event_id (required, integer, `event_id
string
(required) Default: 14`)event id
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"response": {
"review_id": 58,
"type": "user",
"resource_id": 8,
"resource_type": "siteevent_event",
"profile_type_review": 0,
"owner_id": 5,
"title": "Nice event and good managment",
"body": "Good job guys",
"pros": "nice stories, create a so much fiction",
"cons": "team coordination to people are not good",
"body_pages": "",
"update_reason": "",
"creation_date": "2016-02-06 07:52:22",
"modified_date": "2016-02-06 07:52:22",
"view_count": 1,
"comment_count": 0,
"like_count": 0,
"reply_count": 0,
"helpful_count": 0,
"recommend": 1,
"status": 1,
"featured": 0,
"owner_title": "Michal",
"event_type_title": "Events",
"location": "D.V.PUBLIC SCHOOL, Rohini, New Delhi, Delhi, India",
"tag": "fv",
"categoryname": "Sports"
}
}
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 Review ¶
Delete ReviewDELETE/advancedevents/review/delete/
Delete a Review.
Example URI
- review_id (required, integer, `review_id
string
(required) Default: 14`)review id
- event_id (required, integer, `event_id
string
(required) Default: 14`)event 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"
}
Make Review Helpful ¶
Make Review HelpfulPOST/advancedevents/review/helpful/{&helpful}
Make a User Review Helpful or not Helpful
Example URI
- review_id (required, integer, `review_id
string
(required) Default: 14`)review id
- event_id (required, integer, `event_id
string
(required) Default: 14`)event id
- helpful
integer
(required) Example: helpful=1helpful(helpful=1) or not helpful(helpful=2)
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"
}
Advanced Events Plugin / Advanced Events - Recurring/Repeating Events Extension ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin.
Event Occurrences Listing ¶
Event Occurrences ListingGET/siteeventrepeat/index/{?menu}{&guest_count_link}{&page}{&limit}
Get the event’s occurrences listing.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)get the list of photos
- menu
integer
(optional) Example: menu=1return the menu options like edit,delete etc if (
menu=1
) or nothing when (menu=0
).Default value is 1- guest_pictures (optional, integer, `guest_pictures
string
(required) Default: 1`) ... return the guest images if (`guest_pictures=1`) or nothing when (`guest_pictures=0`).Default value is 1- guest_count_link
integer
(optional) Example: guest_count_link=1return the guest count for each event occurrences if (
guest_count_link=1
) or nothing when (guest_count_link=0
).Default value is 1- rsvp_form (optional, integer, `rsvp_form
string
(required) Default: 1`) ... return the rsvp form for attending, not attending etc if (`rsvp_form=1`) or nothing when (`rsvp_form=0`).Default value is 1- page
integer
(optional) Example: page=2return the ‘limit’ number of guest of that page of event listings.
- limit
integer
(optional) Example: limit=20number of guest. Default limit is 20.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"response": [
{
"starttime": "2016-04-19 11:00:00",
"endtime": "2016-04-19 14:00:00",
"occurrence_id": 25,
"totalMembers": 1,
"guest": [
{
"guest_title": "/siteapi/profile/james",
"guest_id": 5,
"image": "http://example.com/public/user/19/0019_0473.png?c=8e31",
"image_normal": "http://example.com/public/user/1b/001b_def2.png?c=d1d0",
"image_profile": "http://example.com/public/user/1a/001a_eb9b.png?c=84b4",
"image_icon": "http://example.com/public/user/1c/001c_ed2f.png?c=5bd9",
"content_url": "http://example.com/profile/admin"
}
],
"rsvp": 2,
"menu": [
{
"label": "Invite Guests",
"name": "invite",
"url": "advancedevents/member/invite/15",
"urlParams": {
"occurrence_id": 25
}
},
{
"label": "Leave Event",
"name": "request",
"url": "advancedevents/member/leave/15",
"urlParams": {
"occurrence_id": 25
}
}
],
"rsvp_form": [
{
"type": "Select",
"name": "rsvp",
"multiOptions": {
"0": "Not Attending",
"1": "Maybe Attending",
"2": "Attending"
}
},
{
"type": "Submit",
"name": "submit",
"label": "Submit"
}
]
},
{
"starttime": "2016-06-21 11:00:00",
"endtime": "2016-06-21 14:00:00",
"occurrence_id": 26,
"totalMembers": 0,
"rsvp": null,
"menu": [
{
"label": "Invite Guests",
"name": "invite",
"url": "advancedevents/member/invite/15",
"urlParams": {
"occurrence_id": 26
}
},
{
"label": "Join Event",
"name": "request",
"url": "advancedevents/member/join/15",
"urlParams": {
"occurrence_id": 26
}
}
]
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Event Occurrence Info ¶
Event occurrence InfoGET/siteeventrepeat/info/{?showeventtype}{&showeventtime}{&showeventcondition}
Get the event’s occurrence Info.
Example URI
- event_id (required, integer, `event_id
string
(required) Default: 58`)get the list of photos
- showeventtype
integer
(optional) Example: showeventtype=1return the event occurrence repeat type if (
showeventtype=1
) or nothing when (showeventtype=0
).Default value is 1- showeventtime
integer
(optional) Example: showeventtime=1return the event occurrence event time if (
showeventtime=1
) or nothing when (showeventtime=0
).Default value is 1- showeventcondition
integer
(optional) Example: showeventcondition=1return the event occurrence event condition if (
showeventcondition=1
) or nothing when (showeventcondition=0
).Default value is 1
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"repeat_interval": 0,
"eventrepeat_type": "monthly",
"repeat_month": "2",
"endtime": "2016-04-19 14:00:00",
"repeat_week": 3,
"repeat_weekday": 2,
"end_date": "07/19/2016",
"starttime": "2016-04-19 11:00:00"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Advanced Events Plugin / Events Booking, Tickets Selling & Paid Events Extension ¶
These are the APIs for the SocialEngineAddOns Plugin: Advanced Events Plugin- Events Booking, Tickets Selling & Paid Events Extension.
Event Tickets Listing ¶
Event Tickets ListingGET/advancedeventtickets/tickets/tickets-buy/{?event_id}{&coupon_code}
Get the event’s tickets listing.
Example URI
- event_id
integer
(required)get the list of tickets
- ticket_id_2
integer
(optional)ticket_id string along with the ticket id to define the quantity of a particular ticket
- coupon_code
integer
(optional)pass the coupon code in the request for coupon & discounted price info
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
{
"subTotal": 15,
"discountPrice": 3.75,
"tax": 0.3375,
"grandTotal": 11.5875,
"currency": "USD",
"tabs": {
"name_column": "Ticket Name",
"claimed_column": "Claimed Tickets",
"close_column": "Ticket sale will be closed on",
"price_column": "Price",
"name": "Qty"
},
"occurrence_id": 4369,
"canApplyCoupon": 1,
"coupon_info": {
"siteeventticketCouponDetail": "a:2:{i:150;a:5:{s:9:\"coupon_id\";i:10;s:13:\"coupon_amount\";s:5:\"25.00\";s:8:\"event_id\";i:409;s:11:\"coupon_type\";i:0;s:11:\"coupon_code\";s:11:\"CELEBRATION\";}i:151;a:5:{s:9:\"coupon_id\";i:10;s:13:\"coupon_amount\";s:5:\"25.00\";s:8:\"event_id\";i:409;s:11:\"coupon_type\";i:0;s:11:\"coupon_code\";s:11:\"CELEBRATION\";}}",
"coupon_success_msg": "This coupon has been applied. (Applicable for 'Teenage Passes','Couple Passes' )"
},
"coupon_code": "CELEBRATION",
"tax_rate": 3,
"canShowBookNow": 1,
"buyerStep": 1,
"tickets": [
{
"status": "Sold Out",
"price": 5,
"title": "Teenage Passes",
"quantity": "30 of 30 sold",
"ticket_id": 150,
"description": "Rooms and Facilities For the Teenage children.",
"is_claimed_display": 1,
"is_same_end_date": 0,
"sell_endtime": "2020-12-26 16:00:00",
"sell_starttime": "2015-05-20 11:17:05",
"buy_limit_min": 0,
"buy_limit_max": 10,
"occurrence_id": 4369,
"event_id": 409,
"starttime": "2015-05-20 12:00:00",
"endtime": "2020-12-26 16:00:00",
"ticket_id_sold": "{\"tid_150\":30,\"tid_151\":44,\"tid_192\":0}",
"waitlist_flag": 0
},
{
"status": "Sold Out",
"price": 10,
"title": "Couple Passes",
"quantity": "44 of 40 sold",
"ticket_id": 151,
"description": "Rooms for Couples...",
"is_claimed_display": 1,
"is_same_end_date": 0,
"sell_endtime": "2020-12-26 16:00:00",
"sell_starttime": "2015-05-20 11:17:05",
"buy_limit_min": 0,
"buy_limit_max": 10,
"occurrence_id": 4369,
"event_id": 409,
"starttime": "2015-05-20 12:00:00",
"endtime": "2020-12-26 16:00:00",
"ticket_id_sold": "{\"tid_150\":30,\"tid_151\":44,\"tid_192\":0}",
"waitlist_flag": 0
},
{
"status": "Sale starts on : 2017-04-14 07:00:00",
"price": "Free",
"title": "Free Passes",
"quantity": "0 of 10 claimed",
"ticket_id": 192,
"description": "Get your Hotel Book in FREE!!",
"is_claimed_display": 1,
"is_same_end_date": 0,
"sell_endtime": "2020-12-26 16:00:00",
"sell_starttime": "2017-04-14 07:00:00",
"buy_limit_min": 0,
"buy_limit_max": 10,
"occurrence_id": 4369,
"event_id": 409,
"starttime": "2015-05-20 12:00:00",
"endtime": "2020-12-26 16:00:00",
"ticket_id_sold": "{\"tid_150\":30,\"tid_151\":44,\"tid_192\":0}",
"waitlist_flag": 0
}
],
"info": "{\"ticket_column\":{\"150\":{\"0\":5,\"1\":\"1\",\"coupon_id\":10},\"151\":{\"0\":10,\"1\":\"1\",\"coupon_id\":10}},\"coupon_code\":\"CELEBRATION\",\"grandTotal\":11.5875,\"tax\":0.3375,\"subTotal\":15,\"date_filter_occurrence\":4369}"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Tickets Buyer's Info Form ¶
Tickets Buyer's Info FormGET/advancedeventtickets/order/buyer-details/{?event_id}{&order_info}
Get the ticket buyer form info.
Example URI
- event_id
integer
(required)get the list of tickets
- order_info
json
(required)info json received from above api of all the tickets details
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
{
"buyerForm": [
{
"type": "Text",
"name": "fname",
"label": "First Name",
"hasValidator": "true"
},
{
"type": "Text",
"name": "lname",
"label": "Last Name",
"hasValidator": "true"
},
{
"type": "Text",
"name": "email",
"label": "Email",
"hasValidator": "true"
}
],
"buyerFormValues": {
"fname": "Alen",
"lname": "J",
"email": "test1@seaddons.com"
},
"ticketIds": [
{
"ticket_count": 1,
"ticket_id": 150
},
{
"ticket_count": 2,
"ticket_id": 151
}
],
"tickerHolderForm": [
{
"type": "Checkbox",
"name": "isCopiedDetails",
"label": "Copy purchaser's information for all tickets."
},
{
"type": "Dummy",
"name": "dummy_title_150",
"label": "Ticket 1 - Teenage Passes"
},
{
"type": "Text",
"name": "fname_150_1",
"label": "First Name",
"hasValidator": "true"
},
{
"type": "Text",
"name": "lname_150_1",
"label": "Last Name",
"hasValidator": "true"
},
{
"type": "Text",
"name": "email_150_1",
"label": "Email",
"hasValidator": "true"
},
{
"type": "Dummy",
"name": "dummy_title_151",
"label": "Ticket 2 - Couple Passes"
},
{
"type": "Text",
"name": "fname_151_2",
"label": "First Name",
"hasValidator": "true"
},
{
"type": "Text",
"name": "lname_151_2",
"label": "Last Name",
"hasValidator": "true"
},
{
"type": "Text",
"name": "email_151_2",
"label": "Email",
"hasValidator": "true"
}
],
"tickerHolderFormvalues": []
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Tickets Buy Method Form ¶
Tickets Buy Method FormGET/advancedeventtickets/order/checkout/{?event_id}{&order_info}{&buyer_info}
Get the available method for purchasing the tickets
Example URI
- event_id
integer
(required)get the list of tickets
- order_info
json
(required)info json received from above api of all the tickets details
- buyer_info
json
(optional)json buyers info generated from buyer’s info API
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
{
"paymentForm": [
{
"type": "Radio",
"name": "method",
"label": "Payment Method",
"multiOptions": {
"2": "PayPal",
"4": "Pay at the Event"
}
},
{
"type": "Checkbox",
"name": "isPrivateOrder",
"label": "Make my purchase private."
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Ticket Place Order ¶
Ticket Place OrderPOST/advancedeventtickets/order/place-order/
API will return redirection url in case of online payment method according to the method selected or will give success message in case of offline payment method.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
event_id |
yes | integer | 1342 | event id |
method_id |
yes | integer | 2 | payment method selected |
order_info |
yes | json | order details | |
buyer_info |
yes | json | buyer details | |
coupon_info |
no | json | coupon details |
Example URI
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
{
"order_id": "72b038748flc44rdya6cbf5af2d4ec7847549202eec5d61384998f1d4d367886c4df271e7d1d838bb42c8b72b",
"method": "online",
"webviewUrl": "http://example.com/events/order/payment/419?order_id=72b038748flc44rdya6cbf5af2d4ec7847549202eec5d61384998f1d4d367886c4df271e7d1d838bb42c8b72b&gateway_id=6&occurrence_id=4481&token=rftghyjmktfgyhu&disableHeaderAndFooter=1"
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Coupons Listing for an Event ¶
Listing of couponsGET/advancedeventtickets/coupons/index/{?event_id}
Get the listing of available coupons of an event.
Example URI
- event_id
integer
(required)get the list of coupons
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
{
"currency": "USD",
"totalItemCount": 2,
"response": [
{
"coupon_id": 10,
"event_id": 409,
"owner_id": 1,
"title": "Start the Fun",
"description": "Get the hotels for your memorable trip by paying very less..",
"view_count": 22,
"comment_count": 0,
"like_count": 0,
"creation_date": "2015-05-25 04:49:20",
"coupon_code": "CELEBRATION",
"end_settings": 0,
"end_time": "0000-00-00 00:00:00",
"start_time": "2015-05-24 22:00:00",
"photo_id": 64987,
"discount_type": 0,
"discount_amount": 25,
"min_amount": 0,
"min_quantity": 0,
"ticket_ids": "150,151",
"public": 1,
"approved": 1,
"status": 1,
"event_title": "New Adventure Island Hotel - For Trips",
"image": "http://example.com/public/siteeventticket_coupon/d9/fe/fddb_0af3.jpg?c=981f",
"image_normal": "http://example.com/public/siteeventticket_coupon/db/fe/fddd_c387.jpg?c=354e",
"image_profile": "http://example.com/public/siteeventticket_coupon/da/fe/fddc_0aff.jpg?c=a9b8",
"image_icon": "http://example.com/public/siteeventticket_coupon/dc/fe/fdde_c899.jpg?c=6b47",
"content_url": "http://example.com/event-coupons/1/10/start-the-fun"
},
{
"coupon_id": 9,
"event_id": 409,
"owner_id": 1,
"title": "30% OFF",
"description": "Grab the offer soon... and get ready for the fun :)\r\n",
"view_count": 23,
"comment_count": 0,
"like_count": 0,
"creation_date": "2015-05-25 04:46:24",
"coupon_code": "FUN30",
"end_settings": 0,
"end_time": "0000-00-00 00:00:00",
"start_time": "2015-05-24 22:00:00",
"photo_id": 64983,
"discount_type": 0,
"discount_amount": 30,
"min_amount": 0,
"min_quantity": 0,
"ticket_ids": 151,
"public": 1,
"approved": 1,
"status": 1,
"event_title": "New Adventure Island Hotel - For Trips",
"image": "http://example.com/public/siteeventticket_coupon/d5/fe/fdd7_d975.png?c=c3ff",
"image_normal": "http://example.com/public/siteeventticket_coupon/d7/fe/fdd9_7bfd.png?c=dc9d",
"image_profile": "http://example.com/public/siteeventticket_coupon/d6/fe/fdd8_5972.png?c=61df",
"image_icon": "http://example.com/public/siteeventticket_coupon/d8/fe/fdda_80c7.png?c=ccdf",
"content_url": "http://example.com/event-coupons/1/9/30-off"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
My Orders Listing ¶
My Tickets ListingGET/advancedeventtickets/tickets/index
Get the listing of all the tickets purchased by the user.
Example URI
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
{
"totalUpcomingOrderCount": 20,
"totalPastOrderCount": 1,
"response": [
{
"order_id": 391,
"user_id": 18787,
"event_id": 419,
"occurrence_id": 4481,
"occurrence_starttime": "2017-06-16 01:00:00",
"occurrence_endtime": "2017-06-16 04:00:00",
"creation_date": "2016-12-15 11:38:01",
"order_status": 1,
"ticket_qty": 2,
"sub_total": 65,
"grand_total": 65,
"payment_status": "initial",
"tax_amount": 0,
"commission_type": 1,
"commission_value": 0.65,
"commission_rate": 1,
"cheque_id": 0,
"gateway_id": 4,
"gateway_profile_id": null,
"eventbill_id": 0,
"payment_request_id": 0,
"order_note": null,
"non_payment_seller_reason": 0,
"non_payment_seller_message": null,
"non_payment_admin_reason": 0,
"non_payment_admin_message": null,
"direct_payment": 1,
"coupon_detail": null,
"is_private_order": 0,
"payment_split": 0,
"event_title": "Flamenco Show with complimentary drinks",
"order_info": {
"First Level Tickets": 1,
"Second Level Tickets": 1
},
"image": "http://example.com/siteevent_event/78/02/01/10077_d588.jpg?c=895e",
"image_normal": "http://example.com/siteevent_event/7a/02/01/10079_9453.jpg?c=7668",
"image_profile": "http://example.com/siteevent_event/79/02/01/10078_fe7e.jpg?c=571a",
"image_icon": "http://example.com/siteevent_event/7c/02/01/1007b_909d.jpg?c=aba8",
"content_url": "http://example.com/advancedevents/view/419/slug/flamenco-show-with-complimentary-drinks",
"default_cover": 0,
"cover_image": "http://example.com/siteevent_photo/7d/02/01/1007c_bcbb.jpg?c=6c3c",
"menus": [
{
"name": "view_order",
"label": "View Order",
"url": "advancedeventtickets/order/view",
"urlParams": {
"order_id": 391
}
}
]
},
{
"order_id": 390,
"user_id": 18787,
"event_id": 419,
"occurrence_id": 4481,
"occurrence_starttime": "2017-06-16 01:00:00",
"occurrence_endtime": "2017-06-16 04:00:00",
"creation_date": "2016-12-15 11:35:31",
"order_status": 1,
"ticket_qty": 2,
"sub_total": 65,
"grand_total": 65,
"payment_status": "active",
"tax_amount": 0,
"commission_type": 1,
"commission_value": 0.65,
"commission_rate": 1,
"cheque_id": 0,
"gateway_id": 2,
"gateway_profile_id": "7P385199RM624951D",
"eventbill_id": 0,
"payment_request_id": 0,
"order_note": null,
"non_payment_seller_reason": 0,
"non_payment_seller_message": null,
"non_payment_admin_reason": 0,
"non_payment_admin_message": null,
"direct_payment": 1,
"coupon_detail": null,
"is_private_order": 0,
"payment_split": 0,
"event_title": "Flamenco Show with complimentary drinks",
"order_info": {
"First Level Tickets": 1,
"Second Level Tickets": 1
},
"image": "http://example.com/siteevent_event/78/02/01/10077_d588.jpg?c=895e",
"image_normal": "http://example.com/siteevent_event/7a/02/01/10079_9453.jpg?c=7668",
"image_profile": "http://example.com/siteevent_event/79/02/01/10078_fe7e.jpg?c=571a",
"image_icon": "http://example.com/siteevent_event/7c/02/01/1007b_909d.jpg?c=aba8",
"content_url": "http://example.com/advancedevents/view/419/slug/flamenco-show-with-complimentary-drinks",
"default_cover": 0,
"cover_image": "http://example.com/siteevent_photo/7d/02/01/1007c_bcbb.jpg?c=6c3c",
"menus": [
{
"name": "view_order",
"label": "View Order",
"url": "advancedeventtickets/order/view",
"urlParams": {
"order_id": 390
}
}
]
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Order View ¶
Order ViewGET/advancedeventtickets/order/view{?order_id}
Get the complete details of an order.
Example URI
- order_id
integer
(required)get the details of an order
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
{
"order_id": 365,
"user_id": 18787,
"event_id": 409,
"occurrence_id": 4369,
"occurrence_starttime": "2015-05-20 12:00:00",
"occurrence_endtime": "2020-12-26 16:00:00",
"creation_date": "2016-10-21 05:26:48",
"order_status": 1,
"ticket_qty": 3,
"sub_total": 25,
"grand_total": 25.75,
"payment_status": "initial",
"tax_amount": 0.75,
"commission_type": "Percentage",
"commission_value": 0.25,
"commission_rate": "1.00 %",
"cheque_id": 0,
"gateway_id": 4,
"gateway_profile_id": null,
"eventbill_id": 0,
"payment_request_id": 0,
"order_note": null,
"non_payment_seller_reason": 0,
"non_payment_seller_message": null,
"non_payment_admin_reason": 0,
"non_payment_admin_message": null,
"direct_payment": 1,
"coupon_detail": null,
"is_private_order": 0,
"payment_split": 0,
"currency": "USD",
"user_title": "Alen J",
"user_email": "test1@seaddons.com",
"event_title": "New Adventure Island Hotel - For Trips",
"payment_method": "Pay at the Event",
"order_status_text": "Payment Pending",
"tax_id_no": 1234567,
"tabs": {
"ticket": "Ticket",
"price": "Price",
"quantity": "Quantity",
"subtotal": "Subtotal"
},
"tickets": [
{
"title": "Teenage Passes",
"price": 5,
"quantity": 1,
"subTotal": 5
},
{
"title": "Couple Passes",
"price": 10,
"quantity": 2,
"subTotal": 20
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}