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]
Multiple Listing Types Plugin Core-Reviews & Ratings Plugin ¶
These are the APIs for SocialEngine’s official Multiple Listing Types Plugin Core (Reviews & Ratings Plugin).
Browse Listings ¶
Browse ListingsGET/listings{?search}{&orderby}{&page}{&closed}{&limit}{&show}{&reviews}{&1_5_23_field_23}{&1_8_37_field_98}{&location}
Get the listing. Listings 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 listings in response and use page
for the page number. [i.e: If you have 100 listings and the first request has limit=20
and page=1
, then in that case the recent 20 listings will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent listings will be returned.]
Example URI
- search
string
(optional) Example: search=teacherget listings that contain this keyword in title or description.
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
- category_id (optional, integer, `category_id
string
(required) Default: 13`)get all listings of a particular category ID.
- orderby
string
(optional) Example: orderby=creation_dateget listings in the order of creation date (
orderby=creation_date
) or order of title (orderby=title
) or order of view count (orderby=view_count
) or order of like count (orderby=like_count
) or order of comment_count (orderby=comment_count
) or order of review count (orderby=review_count
) or order of rating avg (orderby=rating_avg
).- closed
integer
(optional) Example: closed=Everyone's Articlesget only closed Listings (
closed=1
) or get open Listings (closed=0
) or get All Listings (closed=
)- show
integer
(optional) Example: show=1get Everyone Listings (
show=1
) or get only my Listings (show=2
) or get Listings I like (show=4
)- reviews
integer
(optional) Example: reviews=rating_usersget Listings Reviewd by users(
reviews=rating_users
)- 1_5_23_field_23
string
(optional) Example: 1_5_23_field_23=michalget listings with matching value for this profile field. You can get the key name for profile field from the response of Listing search form.
- 1_8_37_field_98
string
(optional) Example: 1_8_37_field_98=52get listing with matching value for this profile field. You can get the key name for profile field from the response of Listing search form.
- location
string
(optional) Example: location=Chicago, IL, United Statesget listings belong to this location.
- 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 listings of that page of listings.
- limit
integer
(optional) Example: limit=20number of listings. Default limit is 20.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"totalItemCount":27,
"canCreate":1,
"response":[
{
"listing_id":28,
"title":"csc",
"body":"sc",
"owner_id":2,
"listingtype_id":1,
"profile_type":0,
"photo_id":0,
"category_id":10,
"subcategory_id":0,
"subsubcategory_id":0,
"creation_date":"2016-03-08 08:20:47",
"modified_date":"2016-03-08 08:20:47",
"end_date":null,
"approved":1,
"featured":0,
"sponsored":0,
"newlabel":0,
"rating_avg":0,
"rating_editor":0,
"rating_users":0,
"location":"",
"price":0,
"review_count":0,
"view_count":4,
"comment_count":0,
"like_count":0,
"search":1,
"closed":0,
"approved_date":"2016-03-08 08:20:47",
"draft":0,
"main_video":"",
"video_snapshot_id":0,
"networks_privacy":null,
"owner_image":"http://example.com/public/user/5f/005f_edbe.jpg?c=45ea",
"owner_image_normal":"http://example.com/public/user/61/0061_d6e4.jpg?c=761b",
"owner_image_profile":"http://example.com/public/user/60/0060_e6b3.jpg?c=73a2",
"owner_image_icon":"http://example.com/public/user/62/0062_8868.jpg?c=000a",
"owner_title":"William Thomas",
"image":"",
"image_normal":"",
"image_profile":"",
"image_icon":"",
"content_url":"http://example.com/product/28/csc",
"allow_to_view":1,
"edit":0,
"delete":0
},
{
"listing_id":23,
"title":"Super Car",
"body":"Super Car",
"owner_id":1,
"listingtype_id":1,
"profile_type":0,
"photo_id":440,
"category_id":33,
"subcategory_id":34,
"subsubcategory_id":35,
"creation_date":"2016-03-07 11:00:12",
"modified_date":"2016-03-07 11:00:12",
"end_date":null,
"approved":1,
"featured":0,
"sponsored":0,
"newlabel":0,
"rating_avg":0,
"rating_editor":0,
"rating_users":0,
"location":"Gurgaon, Haryana, India",
"price":20000,
"review_count":0,
"view_count":0,
"comment_count":0,
"like_count":0,
"search":1,
"closed":1,
"approved_date":"2016-03-07 11:00:12",
"draft":0,
"main_video":"",
"video_snapshot_id":0,
"networks_privacy":null,
"owner_image":"http://example.com/public/album_photo/1b/001b_2d0f.png?c=30f5",
"owner_image_normal":"http://example.com/public/album_photo/1c/001c_964a.png?c=1b80",
"owner_image_profile":"http://example.com/public/user/06/03/0303_d2ab.png?c=b069",
"owner_image_icon":"http://example.com/public/user/07/03/0304_c6a5.png?c=67f4",
"owner_title":"Admin",
"image":"http://example.com/public/sitereview_listing/b9/01/01b8_53a2.jpg?c=5c70",
"image_normal":"http://example.com/public/sitereview_listing/bb/01/01ba_1f8d.jpg?c=548f",
"image_profile":"http://example.com/public/sitereview_listing/ba/01/01b9_4ddb.jpg?c=2eac",
"image_icon":"http://example.com/public/sitereview_listing/bd/01/01bc_0304.jpg?c=fafb",
"content_url":"http://example.com/product/23/super-car",
"allow_to_view":1,
"edit":0,
"delete":0
},
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
My Listings ¶
My ListingsGET/listings/manage{?search}{&orderby}{&page}{&closed}{&limit}{&show}{&reviews}{&1_5_23_field_23}{&1_8_37_field_98}{&location}
Get the listings of a member. Listings 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 listings in response and use page
for the page number. [i.e: If you have 100 listing and the first request has limit=20
and page=1
, then in that case the recent 20 listing will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent listing will be returned.]
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
- search
string
(optional) Example: search=teacherget listings that contain this keyword in title or description.
- category_id (optional, integer, `category_id
string
(required) Default: 13`)get all listings of a particular category ID.
- orderby
string
(optional) Example: orderby=creation_dateget listings in the order of creation date (
orderby=creation_date
) or order of title (orderby=title
) or order of view count (orderby=view_count
) or order of like count (orderby=like_count
) or order of comment_count (orderby=comment_count
) or order of review count (orderby=review_count
) or order of rating avg (orderby=rating_avg
).- closed
integer
(optional) Example: closed=Everyone's Articlesget only closed Listings (
closed=1
) or get open Listings (closed=0
) or get All Listings (closed=
)- show
integer
(optional) Example: show=1get Everyone Listings (
show=1
) or get only my Listings (show=2
) or get Listings I like (show=4
)- reviews
integer
(optional) Example: reviews=rating_usersget Listings Reviewd by users(
reviews=rating_users
)- 1_5_23_field_23
string
(optional) Example: 1_5_23_field_23=michalget listings with matching value for this profile field. You can get the key name for profile field from the response of Listing search form.
- 1_8_37_field_98
string
(optional) Example: 1_8_37_field_98=52get listing with matching value for this profile field. You can get the key name for profile field from the response of Listing search form.
- location
string
(optional) Example: location=Chicago, IL, United Statesget listings belong to this location.
- page
integer
(optional) Example: page=2return the ‘limit’ number of listings of that page of listings.
- limit
integer
(optional) Example: limit=20number of listings. 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
{
"canCreate": 1,
"totalItemCount": 6,
"listings": [
{
"listing_id": 1147,
"title": "House on Rent",
"body": "<p dir=\"ltr\">test</p>\n",
"owner_id": 35,
"listingtype_id": 1,
"package_id": 1,
"profile_type": 15,
"photo_id": 75406,
"category_id": 39,
"subcategory_id": 43,
"subsubcategory_id": 56,
"creation_date": "2016-04-19 13:21:27",
"modified_date": "2016-04-19 13:21:27",
"expiration_date": "2250-01-01 00:00:00",
"payment_date": null,
"end_date": null,
"status": "initial",
"pending": 0,
"approved": 1,
"featured": 0,
"sponsored": 0,
"newlabel": 0,
"rating_avg": 0,
"rating_editor": 0,
"rating_users": 0,
"location": "",
"price": "$135.00",
"review_count": 0,
"view_count": 11,
"comment_count": 2,
"like_count": 0,
"search": 1,
"closed": 0,
"approved_date": "2016-04-19 13:21:27",
"draft": 0,
"main_video": "",
"video_snapshot_id": 0,
"networks_privacy": null,
"owner_image": "http://example.com//public/user/68/28/01/12641_aead.jpg?c=1540",
"owner_image_normal": "http://example.com//public/user/6a/28/01/12643_d52c.jpg?c=35f2",
"owner_image_profile": "http://example.com//public/user/69/28/01/12642_96f3.jpg?c=3ae8",
"owner_image_icon": "http://example.com//public/user/6b/28/01/12644_04fa.jpg?c=caee",
"owner_title": "Andre Holmes",
"image": "http://example.com//public/listing/b5/28/01/1268e_5a99.png?c=8027",
"image_normal": "http://example.com//public/listing/b7/28/01/12690_3204.png?c=3135",
"image_profile": "http://example.com//public/listing/b6/28/01/1268f_e78f.png?c=7d02",
"image_icon": "http://example.com//public/listing/b8/28/01/12691_082a.png?c=9a97",
"content_url": "http://example.com//product/1147/testing-685",
"allow_to_view": 1,
"edit": 0,
"delete": 0,
"gutterMenus": [
{
"label": "Edit Listing Details Product",
"name": "edit",
"url": "listing/edit/1147",
"urlParams": []
},
{
"label": "Add Photos",
"name": "addPhotos",
"url": "listings/photo/1147"
},
{
"label": "Add Videos",
"name": "addVideos",
"url": "listings/video/create/1147"
},
{
"label": "Close Listing",
"name": "close",
"url": "listing/close/1147",
"urlParams": []
},
{
"label": "Delete Listing",
"name": "delete",
"url": "listing/delete/1147",
"urlParams": []
}
]
},
{
"listing_id": 1140,
"title": "Cars on Sell",
"body": "Cars listed for selling",
"owner_id": 35,
"listingtype_id": 1,
"package_id": 1,
"profile_type": 18,
"photo_id": 75325,
"category_id": 29,
"subcategory_id": 32,
"subsubcategory_id": 34,
"creation_date": "2016-04-19 09:37:06",
"modified_date": "2016-04-19 09:37:06",
"expiration_date": "2250-01-01 00:00:00",
"payment_date": null,
"end_date": null,
"status": "initial",
"pending": 0,
"approved": 1,
"featured": 0,
"sponsored": 0,
"newlabel": 0,
"rating_avg": 0,
"rating_editor": 0,
"rating_users": 0,
"location": "",
"price": "$8,775.00",
"review_count": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"search": 1,
"closed": 0,
"approved_date": "2016-04-19 09:37:06",
"draft": 0,
"main_video": "",
"video_snapshot_id": 0,
"networks_privacy": null,
"owner_image": "http://example.com//public/user/68/28/01/12641_aead.jpg?c=1540",
"owner_image_normal": "http://example.com//public/user/6a/28/01/12643_d52c.jpg?c=35f2",
"owner_image_profile": "http://example.com//public/user/69/28/01/12642_96f3.jpg?c=3ae8",
"owner_image_icon": "http://example.com//public/user/6b/28/01/12644_04fa.jpg?c=caee",
"owner_title": "Andre Holmes",
"image": "http://example.com//public/event/64/28/01/1263d_4f94.jpg?c=7e05",
"image_normal": "http://example.com//public/listing/66/28/01/1263f_4b8b.jpg?c=be19",
"image_profile": "http://example.com//public/listing/65/28/01/1263e_eb35.jpg?c=a142",
"image_icon": "http://example.com//public/listing/67/28/01/12640_ce2b.jpg?c=d380",
"content_url": "http://example.com//product/1140/testing-for-editing",
"allow_to_view": 1,
"edit": 0,
"delete": 0,
"gutterMenus": [
{
"label": "Edit Listing Details Product",
"name": "edit",
"url": "listing/edit/1140",
"urlParams": []
},
{
"label": "Add Photos",
"name": "addPhotos",
"url": "listings/photo/1140"
},
{
"label": "Add Videos",
"name": "addVideos",
"url": "listings/video/create/1140"
},
{
"label": "Close Listing",
"name": "close",
"url": "listing/close/1140",
"urlParams": []
},
{
"label": "Delete Listing",
"name": "delete",
"url": "listing/delete/1140",
"urlParams": []
}
]
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Listing Search Form ¶
Listing Search FormGET/listings/search-form
Get the listings search form.
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
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":"Name \/ Keyword"
},
{
"type":"Select",
"name":"orderby",
"label":"Browse By",
"multiOptions":{
"":"",
"creation_date":"Most Recent",
"title":"Alphabetic",
"view_count":"Most Viewed",
"like_count":"Most Liked",
"comment_count":"Most Commented",
"review_count":"Most Reviewed",
"rating_avg":"Most Rated"
}
},
{
"type":"Select",
"name":"show",
"label":"Show",
"multiOptions":{
"1":"Everyone's Products",
"2":"Only My Friends' Products",
"4":"Products I Like",
"only_expiry":"Only Expired Products"
},
"value":1
},
{
"type":"Checkbox",
"name":"has_photo",
"label":"Only Products With Photos",
"multiOptions":{
"1":"Everyone's Products",
"2":"Only My Friends' Products",
"4":"Products I Like",
"only_expiry":"Only Expired Products"
}
},
{
"type":"Select",
"name":"category_id",
"label":"Category",
"multiOptions":{
"0":"",
"11":"Electronics",
"29":"Camera",
"39":"Home Decor",
"57":"Baby Care & Toys",
"162":"Appliances",
"173":"Books, Pens and Diaries",
"437":"Top product"
},
"hasValidators":"true"
},
{
"type":"Select",
"name":"review",
"label":"Products Having Reviews",
"multiOptions":{
"":"",
"rating_avg":"Any Reviews",
"rating_editor":"Editor Reviews",
"rating_users":"User Reviews"
},
"value":""
},
{
"type":"Submit",
"name":"done",
"label":"Search"
}
],
"categoriesForm":{
"162":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"163":"Refrigeration",
"164":"Washers & Dryers",
"165":"Cooking"
}
}
},
"437":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"438":"Sub Top Product"
}
},
"subsubcategories":{
"438":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"439":"3rd level product"
}
}
}
}
},
"fields":{
"1":[
{
"type":"Text",
"name":"1_1_3_field_3",
"label":"Operating System",
"description":""
}
],
"236":[
{
"type":"Text",
"name":"1_236_354_field_354",
"label":"Qualifications",
"description":""
},
{
"type":"Text",
"name":"1_236_361_field_361",
"label":"Posted On",
"description":""
},
{
"type":"Text",
"name":"1_236_355_field_355",
"label":"Additional Information ",
"description":""
},
{
"type":"Textarea",
"name":"1_236_363_field_363",
"label":"Required Skills",
"description":""
},
{
"type":"Text",
"name":"1_236_362_field_362",
"label":"Contact Name \/ Email Id",
"description":""
},
{
"type":"Text",
"name":"1_236_359_field_359",
"label":"Experience Required",
"description":""
},
{
"type":"Text",
"name":"1_236_358_field_358",
"label":"Offered Package",
"description":""
},
{
"type":"Text",
"name":"1_236_357_field_357",
"label":"Job Role",
"description":""
}
],
"173":[
{
"type":"Text",
"name":"1_173_284_field_284",
"label":"Expected Price",
"description":""
}
],
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create Listing ¶
Get Listing Creation FormGET/listings/create
Get the listing creation form. Form divide in form
, subcategories
and fields
section. Get the creation form in form
section, subcategories information in subcategories
section and profile fields information in fields
section.
Returns the form
, subcategories
, and fields
as response. In form
we get the complete listing form, in subcategories
get subcategories information and in fields
get profile fields information.
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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":"Product Title",
"hasValidators":"true"
},
{
"type":"Text",
"name":"tags",
"label":"PRODUCT_TAG_(Keywords)",
"description":"Separate tags with commas."
},
{
"type":"Textarea",
"name":"body",
"label":"Description",
"hasValidators":"true"
},
{
"type":"Select",
"name":"category_id",
"label":"Category",
"multiOptions":{
"0":"",
"11":"Electronics",
"29":"Camera",
"39":"Home Decor",
"57":"Baby Care & Toys",
"162":"Appliances",
"173":"Books, Pens and Diaries",
"437":"Top product"
},
"hasValidators":"true"
},
{
"type":"File",
"name":"photo",
"label":"Main Photo"
},
{
"type":"Select",
"name":"auth_view",
"label":"View Privacy",
"description":"Who may see this listing?",
"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"
},
"value":"everyone"
},
{
"type":"Text",
"name":"price",
"label":"Price (US Dollar)"
},
{
"type":"Select",
"name":"auth_comment",
"label":"Comment Privacy",
"description":"Who may comment on this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"everyone"
},
{
"type":"Select",
"name":"auth_topic",
"label":"Discussion Topic Privacy",
"description":"Who may comment on this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"registered"
},
{
"type":"Select",
"name":"auth_photo",
"label":"Photo Privacy",
"description":"Who may upload photos for this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"registered"
},
{
"type":"Select",
"name":"auth_video",
"label":"Video Privacy",
"description":"Who may create videos for this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"registered"
},
{
"type":"Radio",
"name":"end_date_enable",
"label":"End Date",
"multiOptions":[
"No end date.",
"End product on a specific date. (Please select date by clicking on the calendar icon below.)"
],
"description":"When should this product end?",
"value":0
},
{
"type":"Select",
"name":"draft",
"label":"Status",
"multiOptions":[
"Published",
"Saved As Draft"
],
"description":"If this product is published, it cannot be switched back to draft mode."
},
{
"type":"Checkbox",
"name":"search",
"label":"Show this product on browse page and in various blocks.",
"value":1
},
{
"type":"Submit",
"name":"submit",
"label":"Submit"
}
],
"subcategories":{
"162":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"163":"Refrigeration",
"164":"Washers & Dryers",
"165":"Cooking"
}
}
},
"57":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"58":"Toys",
"60":"Baby Care Products",
"61":"Maternity Health & Care"
}
},
"subsubcategories":{
"58":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"62":"Blocks & Constructions",
"63":"Educational Toys",
"65":"Dolls & Doll Houses"
}
},
"60":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"64":"Bath Care",
"66":"Grooming",
"67":"Baby Bedding",
"68":"Baby Care Combo"
}
},
"61":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"70":"Maternity Care",
"71":"Health & Safety"
}
}
}
},
"173":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"174":"Books, Pads & Leisure",
"176":"Pens, Pencils & Corrections",
"178":"Diaries, Calendars & Filofax"
}
}
},
"29":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"30":"Digital camera",
"31":"Camcorders",
"32":"Camera Accessories"
}
},
"subsubcategories":{
"32":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"33":"Camera Bags",
"34":"Tripods",
"35":"Camera Chargers",
"36":"Camera Batteries",
"37":"Camera Lenses"
}
}
}
},
"11":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"12":"Computers",
"13":"MP3 Players and IPods",
"166":"Kindle"
}
},
"subsubcategories":{
"12":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"16":"Tablets",
"24":"Laptops",
"17":"Desktop PCs"
}
},
"13":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"26":"MP3 Players",
"27":"iPods",
"28":"iPod and MP3 Accessories"
}
},
"166":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"167":"Kindle Devices",
"168":"Kindle eBooks"
}
}
}
}
"fields":{
"58":[
{
"type":"Text",
"name":"1_16_81_field_81",
"label":"Color",
"description":""
}
],
"60":[
{
"type":"Text",
"name":"1_17_83_field_83",
"label":"Quantity",
"description":""
},
{
"type":"Multi_checkbox",
"name":"1_17_82_field_82",
"label":"Ideal For",
"description":"",
"multiOptions":{
"58":"Boy",
"59":"Girl"
}
}
],
"61":[
{
"type":"Text",
"name":"1_17_83_field_83",
"label":"Quantity",
"description":""
},
{
"type":"Multi_checkbox",
"name":"1_17_82_field_82",
"label":"Ideal For",
"description":"",
"multiOptions":{
"58":"Boy",
"59":"Girl"
}
}
],
}
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Create ListingPOST/listings/create
Create a new listing by posting the listing creation form.
To upload the listing 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 | listing title |
price |
no | integer | 120 | make an listing price |
location |
no | string | New York, NY, United States | listing location |
category_id |
yes | integer | 5 | category id |
tags |
no | string | banking, operations | video tags (comma separated) |
body |
no | string | Donated blood is a lifeline for many people needing… | listing short description |
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 listing published (0 ) or saved as draft (1 ) |
search |
no | boolean | 1 | show this listing 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",
"venue_name": "S-3 Square, New York",
"location": "New York, NY, United States",
"category_id": 3,
"tags":"banking, operations",
"price": "2015",
"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",
"search": "1"
}
200
Headers
Content-Type: application/json
Body
{
"listing_id":1148,
"title":"Flowers",
"body":"New Hybrid Flowers",
"owner_id":35,
"listingtype_id":1,
"package_id":1,
"profile_type":0,
"photo_id":0,
"category_id":11,
"subcategory_id":0,
"subsubcategory_id":0,
"creation_date":"2016-04-21 14:03:38",
"modified_date":"2016-04-21 14:03:38",
"expiration_date":"2250-01-01 00:00:00",
"payment_date":null,
"end_date":null,
"status":"initial",
"pending":0,
"approved":1,
"featured":0,
"sponsored":0,
"newlabel":0,
"rating_avg":0,
"rating_editor":0,
"rating_users":0,
"location":"",
"price":0,
"review_count":0,
"view_count":0,
"comment_count":0,
"like_count":0,
"search":1,
"closed":0,
"approved_date":"2016-04-21 14:03:38",
"draft":0,
"main_video":"",
"video_snapshot_id":0,
"networks_privacy":null,
"owner_image":"http://example.com//public/user/68/28/01/12641_aead.jpg?c=1540",
"owner_image_normal":"http://example.com//public/user/6a/28/01/12643_d52c.jpg?c=35f2",
"owner_image_profile":"http://example.com//public/user/69/28/01/12642_96f3.jpg?c=3ae8",
"owner_image_icon":"http://example.com//public/user/6b/28/01/12644_04fa.jpg?c=caee",
"owner_title":"Andre Holmes",
"categoryName":"electronics",
"image":"http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_profile.png",
"image_normal":"http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_normal.png",
"image_profile":"http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_profile.png",
"image_icon":"http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_icon.png",
"content_url":"http://example.com//product/1148/flowers",
"allow_to_view":1,
"edit":0,
"is_like":false,
"delete":0,
"gutterMenu":[
{
"name":"tellafriend",
"label":"Tell a friend",
"url":"listing/tellafriend/1148"
},
{
"name":"report",
"label":"Report",
"url":"report/create/subject/sitereview_listing_1148",
"urlParams":{
"type":"sitereview_listing",
"id":1148
}
},
{
"name":"share",
"label":"Share",
"url":"activity/share",
"urlParams":{
"type":"sitereview_listing",
"id":1148
}
},
{
"name":"videoCreate",
"label":"Add Video",
"url":"listings/video/create/1148"
},
{
"name":"wishlist",
"label":"Add to Wishlist",
"url":"listings/wishlist/add/",
"urlParams":{
"listing_id":1148
}
},
{
"name":"messageowner",
"label":"Message Owner",
"url":"listing/messageowner/1148"
},
{
"label":"Edit Listing Details Product",
"name":"edit",
"url":"listing/edit/1148"
},
{
"name":"report",
"label":"Report This Listing",
"url":"report/create/subject/sitereview_listing_1148",
"urlParams":{
"type":"sitereview_listing",
"id":1148
}
},
{
"label":"Close Listing",
"name":"close",
"url":"listing/close/1148"
},
{
"label":"Delete Listing",
"name":"delete",
"url":"listing/delete/1148",
"urlParams":[
]
}
],
"profile_tabs":[
{
"name":"update",
"label":"Updates"
},
]
}
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."
}
Listing Profile ¶
Listing ProfileGET/listing/view/{listing_id}
Get a listing post and its gutter menu’s (edit, invite, share, delete) and profile tab’s (update, members, photos) with count information.
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
- listing_id
integer
(required) Example: 878listing 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.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"listing_id": 1148,
"title": "Flowers",
"body": "New Hybrid Flowers",
"owner_id": 35,
"listingtype_id": 1,
"package_id": 1,
"profile_type": 0,
"photo_id": 0,
"category_id": 11,
"subcategory_id": 0,
"subsubcategory_id": 0,
"creation_date": "2016-04-21 14:03:38",
"modified_date": "2016-04-21 14:03:38",
"expiration_date": "2250-01-01 00:00:00",
"payment_date": null,
"end_date": null,
"status": "initial",
"pending": 0,
"approved": 1,
"featured": 0,
"sponsored": 0,
"newlabel": 0,
"rating_avg": 0,
"rating_editor": 0,
"rating_users": 0,
"location": "",
"price": 0,
"review_count": 0,
"view_count": 0,
"comment_count": 0,
"like_count": 0,
"search": 1,
"closed": 0,
"approved_date": "2016-04-21 14:03:38",
"draft": 0,
"main_video": "",
"video_snapshot_id": 0,
"networks_privacy": null,
"owner_image": "http://example.com//public/user/68/28/01/12641_aead.jpg?c=1540",
"owner_image_normal": "http://example.com//public/user/6a/28/01/12643_d52c.jpg?c=35f2",
"owner_image_profile": "http://example.com//public/user/69/28/01/12642_96f3.jpg?c=3ae8",
"owner_image_icon": "http://example.com//public/user/6b/28/01/12644_04fa.jpg?c=caee",
"owner_title": "Andre Holmes",
"categoryName": "electronics",
"image": "http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_profile.png",
"image_normal": "http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_normal.png",
"image_profile": "http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_profile.png",
"image_icon": "http://example.com//application/modules/Sitereview/externals/images/nophoto_listing_thumb_icon.png",
"content_url": "http://example.com//product/1148/flowers",
"allow_to_view": 1,
"edit": 0,
"is_like": false,
"delete": 0,
"gutterMenu": [
{
"name": "tellafriend",
"label": "Tell a friend",
"url": "listing/tellafriend/1148"
},
{
"name": "report",
"label": "Report",
"url": "report/create/subject/sitereview_listing_1148",
"urlParams": {
"type": "sitereview_listing",
"id": 1148
}
},
{
"name": "share",
"label": "Share",
"url": "activity/share",
"urlParams": {
"type": "sitereview_listing",
"id": 1148
}
},
{
"name": "videoCreate",
"label": "Add Video",
"url": "listings/video/create/1148"
},
{
"name": "wishlist",
"label": "Add to Wishlist",
"url": "listings/wishlist/add/",
"urlParams": {
"listing_id": 1148
}
},
{
"name": "messageowner",
"label": "Message Owner",
"url": "listing/messageowner/1148"
},
{
"label": "Edit Listing Details Product",
"name": "edit",
"url": "listing/edit/1148"
},
{
"name": "report",
"label": "Report This Listing",
"url": "report/create/subject/sitereview_listing_1148",
"urlParams": {
"type": "sitereview_listing",
"id": 1148
}
},
{
"label": "Close Listing",
"name": "close",
"url": "listing/close/1148"
},
{
"label": "Delete Listing",
"name": "delete",
"url": "listing/delete/1148",
"urlParams": []
}
],
"profile_tabs": [
{
"name": "update",
"label": "Updates"
}
]
}
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 Listing ¶
Get Edit Listing FormGET/listing/edit/{listing_id}
Get the form for editing a listing-post.
Returns the form
, 'subcategories,
fieldsand
formValuesas response. In
formwe get the complete listing form, in
subcategoriesget subcategories information, in
fieldsget profile fields information and in
formValues` we get the form’s values.
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
- listing_id
integer
(required) Example: 878listing 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":"Product Title",
"hasValidators":"true"
},
{
"type":"Text",
"name":"tags",
"label":"PRODUCT_TAG_(Keywords)",
"description":"Separate tags with commas."
},
{
"type":"Textarea",
"name":"body",
"label":"Description",
"hasValidators":"true"
},
{
"type":"Select",
"name":"category_id",
"label":"Category",
"multiOptions":{
"0":"",
"11":"Electronics",
"29":"Camera",
"39":"Home Decor",
"57":"Baby Care & Toys",
"162":"Appliances",
"173":"Books, Pens and Diaries",
"437":"Top product"
},
"hasValidators":"true"
},
{
"type":"File",
"name":"photo",
"label":"Main Photo"
},
{
"type":"Select",
"name":"auth_view",
"label":"View Privacy",
"description":"Who may see this listing?",
"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"
},
"value":"everyone"
},
{
"type":"Text",
"name":"price",
"label":"Price (US Dollar)"
},
{
"type":"Select",
"name":"auth_comment",
"label":"Comment Privacy",
"description":"Who may comment on this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"everyone"
},
{
"type":"Select",
"name":"auth_topic",
"label":"Discussion Topic Privacy",
"description":"Who may comment on this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"registered"
},
{
"type":"Select",
"name":"auth_photo",
"label":"Photo Privacy",
"description":"Who may upload photos for this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"registered"
},
{
"type":"Select",
"name":"auth_video",
"label":"Video Privacy",
"description":"Who may create videos for this listing?",
"multiOptions":{
"registered":"All Registered Members",
"owner_network":"Friends and Networks",
"owner_member_member":"Friends of Friends",
"owner_member":"Friends Only",
"owner":"Just Me"
},
"value":"registered"
},
{
"type":"Radio",
"name":"end_date_enable",
"label":"End Date",
"multiOptions":[
"No end date.",
"End product on a specific date. (Please select date by clicking on the calendar icon below.)"
],
"description":"When should this product end?",
"value":0
},
{
"type":"Select",
"name":"draft",
"label":"Status",
"multiOptions":[
"Published",
"Saved As Draft"
],
"description":"If this product is published, it cannot be switched back to draft mode."
},
{
"type":"Checkbox",
"name":"search",
"label":"Show this product on browse page and in various blocks.",
"value":1
},
{
"type":"Submit",
"name":"submit",
"label":"Submit"
}
],
"subcategories":{
"162":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"163":"Refrigeration",
"164":"Washers & Dryers",
"165":"Cooking"
}
}
},
"57":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"58":"Toys",
"60":"Baby Care Products",
"61":"Maternity Health & Care"
}
},
"subsubcategories":{
"58":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"62":"Blocks & Constructions",
"63":"Educational Toys",
"65":"Dolls & Doll Houses"
}
},
"60":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"64":"Bath Care",
"66":"Grooming",
"67":"Baby Bedding",
"68":"Baby Care Combo"
}
},
"61":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"70":"Maternity Care",
"71":"Health & Safety"
}
}
}
},
"173":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"174":"Books, Pads & Leisure",
"176":"Pens, Pencils & Corrections",
"178":"Diaries, Calendars & Filofax"
}
}
},
"29":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"30":"Digital camera",
"31":"Camcorders",
"32":"Camera Accessories"
}
},
"subsubcategories":{
"32":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"33":"Camera Bags",
"34":"Tripods",
"35":"Camera Chargers",
"36":"Camera Batteries",
"37":"Camera Lenses"
}
}
}
},
"11":{
"form":{
"type":"Select",
"name":"subcategory_id",
"label":"Sub-Category",
"multiOptions":{
"12":"Computers",
"13":"MP3 Players and IPods",
"166":"Kindle"
}
},
"subsubcategories":{
"12":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"16":"Tablets",
"24":"Laptops",
"17":"Desktop PCs"
}
},
"13":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"26":"MP3 Players",
"27":"iPods",
"28":"iPod and MP3 Accessories"
}
},
"166":{
"type":"Select",
"name":"subsubcategory_id",
"label":"3rd Level Category",
"multiOptions":{
"167":"Kindle Devices",
"168":"Kindle eBooks"
}
}
}
}
"fields":{
"58":[
{
"type":"Text",
"name":"1_16_81_field_81",
"label":"Color",
"description":""
}
],
"60":[
{
"type":"Text",
"name":"1_17_83_field_83",
"label":"Quantity",
"description":""
},
{
"type":"Multi_checkbox",
"name":"1_17_82_field_82",
"label":"Ideal For",
"description":"",
"multiOptions":{
"58":"Boy",
"59":"Girl"
}
}
],
"61":[
{
"type":"Text",
"name":"1_17_83_field_83",
"label":"Quantity",
"description":""
},
{
"type":"Multi_checkbox",
"name":"1_17_82_field_82",
"label":"Ideal For",
"description":"",
"multiOptions":{
"58":"Boy",
"59":"Girl"
}
}
],
}
}
"formValues":{
"listing_id":1148,
"title":"Flowers",
"body":"New Hybrid Flowers",
"owner_id":35,
"listingtype_id":1,
"package_id":1,
"profile_type":0,
"photo_id":0,
"category_id":11,
"subcategory_id":0,
"subsubcategory_id":0,
"creation_date":"2016-04-21 14:03:38",
"modified_date":"2016-04-21 14:03:38",
"expiration_date":"2250-01-01 00:00:00",
"payment_date":null,
"end_date":"2016-04-21 00:00:00",
"status":"initial",
"pending":0,
"approved":1,
"featured":0,
"sponsored":0,
"newlabel":0,
"rating_avg":0,
"rating_editor":0,
"rating_users":0,
"location":"",
"price":0,
"review_count":0,
"view_count":0,
"comment_count":0,
"like_count":0,
"search":1,
"closed":0,
"approved_date":"2016-04-21 14:03:38",
"draft":0,
"main_video":"",
"video_snapshot_id":0,
"networks_privacy":null,
"fieldCategoryLevel":"category_id",
"tags":"",
"auth_view":"everyone",
"auth_topic":"registered",
"auth_photo":"registered",
"auth_listing":"owner",
"auth_video":"registered"
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Edit ListingPUT/listing/edit/
Edit a listing-post.
Example URI
200
Headers
Content-Type: application/json
Body
| Parameter | Required | Type | Example | Description |
| ----------- | :------: | ------ | ---------------- | ---------------------------------------------------------- |
| `title` | yes | string | Blood Donation Camp | listing title
| `price` | no | integer | 120 | make an listing price
| `location` | no | string | New York, NY, United States | listing location
| `category_id` | yes | integer | 5 | category id
| `tags` | no | string | banking, operations | video tags (comma separated)
| `body` | no | string | Donated blood is a lifeline for many people needing... | listing short description
| `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_16_81_field_81` | no | string | How are you Michal? | Get the profile field value.
| `draft` | yes | boolean | 1 | make an listing published (`0`) or saved as draft (`1`)
| `search` | no | boolean | 1 | show this lisitng on browse page and in various blocks.
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Blood Donation Camp",
"venue_name": "S-3 Square, New York",
"location": "New York, NY, United States",
"category_id": 3,
"tags":"banking, operations",
"price": "2015",
"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",
"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 Listing ¶
Delete ListingDELETE/listing/delete/{listing_id}
Delete a listing-post.
Example URI
- listing_id
integer
(required) Example: 878listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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"
}
Listing Categories ¶
Listing CategoriesGET/listings/categories{&showListings}
Get listing categories, sub-categories or subsub-categories listings and its listings.
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
- showListings
boolean
(optional) Example: showListing=0By default 1
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
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/Sitereview/externals/images/category.png",
"image_normal":"http://example.com/application/modules/Sitereview/externals/images/category.png",
"image_profile":"http://example.com/application/modules/Sitereview/externals/images/category.png",
"image_icon":"http://example.com/application/modules/Sitereview/externals/images/category.png"
}
},
{
"category_id":43,
"category_name":"Employment",
"order":0,
"images":{
"image":"http://example.com/application/modules/Sitereview/externals/images/nophoto_event_caregory.png",
"image_normal":"http://example.com/application/modules/Sitereview/externals/images/nophoto_event_caregory.png",
"image_profile":"http://example.com/application/modules/Sitereview/externals/images/nophoto_event_caregory.png",
"image_icon":"http://example.com/application/modules/Sitereview/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
}
],
"listings":[
{
"listing_id":16,
"imageSrc":{
"image":"http://example.com/public/listing/71/0071_19a9.jpg?c=fb22",
"image_normal":"http://example.com/public/listing/73/0073_90ac.jpg?c=29db",
"image_profile":"http://example.com/public/slisting/72/0072_f4de.jpg?c=01e6",
"image_icon":"http://example.com/public/slisting/75/0075_95c4.jpg?c=958c",
"content_url":"http://example.com/listing/international-conference-on-computer-science/16"
},
"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"
},
}
}
]
}
Tell a Friend ¶
Get Tell a Friend FormGET/listing/tellafriend/
Get the tell a friend form.
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 129`)listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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/listing/tellafriend/
Tell a friend to look the Listing 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
- listing_id (required, integer, `listing_id
string
(required) Default: 129`)listing 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/listing/message-owner/
Get the Message Owner form.
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 129`)listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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/listing/message-owner/
Message Owner of the listing by posting the message owner form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Nice Collection | title |
body |
no | string | Very nice collection of listing | message body |
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 129`)listing 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."
}
Claim Listing ¶
Get Claim Listing FormGET/listing/claim-listing/{listing_id}
Get the Claim Listing form.
Example URI
- listing_id
integer
(required) Example: 129listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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":"nickname",
"label":"Your Name",
"hasValidator":true
},
{
"type":"Text",
"name":"email",
"label":"Your Email",
"hasValidator":true
},
{
"type":"Textarea",
"name":"about",
"label":"About You and the Product",
"hasValidator":true
},
{
"type":"Text",
"name":"contactno",
"label":"Contact Number"
},
{
"type":"Textarea",
"name":"usercomments",
"label":"Comments"
},
{
"type":"Checkbox",
"name":"terms",
"label":"Terms of Service",
"value":0,
"description":"I have read and agree to the terms of service."
},
{
"type":"Submit",
"name":"send",
"label":"Save"
}
],
"formValues":{
"email":"williams@hotmail.com",
"nickname":"williamson",
}
}
Claim ListingPOST/listing/claim-listing/{listing_id}
Claim Listing of the listing by posting the user.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
nickname |
yes | string | William | nickname |
email |
yes | string | william@hotmail.com | Your Email |
about |
yes | string | Listing is nice | about the listing |
contactno |
yes | integer | 498484554 | Contact No |
usercomments |
yes | string | Not bad | comments by user |
terms |
yes | boolean | 1 | message body |
Example URI
- listing_id
integer
(required) Example: 129listing 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."
}
400
Body
{
"status_code":400,
"error":true,
"error_code":"validation_fail",
"message":{
"email":"Please complete this field - it is required.",
"about":"Please complete this field - it is required.",
"terms":"Please complete this field - it is required.",
}
}
Open / Close Listing ¶
Open / Close ListingPOST/listing/close/{listing_id}
Open / close a listing-post. If listing is open then it will be close by default and If listing is close then it will be open by default, there are no need for extra params.
Example URI
- listing_id
integer
(required) Example: 244listing id
- listingtype_id (required, integer, `listingtype=1`) ... gets listings of a particular listingtype_id.
string
(required)
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"
}
Subscribe To User Listing ¶
Subscribe to ListingPOST/listing/add/{listing_id}
Susbcribe to the listings of a user.Need to send listing_id & listingtype_id
Example URI
- listing_id
integer
(required) Example: 244listing id
- listingtype_id (required, integer, `listingtype=1`) ... gets listings of a particular listingtype_id.
string
(required)
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"
}
Unsubscribe To User Listing ¶
Unsubscribe to ListingPOST/listing/remove/{listing_id}
Unsusbcribe to the listings of a user.Need to send listing_id & listingtype_id
Example URI
- listing_id
integer
(required) Example: 244listing id
- listingtype_id (required, integer, `listingtype=1`) ... gets listings of a particular listingtype_id.
string
(required)
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"
}
Apply Now ¶
Get Apply Now FormGET/listing/apply-now/{listing_id}
Get Apply Now Form.
Example URI
- listing_id
integer
(required)listing id
- listingtype_id(required, integer) ... gets listings of a particular listingtype_id.
string
(required)
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": "sender_name",
"label": "Your Name",
"hasValidator": true
},
{
"type": "Text",
"name": "sender_email",
"label": "Your Email",
"hasValidator": true
},
{
"type": "Text",
"name": "contact",
"label": "Contact",
"hasValidator": true
},
{
"type": "File",
"name": "filename",
"label": "Resume"
},
{
"type": "textarea",
"name": "body",
"label": "Message",
"hasValidator": true
},
{
"type": "Submit",
"name": "submit",
"label": "Apply"
}
],
"formValues": {
"sender_name": "Lily Jones",
"sender_email": "lily@gmail.com"
}
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Apply NowPOST/listing/apply-now/{listing_id}{?listingtype_id}
Apply Now for the listing by posting the apply now form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
sender_name |
yes | string | lily | name |
sender_email |
yes | string | lily@gmail.com | |
contact |
yes | integer | 9765678776 | contact number |
filename |
yes | FILE | File in multipart form | |
body |
yes | string | Please consider me for the profile | message body |
Example URI
- listing_id
integer
(required)listing id
- listingtype_id
integer
(required)listingtype 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."
}
Where To Buy Options ¶
Get Listing Where to buy optionsGET/listing/where-to-buy
Get options listed for where to buy with min price options.
Example URI
- listing_id(required, integer) ... listing_id
string
(required)- listingtype_id(required, integer,) ... gets listings of a particular listingtype_id.
string
(required)
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"currency":"USD",
"minPrice":100,
"priceInfo":[
{
"priceinfo_id":92,
"listing_id":77,
"wheretobuy_id":1,
"title":"TigerDirect",
"url":"http://www.tigerdirect.com/applications/SearchTools/item-details.asp?EdpNo=4904361",
"price":100,
"address":"",
"contact":"",
"photo_id":0,
"wheretobuy_title":"Others",
"minPriceOption":1,
"tag_image":"http://devaddons1.socialengineaddons.com/mobiledemotesting/application/modules/Sitereview/externals//images/icons/tag_red.png"
}
{
"priceinfo_id":232,
"listing_id":77,
"wheretobuy_id":3,
"title":null,
"url":"http://www.ebay.in/itm/HP-Pavilion-11-S002TU-Touch-W0H98P-Celeron-Dual-Core-2GB-500GB-Win1-wbr-0-Notebook-/112164985859?&_trksid=p2056016.l4276",
"price":325,
"address":null,
"contact":null,
"photo_id":15669,
"wheretobuy_title":"ebay",
"image":"http://example.com/sitereview_where_to_buy/72/3d/3d35_2d2e.gif?c=7f9c"
},
{
"priceinfo_id":237,
"listing_id":77,
"wheretobuy_id":23,
"title":null,
"url":"https://www.google.co.in",
"price":580,
"address":null,
"contact":null,
"photo_id":19932,
"wheretobuy_title":"COOKING.COM",
"image":"http://example.com/sitereview_where_to_buy/2a/4e/4ddc_4cb4.gif?c=259a"
}
]
}
Multiple Listing Types Plugin Core-Reviews & Ratings Plugin/ Photos ¶
These are the APIs for the SocialEngineAddOns : Multiple Listing Types Plugin Core (Reviews & Ratings Plugin).
Listing Photo List ¶
Listing Photo ListGET/listings/photo/list/{&page}{&limit}
Get the listing’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
- listing_id (required, integer, `listing_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- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
- page
integer
(optional) Example: page=2return the ‘limit’ number of guest of that page of listing 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,
"listing_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/sitereview_listing/85/0085_a752.png?c=d6a5",
"image_normal": "http://example.com/public/sitereview_listing/86/0086_3c2e.png?c=9fa6",
"image_profile": "http://example.com/public/sitereview_listing/85/0085_a752.png?c=d6a5",
"image_icon": "http://example.com/public/sitereview_listing/88/0088_3612.png?c=99b3",
"content_url": "http://example.com/listing-item/photo/view/listing_id/14/photo_id/133",
"user_title": "Martina James",
"likes_count": 0,
"is_like": 0
},
{
"photo_id": 137,
"album_id": 13,
"listing_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/sitereview_listing/89/0089_9eb8.png?c=857e",
"image_normal": "http://example.com/public/sitereview_listing/8a/008a_f4f6.png?c=7bcf",
"image_profile": "http://example.com/public/sitereview_listing/89/0089_9eb8.png?c=857e",
"image_icon": "http://example.com/public/sitereview_listing/8c/008c_216f.png?c=1078",
"content_url": "http://example.com/listing-item/photo/view/listing_id/14/photo_id/137",
"user_title": "Martina James",
"likes_count": 0,
"is_like": 0
}
],
"menu": [
{
"label": "Edit",
"name": "edit",
"url": "listings/photo/edit/137"
},
{
"label": "Delete",
"name": "delete",
"url": "listings/photo/delete/137"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Upload PhotosPOST/listings/photo/list/{&page}{&limit}
Upload the photos into the listing.
To upload the listing photos, send the files as an array of multipart / form-data
elements with the photo
API request parameters.
Example URI
- listing_id (required, integer, `listing_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."
}
Listing Photo View ¶
Listing Photo ViewGET/listings/photo/view/{?menu}
Get the listing 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
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
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,
"listing_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/sitereview_listing/89/0089_9eb8.png?c=857e",
"image_normal": "http://example.com/public/sitereview_listing/8a/008a_f4f6.png?c=7bcf",
"image_profile": "http://example.com/public/sitereview_listing/89/0089_9eb8.png?c=857e",
"image_icon": "http://example.com/public/sitereview_listing/8c/008c_216f.png?c=1078",
"content_url": "http://example.com/listing-item/photo/view/listing_id/14/photo_id/137",
"menu": [
{
"label": "Edit",
"name": "edit",
"url": "listings/photo/edit/137"
},
{
"label": "Delete",
"name": "delete",
"url": "listings/photo/delete/137"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Edit listing Photo Info ¶
Get listing Photo Info FormGET/listings/photo/edit/
Get edit listing 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
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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,
"listing_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/listings/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/listings/photo/delete/
Delete the listing photo by log-in user.
Example URI
- photo_id (required, integer, `photo_id
string
(required) Default: 947`)photo id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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."
}
Multiple Listing Types Plugin Core-Reviews & Ratings Plugin/ Videos ¶
These are the APIs for the SocialEngineAddOns : Multiple Listing Types Plugin Core (Reviews & Ratings Plugin).
Listing Video List ¶
Listing Video ListGET/listings/videos/{?page}{&limit}{&menu}
Get the listing’s video listing.
In case of pagination, we need to use 2 parameters limit
and page
. Use limit
to set the number of videos in response and use page
for the page number. [i.e: If you have 100 videos and the first request has limit=20
and page=1
, then in that case the recent 20 videos will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent videos will be returned.]
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 58`)listing 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.
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
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,
"listing_id": 14,
"title": "Video",
"description": "Trip Video",
"search": 1,
"owner_id": 4,
"creation_date": "2016-02-02 11:06:20",
"modified_date": "2016-02-02 11:06:20",
"view_count": 1,
"comment_count": 0,
"type": 2,
"code": 153283760,
"photo_id": 106,
"rating": 0,
"like_count": 0,
"status": 1,
"file_id": 0,
"duration": 1244,
"is_import": 0,
"rotation": 0,
"image": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"image_normal": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"image_profile": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"image_icon": "http://example.com/public/sitereview_video/6a/006a_2429.jpg?c=dc09",
"content_url": "http://example.com/listings/video/14/4/1/slug/video",
"owner_image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
"owner_image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
"owner_title": "Martina James",
"allow_to_view": 1,
"rating_count": 0,
"video_url": "player.vimeo.com/video/153283760?title=0&byline=0&portrait=0&wmode=opaque&autoplay=1"
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
404
Body
{
"status_code": 404,
"error": true,
"error_code": "no_record",
"message": "No record found"
}
Create listing Video ¶
Get Video Create FormGET/listings/video/create/
Get the listing video creation form.
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 58`)listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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/listings/video/create/
Create a new listing video by posting the listing 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
- listing_id (required, integer, `listing_id
string
(required) Default: 58`)listing 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"
}
Listing Video Profile ¶
Listing Video ProfileGET/listings/video/{?menu}
Get a video post and its gutter menu’s (create, edit, delete, share, etc) information.
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 25`)listing 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.
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Body
{
"gutterMenu": [
{
"label": "Post New Video",
"name": "create",
"url": "advancedlisting/video/create/262"
},
{
"label": "Edit Video",
"name": "edit",
"url": "advancedlisting/video/edit/262/13"
},
{
"label": "Delete Video",
"name": "delete",
"url": "advancedlisting/video/delete/262/13"
},
{
"label": "Share",
"name": "share",
"url": "activity/share",
"urlParams": {
"type": "sitereview_video",
"id": 13
}
}
],
"response": {
"video_id": 13,
"listing_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": "",
"listing_type_title": "listings",
"listing_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 listing Video ¶
Get Edit listing Video FormGET/listings/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
- listing_id (required, integer, `listing_id
string
(required) Default: 124`)listing id
- video_id (required, integer, `video_id
string
(required) Default: 124`)video id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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 listing VideoPUT/listings/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
- listing_id (required, integer, `listing_id
string
(required) Default: 124`)listing 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 listing Video ¶
Delete listing VideoDELETE/listings/video/delete/
Delete a video-post.
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 124`)listing id
- video_id (required, integer, `video_id
string
(required) Default: 124`)video id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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"
}
Multiple Listing Types Plugin Core - Reviews & Ratings Plugin/ Reviews ¶
These are the APIs for the SocialEngineAddOns : Multiple Listing Types Plugin Core (Reviews & Ratings Plugin).
Listing Reviews List ¶
Listing Review ListGET/listings/reviews/browse/{&order}{&show}{&getRating}{&page}{&limit}
Get the listing’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
- listing_id (required, integer, `listing_id
string
(required) Default: 58`)listing 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.
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
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": "sitereview_listing",
"profile_type_review": 0,
"owner_id": 4,
"title": "Nice",
"body": "Nice listing.Had a great time",
"pros": "listing 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",
"listing_title": "Sample",
"category_name": "Conventions",
"is_helful": 1,
"image": "http://example.com/public/sitereview_listing/85/0085_a752.png?c=d6a5",
"image_normal": "http://example.com/public/sitereview_listing/86/0086_3c2e.png?c=9fa6",
"image_profile": "http://example.com/public/sitereview_listing/85/0085_a752.png?c=d6a5",
"image_icon": "http://example.com/public/sitereview_listing/88/0088_3612.png?c=99b3",
"content_url": "http://example.com/listing-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/listings/review/create/
Get the review create form and rating form.
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 14`)listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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 listing?",
"hasValidator":"true"
},
{
"type":"Textarea",
"name":"cons",
"label":"Cons",
"description":"What do you dislike about this listing?",
"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/listings/review/create/
Post review in listing.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Nice listing 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 listing is recommend (recommend=1) or no(recommend=0) |
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 14`)listing id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Nice listing 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/listings/review/
Get a listing review post’s
Example URI
- review_id (required, integer, `review_id
string
(required) Default: 14`)review id
- listing_id (required, integer, `listing_id
string
(required) Default: 14`)listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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": "sitereview_listing",
"profile_type_review": 0,
"owner_id": 5,
"title": "Nice listing 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": "admin",
"listing_type_title": "listings",
"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/listings/review/delete/
Delete a Review.
Example URI
- review_id (required, integer, `review_id
string
(required) Default: 14`)review id
- listing_id (required, integer, `listing_id
string
(required) Default: 14`)listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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/listings/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
- listing_id (required, integer, `listing_id
string
(required) Default: 14`)listing id
- helpful
integer
(required) Example: helpful=1helpful(helpful=1) or not helpful(helpful=2)
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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"
}
Multiple Listing Types Plugin Core - Reviews & Ratings Plugin / Wishlist ¶
These are the APIs for the SocialEngineAddOns: Multiple Listings Type Plugin.
Wishlist Browse ¶
Wishlist BrowseGET/listings/wishlist{?search}{&orderby}{&member}{&page}{&limit}
Get the wishlist listing. wishlist 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 wishlist in response and use page
for the page number. [i.e: If you have 100 wishlist and the first request has limit=20
and page=1
, then in that case the recent 20 wishlist will be returned in response, and if limit=20
and page=2
is sent in request, then the next 20 recent wishlist will be returned.]
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
- search
string
(optional) Example: search=teacherget wishlist that contain this keyword in title or description.
- search_wishlist (optional, string, `search_wishlist
string
(required) Default: my_wishlist`) ... get My wishlist(`search_wishlist=my_wishlist`) or get Friends wishlist (`search_wishlist=friends_wishlist`).- orderby
string
(optional) Example: orderby=wishlist_idget video listings in the order Recent wishlist created (
orderby=wishlist_id
) or the total no of listings in the wishlist (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 wishlist of that page of wishlist listings.
- limit
integer
(optional) Example: limit=20number of listings. 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": [
{
"wishlist_id": 7,
"title": "Buildings",
"body": "Collection of Buildings",
"owner_id": 2,
"listing_id": 15,
"creation_date": "2016-02-02 06:18:37",
"modified_date": "2016-02-02 07:36:29",
"view_count": 0,
"total_item": 3,
"listing_images_1": {
"image": "http://example.com/public/sitereview_listing/6b/006b_df74.jpg?c=43dd",
"image_normal": "http://example.com/public/sitereview_listing/6d/006d_8e9f.jpg?c=eb71",
"image_profile": "http://example.com/public/sitereview_listing/6c/006c_873e.jpg?c=c205",
"image_icon": "http://example.com/public/sitereview_listing/6f/006f_128c.jpg?c=230e",
"content_url": "http://example.com/listing-item/trip-to-dehradun/15"
},
"listing_images_2": {
"image": "http://example.com/public/sitereview_listing/65/0065_2b5a.jpg?c=14d5",
"image_normal": "http://example.com/public/sitereview_listing/67/0067_9faa.jpg?c=0d77",
"image_profile": "http://example.com/public/sitereview_listing/66/0066_45f9.jpg?c=6c24",
"image_icon": "http://example.com/public/sitereview_listing/69/0069_0c32.jpg?c=1942",
"content_url": "http://example.com/listing-item/trip-to-sitlakhet/13"
},
"listing_images_3": {
"image": "http://example.com/public/sitereview_listing/5a/005a_c18e.jpg?c=bff3",
"image_normal": "http://example.com/public/sitereview_listing/5c/005c_d7b6.jpg?c=fd5b",
"image_profile": "http://example.com/public/sitereview_listing/5b/005b_6815.jpg?c=f3b2",
"image_icon": "http://example.com/public/sitereview_listing/5e/005e_813c.jpg?c=0e70",
"content_url": "http://example.com/listing-item/world-t20-2016/12"
}
},
{
"wishlist_id": 2,
"title": "Harry Series",
"body": "Collection of HP",
"owner_id": 2,
"listing_id": 11,
"creation_date": "2016-01-29 05:23:39",
"modified_date": "2016-01-29 05:23:39",
"view_count": 68,
"total_item": 1,
"listing_images_1": {
"image": "http://example.com/public/sitereview_listing/55/0055_92b8.jpg?c=c3a4",
"image_normal": "http://example.com/public/sitereview_listing/57/0057_784b.jpg?c=d26c",
"image_profile": "http://example.com/public/sitereview_listing/56/0056_92b8.jpg?c=c3a4",
"image_icon": "http://example.com/public/sitereview_listing/59/0059_e8fa.jpg?c=1d66",
"content_url": "http://example.com/listing-item/harry-potter-wishlist/11"
}
},
{
"wishlist_id": 1,
"title": "My Trip ",
"body": "Trips thats are organised by me",
"owner_id": 1,
"listing_id": 8,
"creation_date": "2016-01-21 06:34:52",
"modified_date": "2016-01-21 06:34:52",
"view_count": 83,
"total_item": 2,
"listing_images_1": {
"image": "http://example.com/public/sitereview_listing/55/0055_92b8.jpg?c=c3a4",
"image_normal": "http://example.com/public/sitereview_listing/57/0057_784b.jpg?c=d26c",
"image_profile": "http://example.com/public/sitereview_listing/56/0056_92b8.jpg?c=c3a4",
"image_icon": "http://example.com/public/sitereview_listing/59/0059_e8fa.jpg?c=1d66",
"content_url": "http://example.com/listing-item/harry-potter-wishlist/11"
},
"listing_images_2": {
"image": "http://example.com/public/sitereview_listing/38/0038_80c3.jpg?c=e911",
"image_normal": "http://example.com/public/sitereview_listing/3a/003a_dbc4.jpg?c=88a6",
"image_profile": "http://example.com/public/sitereview_listing/39/0039_4278.jpg?c=c810",
"image_icon": "http://example.com/public/sitereview_listing/3c/003c_ab2f.jpg?c=ae97",
"content_url": "http://example.com/listing-item/international-kites-festival/8"
}
}
]
}
401
Body
{
"status_code": 401,
"error": true,
"error_code": "unauthorized",
"message": "User does not have access to this resource."
}
Wishlist Search Form ¶
Wishlist Search FormGET/listings/wishlist/search-form
Get wishlist search form.
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
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_wishlist",
"label": "wishlist",
"multiOptions": {
"": "",
"my_wishlist": "My listing wishlist",
"friends_wishlist": "My Friends listing wishlist"
}
},
{
"type": "Text",
"name": "member",
"label": "Member's Name/Email"
},
{
"type": "Select",
"name": "orderby",
"label": "Browse By",
"multiOptions": {
"wishlist_id": "Most Recent",
"total_item": "Maximum listings",
"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 Wishlist ¶
Get Wishlist Create FormGET/listings/wishlist/create
Get wishlist creation form.
Example URI
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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": "wishlist Name",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "body",
"label": "Description"
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this wishlist?",
"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 wishlistPOST/listings/wishlist/create
Create a new wishlist by posting the wishlist creation form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Adventure listings | listing title |
body |
no | string | Collection of adventurous listings | listing 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 listings",
"body": "Collection of adventurous listings ",
"auth_view": "everyone"
}
200
Headers
Content-Type: application/json
Body
{
"response": {
"wishlist_id": 8,
"title": "Adventure listings",
"body": "Collection of adventurous listings",
"owner_id": 4,
"listing_id": 0,
"creation_date": "2016-02-04 12:55:17",
"modified_date": "2016-02-04 12:55:17",
"view_count": 0,
"wishlist_creator_name": "John Adams",
"owner_image": "http://example.com/public/sitereview_listing/39/0039_4278.jpg",
"owner_image_normal": "http://example.com/public/sitereview_listing/39/0039_4278.jpg",
"owner_image_profile": "http://example.com/public/sitereview_listing/39/0039_4278.jpg",
"owner_image_icon": "http://example.com/public/sitereview_listing/39/0039_4278.jpg",
"auth_view": "everyone",
"total_listings": 0
},
"gutterMenus": [
{
"name": "memberwishlist",
"label": "John Adams listing wishlist",
"url": "listings/wishlist",
"urlParams": {
"member": "John Adams"
}
},
{
"name": "create",
"label": "Create New listing wishlist",
"url": "listings/wishlist/create"
},
{
"name": "edit",
"label": "Edit wishlist",
"url": "listings/wishlist/edit/8"
},
{
"name": "delete",
"label": "Delete wishlist",
"url": "listings/wishlist/delete/8"
},
{
"name": "tellAFriend",
"label": "Tell A Friend",
"url": "listings/wishlist/tell-a-friend",
"urlParams": {
"wishlist_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 Wishlist ¶
Get Edit wishlist FormGET/listings/wishlist/edit
Get the form for editing a wishlist.
Returns the form
and formValues
as response. In form
we get the complete wishlist form and in formValues
we get the form’s values.
Example URI
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 878`)wishlist id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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":"wishlist Name",
"hasValidator":"true"
},
{
"type":"Textarea",
"name":"body",
"label":"Description"
},
{
"type":"Select",
"name":"auth_view",
"label":"View Privacy",
"description":"Who may see this wishlist?",
"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":{
"wishlist_id":14,
"title":"latest",
"body":"",
"owner_id":5,
"listing_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 WishlistPUT/listings/wishlist/edit
Edit a wishlist-post.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Adventure listings | listing title |
body |
no | string | Collection of adventurous listings | listing content |
auth_view |
yes | string | everyone | view authorization (owner, owner_member, owner_network, etc.) |
Example URI
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 878`)wishlist id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"title": "Adventure listings",
"body": "Collection of adventurous listings ",
"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."
}
Wishlist Profile ¶
Wishlist ProfileGET/listings/wishlist/
Get a wishlist post and its gutter menu’s (edit, create, message-owner, delete) and the listing of listings in the wishlist.
Example URI
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 878`)wishlist id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_id.
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
200
Headers
Content-Type: application/json
Body
{
"response": {
"wishlist_id": 1,
"title": "Thailand Trip ",
"body": "Enjoyed at lot with friends in Thailand Trip",
"owner_id": 1,
"listing_id": 8,
"creation_date": "2016-01-21 06:34:52",
"modified_date": "2016-01-21 06:34:52",
"view_count": 86,
"wishlist_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_listings": 2,
"listing": [
{
"listing_id": 11,
"title": "Harry Potter wishlist",
"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/sitereview_listing/55/0055_92b8.jpg?c=c3a4",
"image_normal": "http://example.com/public/sitereview_listing/57/0057_784b.jpg?c=d26c",
"image_profile": "http://example.com/public/sitereview_listing/56/0056_92b8.jpg?c=c3a4",
"image_icon": "http://example.com/public/sitereview_listing/59/0059_e8fa.jpg?c=1d66",
"content_url": "http://example.com/listing-item/harry-potter-wishlist/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
},
{
"listing_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/sitereview_listing/38/0038_80c3.jpg?c=e911",
"image_normal": "http://example.com/public/sitereview_listing/3a/003a_dbc4.jpg?c=88a6",
"image_profile": "http://example.com/public/sitereview_listing/39/0039_4278.jpg?c=c810",
"image_icon": "http://example.com/public/sitereview_listing/3c/003c_ab2f.jpg?c=ae97",
"content_url": "http://example.com/listing-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": "memberwishlist",
"label": "admin listing wishlist",
"url": "listings/wishlist",
"urlParams": {
"member": "John"
}
},
{
"name": "create",
"label": "Create New listing wishlist",
"url": "listings/wishlist/create"
},
{
"name": "messageOwner",
"label": "Message Owner",
"url": "listings/wishlist/message-owner",
"urlParams": {
"wishlist_id": 1
}
},
{
"name": "tellAFriend",
"label": "Tell A Friend",
"url": "listings/wishlist/tell-a-friend",
"urlParams": {
"wishlist_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 Wishlist ¶
Delete WishlistDELETE/listings/wishlist/delete/
Delete a wishlist-post.
Example URI
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 878`)wishlist id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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 listing to Wishlist ¶
Get Add to wishlist FormGET/listings/wishlist/add/
Get the add to wishlist form.
Returns the wishlist
and form
as response.wishlist
we get the complete listing of user wishlist and the information if the listing is already present in respective wishlist.form
we get the new wishlist creation form.By sending the values of checkboxes user can add or remove an listing from a wishlist.
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 129`)listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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": "wishlist_20",
"label": "dv",
"value": 0
},
{
"type": "Text",
"name": "title",
"label": "wishlist Name",
"hasValidator": "true"
},
{
"type": "Textarea",
"name": "body",
"label": "Description"
},
{
"type": "Select",
"name": "auth_view",
"label": "View Privacy",
"description": "Who may see this wishlist?",
"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 a Listing to WishlistPOST/listings/wishlist/add/
Add listing to wishlist post.
User can either add an listing to an existing wishlist or create a new wishlist using this request.
To add an listing to an existing wishlist
add the wishlist name with value 1 in parameter (wishlist_16=1
).In that case user need not to pass title
,body
and auth_view
along with the request.
To create a new wishlist send title
,body
and auth_view
along with the request
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Social work | wishlist title |
body |
no | string | Collection of listings for social cause | |
auth_view |
yes | string | owner | view privacy |
wishlist_name |
no | integer | wishlist_16=1 | add listing to existing wishlist |
Example URI
- listing_id (required, integer, `listing_id
string
(required) Default: 878`)listing id
valid
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Body
{
"wishlist_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 listing From wishlist ¶
Remove listing from wishlistPOST/listings/wishlist/remove/{wishlist_id}/{?listing_id}
Remove an listing from his own wishlist
Example URI
- wishlist_id
integer
(required) Example: 244wishlist id
- listing_id
integer
(required) Example: 1listing id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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/listings/wishlist/tell-a-friend/
Get the tell a friend form.
Example URI
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 129`)wishlist id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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/listings/wishlist/tell-a-friend/
Tell a friend to view the wishlist 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
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 129`)wishlist 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/listings/wishlist/message-owner/
Get the Message Owner form.
Example URI
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 129`)wishlist id
- listingtype_id (required, integer, `listingtype_id
string
(required) Default: 1`)gets listings of a particular listingtype_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/listings/wishlist/message-owner/
Message Owner of the wishlist by posting the message owner form.
Parameter | Required | Type | Example | Description |
---|---|---|---|---|
title |
yes | string | Nice Collection | title |
body |
no | string | Very nice collection of listings | message body |
Example URI
- wishlist_id (required, integer, `wishlist_id
string
(required) Default: 129`)wishlist 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."
}