Back to top

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 and Consumer Secret Key are used to make a connection between API client and server. These keys are also used for creating OAuth 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 and OAuth 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]

Directory Pages api docs

Lists all the apis of Directory/pages

Browse

Browse
GET/sitepages/browse

Get the directory page listing. Pages 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 pages in response and use page for the page number. [i.e: If you have 100 pages and the first request has limit=20 and page=1, then in that case the recent 20 pages will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent pages will be returned.]

Example URI

GET /sitepages/browse
URI Parameters
HideShow
offer_type (optional, string, `offer_type
string (required) Default: all`) ... gets listing of pages which have (`offer_type=All Offers`) , gets all hot offers (`offer_type=Hot Offers`) , gets Featured offers (`offer_type=Featured Offers`) or you can leave it empty which will have no effect of this field on searching . 
search
string (optional) Example: search=mobile

string to be matched with page’ names.

sitepage_location (optional, string,`sitepage_location
string (required) Default: india`) 

string to be matched with page’ location.

sitepage_street (optional, string,`sitepage_street
string (required) Default: iffco chowk`) 

string to be matched with page’s street from location.

sitepage_city (optional, string,`sitepage_city
string (required) Default: gurgaon`) 

string to be matched with page’s city name evaluated from location.

sitepage_state (optional,string,`sitepage_state
string (required) Default: new delhi`) 

string to be matched with page’s state name evaluated from location.

sitepage_country (optional,string,`sitepage_country
string (required) Default: india`) 

string to be matched with page’s country name evaluated from location.

show
int (optional) Example: show=1

gets listing of pages with options show=Everyone\'s Pages which show every user pages , show=Only My Friends\' Pages which shows pages owned by members present in your friend list , show=Pages I Like shows pages which the current user has liked , show=Featured Pages shows pages which have featured marked on them.

closed
int (optional) Example: closed=1

shows pages listing which are (closed=closed) or (closed=open) or (closed=both) .

orderby
string (optional) Example: orderby=Most Recent

orderby field shows pages considering some stats and the stats include orderby=Most Recent shows pages in descending order date with current date as maximum , orderby=Most Viewed shows the pages with view count in descending order, orderby=Most Commented shows pages in the order of comments in descending order , orderby=Most Liked shows pages in the order of likes count in descending order , ‘orderby=Alphabetical’ shows pages in the alphabetical order of page titles, orderby=Most Reviewed , the pages with the maximum review count will be shown first , orderby=Most Rated shows pages in the order of rating.

category
string (required) 

shows pages of a certain category .

Page
string (required) 

gets the listings with the page number and the limit eg, page=1 will show listings from 1 to limit depending on order by.

limit
string (required) 

gets the listings with limit per page eg.limit=10 will show 10 listing pages per page

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "canCreate": 1,
    "totalItemCount": 2,
    "response": [
      {
        "page_id": 5,
        "title": "selling my Mobile",
        "page_url": "sellingmobile",
        "body": "I want to sell my blackberry curve",
        "overview": null,
        "owner_id": 1,
        "package_id": 1,
        "category_id": 1,
        "profile_type": 4,
        "photo_id": 62,
        "price": 0,
        "location": "India , Haryana , Gurgaon",
        "creation_date": "2016-04-26 11:33:30",
        "modified_date": "2016-04-26 11:33:30",
        "approved": 0,
        "featured": 0,
        "sponsored": 0,
        "view_count": 1,
        "comment_count": 0,
        "like_count": 0,
        "review_count": 0,
        "foursquare_text": null,
        "search": 1,
        "closed": 0,
        "declined": 0,
        "pending": 1,
        "aprrove_date": null,
        "draft": 1,
        "subcategory_id": 0,
        "userclaim": 1,
        "offer": 0,
        "email": "",
        "website": "",
        "phone": "",
        "status": "initial",
        "all_post": 1,
        "payment_date": null,
        "expiration_date": null,
        "notes": null,
        "gateway_id": null,
        "gateway_profile_id": null,
        "networks_privacy": null,
        "subsubcategory_id": 0,
        "subpage": 0,
        "parent_id": 0,
        "member_title": "",
        "page_cover": 0,
        "follow_count": 0,
        "fbpage_url": null,
        "badge_id": 0,
        "member_invite": 1,
        "member_approval": 1,
        "member_count": 1,
        "rating": 0,
        "category_title": "Mobiles",
        "image": "http://example.com/seapi/public/siteevent_event/3e/003e_d126.png?c=b212",
        "image_normal": "http://example.com/seapi/public/siteevent_event/40/0040_fd80.png?c=b631",
        "image_profile": "http://example.com/seapi/public/siteevent_event/3f/003f_ba0f.png?c=6b8f",
        "image_icon": "http://example.com/seapi/public/siteevent_event/41/0041_9754.png?c=ceb1",
        "content_url": "http://example.com/seapi/pageitem/selling-my",
        "owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "owner_title": "raj",
        "owner_url": "http://example.com/seapi/profile/raj",
        "allow_to_view": 1,
        "edit": 1,
        "delete": 1
      },
      {
        "page_id": 4,
        "title": "selling my galaxy s",
        "page_url": "selling-my-galaxy-s",
        "body": "i want to sell my galaxy s ",
        "overview": null,
        "owner_id": 1,
        "package_id": 1,
        "category_id": 1,
        "profile_type": 4,
        "photo_id": 58,
        "price": 0,
        "location": null,
        "creation_date": "2016-04-26 11:26:01",
        "modified_date": "2016-04-26 11:26:02",
        "approved": 0,
        "featured": 0,
        "sponsored": 0,
        "view_count": 1,
        "comment_count": 0,
        "like_count": 0,
        "review_count": 0,
        "foursquare_text": null,
        "search": 1,
        "closed": 0,
        "declined": 0,
        "pending": 1,
        "aprrove_date": null,
        "draft": 1,
        "subcategory_id": 0,
        "userclaim": 1,
        "offer": 0,
        "email": "",
        "website": "",
        "phone": "",
        "status": "initial",
        "all_post": 1,
        "payment_date": null,
        "expiration_date": null,
        "notes": null,
        "gateway_id": null,
        "gateway_profile_id": null,
        "networks_privacy": null,
        "subsubcategory_id": 0,
        "subpage": 0,
        "parent_id": 0,
        "member_title": "",
        "page_cover": 0,
        "follow_count": 0,
        "fbpage_url": null,
        "badge_id": 0,
        "member_invite": 1,
        "member_approval": 1,
        "member_count": 1,
        "rating": 0,
        "category_title": "Mobile",
        "image": "http://example.com/seapi/public/siteevent_event/3a/003a_d126.png?c=b212",
        "image_normal": "http://example.com/seapi/public/siteevent_event/3c/003c_fd80.png?c=b631",
        "image_profile": "http://example.com/seapi/public/siteevent_event/3b/003b_ba0f.png?c=6b8f",
        "image_icon": "http://example.com/seapi/public/siteevent_event/3d/003d_9754.png?c=ceb1",
        "content_url": "http://example.com/seapi/pageitem/selling-my-galaxy-s",
        "owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "owner_title": "raj",
        "owner_url": "http://example.com/seapi/profile/raj",
        "allow_to_view": 1,
        "edit": 1,
        "delete": 1
      }
    ]
  }
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}

Manage Directory Pages

Manage Directory Pages Listings
GET/sitepages/manage

Get the directory page listing. Pages 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 pages in response and use page for the page number. [i.e: If you have 100 pages and the first request has limit=20 and page=1, then in that case the recent 20 pages will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent pages will be returned.]

Example URI

GET /sitepages/manage
URI Parameters
HideShow
offer_type (optional, string, `offer_type
string (required) Default: all`) ... gets listing of pages which have (`offer_type=All Offers`) , gets all hot offers (`offer_type=Hot Offers`) , gets Featured offers (`offer_type=Featured Offers`) or you can leave it empty which will have no effect of this field on searching . 
search
string (optional) Example: search=mobile

string to be matched with page’ names.

sitepage_location (optional,string,`sitepage_location
string (required) Default: india`) 

string to be matched with page’ location.

sitepage_street (optional,string,`sitepage_street
string (required) Default: iffco chowk`) 

string to be matched with page’s street from location.

sitepage_city (optional,string,`sitepage_city
string (required) Default: gurgaon`) 

string to be matched with page’s city name evaluated from location.

sitepage_state (optional,string,`sitepage_state
string (required) Default: new delhi`) 

string to be matched with page’s state name evaluated from location.

sitepage_country (optional,string,`sitepage_country
string (required) Default: india`) 

string to be matched with page’s country name evaluated from location.

show
int (optional) Example: show=1

gets listing of pages with options show=Everyone\'s Pages which show every user pages , show=Only My Friends\' Pages which shows pages owned by members present in your friend list , show=Pages I Like shows pages which the current user has liked , show=Featured Pages shows pages which have featured marked on them.

closed
int (optional) Example: closed=1

shows pages listing which are (closed=closed) or (closed=open) or (closed=both) .

orderby
string (optional) Example: orderby=Most Recent

orderby field shows pages considering some stats and the stats include orderby=Most Recent shows pages in descending order date with current date as maximum , orderby=Most Viewed shows the pages with view count in descending order, orderby=Most Commented shows pages in the order of comments in descending order , orderby=Most Liked shows pages in the order of likes count in descending order , ‘orderby=Alphabetical’ shows pages in the alphabetical order of page titles, orderby=Most Reviewed , the pages with the maximum review count will be shown first , orderby=Most Rated shows pages in the order of rating.

category
string (required) 

shows pages of a certain category .

Page
string (required) 

gets the listings with the page number and the limit eg, page=1 will show listings from 1 to limit depending on order by.

limit
string (required) 

gets the listings with limit per page eg.limit=10 will show 10 listing pages per page

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Body
{
    "status_code": 200,
    "body": {
    "canCreate": 1,
    "totalItemCount": 2,
    "response": [
            {
                "page_id": 5,
                "title": "selling my Mobile",
                "page_url": "sellingmobile",
                "body": "I want to sell my blackberry curve",
                "overview": null,
                "owner_id": 1,
                "package_id": 1,
                "category_id": 1,
                "profile_type": 4,
                "photo_id": 62,
                "price": 0,
                "location": "India , Haryana , Gurgaon",
                "creation_date": "2016-04-26 11:33:30",
                "modified_date": "2016-04-26 11:33:30",
                "approved": 0,
                "featured": 0,
                "sponsored": 0,
                "view_count": 1,
                "comment_count": 0,
                "like_count": 0,
                "review_count": 0,
                "foursquare_text": null,
                "search": 1,
                "closed": 0,
                "declined": 0,
                "pending": 1,
                "aprrove_date": null,
                "draft": 1,
                "subcategory_id": 0,
                "userclaim": 1,
                "offer": 0,
                "email": "",
                "website": "",
                "phone": "",
                "status": "initial",
                "all_post": 1,
                "payment_date": null,
                "expiration_date": null,
                "notes": null,
                "gateway_id": null,
                "gateway_profile_id": null,
                "networks_privacy": null,
                "subsubcategory_id": 0,
                "subpage": 0,
                "parent_id": 0,
                "member_title": "",
                "page_cover": 0,
                "follow_count": 0,
                "fbpage_url": null,
                "badge_id": 0,
                "member_invite": 1,
                "member_approval": 1,
                "member_count": 1,
                "rating": 0,
                "category_title": "Mobiles",
                "image": "http://example.com/seapi/public/siteevent_event/3e/003e_d126.png?c=b212",
                "image_normal": "http://example.com/seapi/public/siteevent_event/40/0040_fd80.png?c=b631",
                "image_profile": "http://example.com/seapi/public/siteevent_event/3f/003f_ba0f.png?c=6b8f",
                "image_icon": "http://example.com/seapi/public/siteevent_event/41/0041_9754.png?c=ceb1",
                "content_url": "http://example.com/seapi/pageitem/selling-my",
                "owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
                "owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
                "owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
                "owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
                "owner_title": "raj",
                "owner_url": "http://example.com/seapi/profile/raj",
                "allow_to_view": 1,
                "edit": 1,
                "delete": 1,
                "menu": [
                    {
                        "name": "edit",
                        "label": "Edit Page Details",
                        "url": "sitepage/edit/5"
                    },
                    {
                        "name": "close",
                        "label": "Close Page",
                        "url": "sitepage/close/5"
                    },
                    {
                        "name": "delete",
                        "label": "Delete Page",
                        "url": "sitepage/delete/5"
                    }
                ],
            },
            {
                "page_id": 4,
                "title": "selling my galaxy s",
                "page_url": "selling-my-galaxy-s",
                "body": "i want to sell my galaxy s ",
                "overview": null,
                "owner_id": 1,
                "package_id": 1,
                "category_id": 1,
                "profile_type": 4,
                "photo_id": 58,
                "price": 0,
                "location": null,
                "creation_date": "2016-04-26 11:26:01",
                "modified_date": "2016-04-26 11:26:02",
                "approved": 0,
                "featured": 0,
                "sponsored": 0,
                "view_count": 1,
                "comment_count": 0,
                "like_count": 0,
                "review_count": 0,
                "foursquare_text": null,
                "search": 1,
                "closed": 0,
                "declined": 0,
                "pending": 1,
                "aprrove_date": null,
                "draft": 1,
                "subcategory_id": 0,
                "userclaim": 1,
                "offer": 0,
                "email": "",
                "website": "",
                "phone": "",
                "status": "initial",
                "all_post": 1,
                "payment_date": null,
                "expiration_date": null,
                "notes": null,
                "gateway_id": null,
                "gateway_profile_id": null,
                "networks_privacy": null,
                "subsubcategory_id": 0,
                "subpage": 0,
                "parent_id": 0,
                "member_title": "",
                "page_cover": 0,
                "follow_count": 0,
                "fbpage_url": null,
                "badge_id": 0,
                "member_invite": 1,
                "member_approval": 1,
                "member_count": 1,
                "rating": 0,
                "category_title": "Mobile",
                "image": "http://example.com/seapi/public/siteevent_event/3a/003a_d126.png?c=b212",
                "image_normal": "http://example.com/seapi/public/siteevent_event/3c/003c_fd80.png?c=b631",
                "image_profile": "http://example.com/seapi/public/siteevent_event/3b/003b_ba0f.png?c=6b8f",
                "image_icon": "http://example.com/seapi/public/siteevent_event/3d/003d_9754.png?c=ceb1",
                "content_url": "http://example.com/seapi/pageitem/selling-my-galaxy-s",
                "owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
                "owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
                "owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
                "owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
                "owner_title": "raj",
                "owner_url": "http://example.com/seapi/profile/raj",
                "allow_to_view": 1,
                "edit": 1,
                "delete": 1,
                "menu": [
                    {
                        "name": "edit",
                        "label": "Edit Page Details",
                        "url": "sitepage/edit/5"
                    },
                    {
                        "name": "close",
                        "label": "Close Page",
                        "url": "sitepage/close/5"
                    },
                    {
                        "name": "delete",
                        "label": "Delete Page",
                        "url": "sitepage/delete/5"
                    }
                ],
            }
        ]
    }
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Directory Pages

Get Create Form
GET/Sitepages/create

Returns the create Directory page form

Example URI

GET /Sitepages/create
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "form": [
      {
        "type": "Text",
        "name": "title",
        "label": "Title",
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "page_url",
        "label": "URL",
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "location",
        "description": "Eg: Fairview Park, Berkeley, CA",
        "label": "Enter a location"
      },
      {
        "type": "Select",
        "name": "package_id",
        "label": "Select Package",
        "multiOptions": {
          "1": "Free Page Package"
        }
      },
      {
        "type": "Select",
        "name": "category_id",
        "label": "Category",
        "multiOptions": {
          "1": "Automobile",
          "6": "Jobs",
          "12": "Movies - TV",
          "17": "Fashion",
          "23": "Real Estate",
          "29": "Sports",
          "34": "Travel",
          "39": "Electronics",
          "46": "Places"
        },
        "hasValidator": "true"
      },
      {
        "type": "Text",
        "name": "tags",
        "label": "Tags (Keywords)",
        "description": "Separate tags with commas."
      },
      {
        "type": "File",
        "name": "photo",
        "label": "Main Photo"
      },
      {
        "type": "Text",
        "name": "price",
        "label": "Price (US Dollar)"
      },
      {
        "type": "Select",
        "name": "auth_view",
        "label": "View Privacy",
        "description": "Who may see this Page?",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "member": "SitePage Guests Only"
        }
      },
      {
        "type": "Select",
        "name": "splcreate",
        "label": "Poll Create Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "splcreate",
        "label": "Poll Create Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "secreate",
        "label": "Event Create Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "smcreate",
        "label": "Music Create Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "auth_comment",
        "label": "Comment Privacy",
        "description": "Who may comment on this Page?",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "member": "SitePage Guests Only"
        },
        "value": "everyone"
      },
      {
        "type": "Select",
        "name": "sdicreate",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "spcreate",
        "label": "Photo Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "sdcreate",
        "label": "Document Privacy",
        "value": "member"
      },
      {
        "type": "Checkbox",
        "name": "search",
        "label": "Show this Page on browse page and in various blocks.",
        "value": 1
      },
      {
        "label": "Create",
        "type": "Submit",
        "name": "submit"
      }
    ],
    "fields": {
      "Default Type": [
        {
          "type": "Text",
          "name": "1_1_40_field_40",
          "label": "Specialties",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_1_41_field_41",
          "label": "Colors Available",
          "description": ""
        }
      ],
      "Automobile": [
        {
          "type": "Text",
          "name": "1_4_14_field_14",
          "label": "Overall Length (mm)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_15_field_15",
          "label": "Overall Width (mm)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_16_field_16",
          "label": "Overall Height (mm)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_17_field_17",
          "label": "Mileage Highway (km/liter)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_18_field_18",
          "label": "Mileage City (km/liter)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_19_field_19",
          "label": "Mileage Overall (km/liter)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_20_field_20",
          "label": "Maximum Speed (kmph)",
          "description": ""
        },
        {
          "type": "Select",
          "name": "1_4_21_field_21",
          "label": "Wheel Type",
          "description": "",
          "multiOptions": {
            "13": "Tube-less",
            "14": "Normal"
          }
        }
      ],
      "Jobs": [
        {
          "type": "Text",
          "name": "1_5_37_field_37",
          "label": "Designation",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_5_38_field_38",
          "label": "Salary",
          "description": ""
        }
      ],
      "Movies - TV": [
        {
          "type": "Text",
          "name": "1_6_39_field_39",
          "label": "Duration (mins)",
          "description": ""
        },
        {
          "type": "Select",
          "name": "1_6_35_field_35",
          "label": "Genre",
          "description": "",
          "multiOptions": {
            "17": "Action",
            "18": "Comedy",
            "19": "Crime",
            "20": "Documentary",
            "21": "Drama",
            "22": "Family",
            "23": "Foreign",
            "24": "Horror",
            "25": "Romance",
            "26": "Sci-Fi",
            "27": "Sports",
            "28": "Suspense",
            "29": "Teen",
            "30": "War"
          }
        }
      ],
      "Fashion": [
        {
          "type": "Text",
          "name": "1_7_33_field_33",
          "label": "Color",
          "description": ""
        },
        {
          "type": "Textarea",
          "name": "1_7_34_field_34",
          "label": "Care Instructions",
          "description": ""
        }
      ],
      "Real Estate": [
        {
          "type": "Text",
          "name": "1_8_30_field_30",
          "label": "Unit Area",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_8_31_field_31",
          "label": "Basic Sale Price",
          "description": ""
        },
        {
          "type": "Textarea",
          "name": "1_8_32_field_32",
          "label": "Facilities",
          "description": ""
        }
      ],
      "Sports": [
        {
          "type": "Text",
          "name": "1_9_28_field_28",
          "label": "Affiliation",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_9_29_field_29",
          "label": "Awards",
          "description": ""
        }
      ],
      "Travel": [
        {
          "type": "Text",
          "name": "1_10_27_field_27",
          "label": "Specialty",
          "description": ""
        }
      ],
      "Electronics": [
        {
          "type": "Text",
          "name": "1_11_22_field_22",
          "label": "Dimensions",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_11_23_field_23",
          "label": "Power",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_11_24_field_24",
          "label": "Colors Available",
          "description": ""
        }
      ],
      "Places": [
        {
          "type": "Text",
          "name": "1_12_25_field_25",
          "label": "Opening Hours",
          "description": ""
        },
        {
          "type": "Select",
          "name": "1_12_26_field_26",
          "label": "Parking",
          "description": "",
          "multiOptions": {
            "15": "Available",
            "16": "Not-available"
          }
        }
      ]
    },
    "subCategories": {
      "1": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "2": "Bikes",
            "3": "Buses",
            "4": "Cars",
            "5": "Trucks"
          }
        }
      },
      "6": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "7": "Accounting",
            "8": "Advertising",
            "9": "Banking",
            "10": "Engineering",
            "11": "Law"
          }
        }
      },
      "12": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "13": "Movie",
            "14": "Theater Show",
            "15": "TV Channel",
            "16": "TV Show"
          }
        }
      },
      "17": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "18": "Accessories",
            "19": "Apparels",
            "20": "Jewelery",
            "21": "Shoes",
            "22": "Watches"
          }
        }
      },
      "23": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "24": "Apartments",
            "25": "Bungalows",
            "26": "Commercial",
            "27": "Penthouses",
            "28": "Plots"
          }
        }
      },
      "29": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "30": "Athlete",
            "31": "Coach",
            "32": "League",
            "33": "Team"
          }
        }
      },
      "34": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "35": "Destinations",
            "36": "Guides",
            "37": "Hotels",
            "38": "Operators"
          }
        }
      },
      "39": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "40": "Air Conditioners",
            "41": "Cameras",
            "42": "Mobile Phones",
            "43": "Music Players",
            "44": "Refrigerators",
            "45": "Televisions"
          }
        }
      },
      "46": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "47": "Restaurants",
            "48": "Theatres",
            "49": "Schools",
            "50": "Hospitals",
            "51": "Malls"
          }
        }
      }
    }
  }
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Create Form
POST/Sitepages/create

Add a Directory Page.

Parameter Required Type Example Description
title yes string Selling by new mobile The title of the page
page_url yes string sellmobile The user given page url
location yes string Gurgaon, Haryana, India The location taken from google location api suggestions
package_id yes int 1 The selected package for Directory Pages
category_id yes int 1 Selected category for Directory Pages
subcategory_id no int 10 Selected subcategory category for Directory Pages
subsubcategory_id no int 21 Selected subsubcategory category for Directory Pages
tags no string database,mobile,data Comma Separated string values relating to the subject of the Directory Page
photo no file image file The front image of the Directory Page
price no int 112 The price of the Item selling in this page
auth_view yes string “everyone” Who can view the Directory Page
auth_comment yes string “everyone” Who can comment the Directory Page
splcreate no string “everyone” Privary setting for Poll creation in directory page
sspcreate no string “everyone” Privary setting for Sub pages creation in directory page
secreate no string “everyone” Privary setting for Event creation in directory page
smcreate no string “everyone” Privary setting for Music creation in directory page
sdicreate no string “everyone” Privary setting for Discussion creation in directory page
spcreate no string “everyone” Privary setting for Photo creation in directory page
sdcreate no string “everyone” Privary setting for Document creation in directory page
search no int 1 Setting to show this page on search results
draft no int 1 Setting to keep this page on draft or not
1_1_40_field_40 no string “The condition is good” Specilities of the Directory page or the product
1_4_14_field_14 no int 100 overall length

Example URI

POST /Sitepages/create
Response  400
HideShow
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."
  }
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Directory Pages

Directory Pages Search Form
GET/Sitepages/search-form

Gets the Directory page list search form.

Example URI

GET /Sitepages/search-form
Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status_code": 200,
  "body": {
    "form": [
      {
        "type": "Select",
        "name": "offer_type",
        "label": "Pages With Offers",
        "multiOptions": {
          "": "",
          "all": "All Offers",
          "hot": "Hot Offers",
          "featured": "Featured Offers"
        }
      },
      {
        "type": "Text",
        "name": "search",
        "label": "Search Pages"
      },
      {
        "type": "Text",
        "name": "sitepage_location",
        "label": " Location "
      },
      {
        "type": "Text",
        "name": "sitepage_street",
        "label": "Street"
      },
      {
        "type": "Text",
        "name": "sitepage_city",
        "label": "City"
      },
      {
        "type": "Text",
        "name": "sitepage_state",
        "label": "State"
      },
      {
        "type": "Text",
        "name": "sitepage_country",
        "label": "Country"
      },
      {
        "type": "Select",
        "name": "show",
        "label": "Show",
        "multiOptions": {
          "1": "Everyone's Pages",
          "2": "Only My Friends' Pages",
          "4": "Pages I Like",
          "5": "Featured Pages"
        }
      },
      {
        "type": "Select",
        "name": "closed",
        "label": "Status",
        "multiOptions": {
          "0": "Only Open Pages",
          "1": "Only Closed Pages",
          "": "All Pages"
        }
      },
      {
        "type": "Select",
        "name": "orderby",
        "label": "Browse By",
        "multiOptions": {
          "": "",
          "creation_date": "Most Recent",
          "view_count": "Most Viewed",
          "comment_count": "Most Commented",
          "like_count": "Most Liked",
          "title": "Alphabetical",
          "review_count": "Most Reviewed",
          "rating": "Most Rated"
        }
      },
      {
        "type": "Select",
        "name": "category",
        "label": "Category",
        "multiOptions": {
          "1": "Automobile",
          "6": "Jobs",
          "12": "Movies - TV",
          "17": "Fashion",
          "23": "Real Estate",
          "29": "Sports",
          "34": "Travel",
          "39": "Electronics",
          "46": "Places"
        }
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Search"
      }
    ]
  }
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}

View Directory Page

View Directory Page
GET/Sitepage/view/page_id

Gets the Particular Directory page .

Example URI

GET /Sitepage/view/page_id
Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "viewer_id": 1,
  "status_code": 200,
  "body": {
    "gutterMenu": [
      {
        "name": "edit",
        "label": "Edit Page Details",
        "url": "sitepage/edit/5"
      },
      {
        "name": "share",
        "label": "Share This Page",
        "url": "activity/share",
        "urlParams": {
          "type": "sitepage_page",
          "id": 5
        }
      },
      {
        "name": "tellafriend",
        "label": "Tell a friend",
        "url": "sitepage/tellafriend/5"
      },
      {
        "name": "claim",
        "label": "Claim Page",
        "url": "sitepage/claim/5"
      },
      {
        "name": "close",
        "label": "Close Page",
        "url": "sitepage/close/5"
      },
      {
        "name": "delete",
        "label": "Delete Page",
        "url": "sitepage/delete/5"
      },
      {
        "name": "report",
        "label": "Report This Page",
        "url": "report/create/subject/sitepage_page_5",
        "urlParams": {
          "type": "sitepage_page",
          "id": 5
        }
      }
    ],
    "tabsMenu": {
      "updates": {
        "count": 0,
        "name": "updates",
        "label": "Updates",
        "url": "sitepage/updates/5"
      },
      "information": {
        "name": "information",
        "label": "Info",
        "url": "sitepage/information/5"
      },
      "photos": {
        "count": 0,
        "name": "photos",
        "label": "Photos",
        "url": "sitepage/photos/index/5"
      },
      "reviews": {
        "count": 0,
        "name": "reviews",
        "label": "Reviews",
        "url": "sitepage/Reviews/5"
      },
      "videos": {
        "count": 0,
        "name": "videos",
        "label": "Videos",
        "url": "sitepage/Videos/5"
      },
      "discussions": {
        "count": 0,
        "name": "topics",
        "label": "Discussions",
        "url": "sitepage/topics/5"
      }
    },
    "response": {
      "page_id": 5,
      "title": "selling my",
      "page_url": "selling-my",
      "body": "i want",
      "overview": null,
      "owner_id": 1,
      "package_id": 1,
      "category_id": 1,
      "profile_type": 4,
      "photo_id": 62,
      "price": 0,
      "location": null,
      "creation_date": "2016-04-26 11:33:30",
      "modified_date": "2016-04-26 11:33:30",
      "approved": 0,
      "featured": 0,
      "sponsored": 0,
      "view_count": 1,
      "comment_count": 0,
      "like_count": 0,
      "review_count": 0,
      "foursquare_text": null,
      "search": 1,
      "closed": 0,
      "declined": 0,
      "pending": 1,
      "aprrove_date": null,
      "draft": 1,
      "subcategory_id": 0,
      "userclaim": 1,
      "offer": 0,
      "email": "",
      "website": "",
      "phone": "",
      "status": "initial",
      "all_post": 1,
      "payment_date": null,
      "expiration_date": null,
      "notes": null,
      "gateway_id": null,
      "gateway_profile_id": null,
      "networks_privacy": null,
      "subsubcategory_id": 0,
      "subpage": 0,
      "parent_id": 0,
      "member_title": "",
      "page_cover": 0,
      "follow_count": 0,
      "fbpage_url": null,
      "badge_id": 0,
      "member_invite": 1,
      "member_approval": 1,
      "member_count": 1,
      "rating": 0,
      "content_url": "http://example.com/seapi/pageitem/selling-my",
      "image": "http://example.com/seapi/public/siteevent_event/3e/003e_d126.png?c=b212",
      "image_normal": "http://example.com/seapi/public/siteevent_event/40/0040_fd80.png?c=b631",
      "image_profile": "http://example.com/seapi/public/siteevent_event/3f/003f_ba0f.png?c=6b8f",
      "image_icon": "http://example.com/seapi/public/siteevent_event/41/0041_9754.png?c=ceb1",
      "owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "owner_title": "sasasasasa",
      "is_like": false,
      "tags": [],
      "category_title": "Automobile"
    }
  }
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}

Directory Pages edit

Get Edit Form
GET/Sitepages/edit/page_id

Returns the create Directory page form

Example URI

GET /Sitepages/edit/page_id
Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "form": [
      {
        "type": "Text",
        "name": "title",
        "label": "Title",
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "page_url",
        "label": "URL",
        "hasValidator": true
      },
      {
        "type": "Text",
        "name": "location",
        "description": "Eg: Fairview Park, Berkeley, CA",
        "label": "Enter a location"
      },
      {
        "type": "Select",
        "name": "category_id",
        "label": "Category",
        "multiOptions": {
          "1": "Automobile",
          "6": "Jobs",
          "12": "Movies - TV",
          "17": "Fashion",
          "23": "Real Estate",
          "29": "Sports",
          "34": "Travel",
          "39": "Electronics",
          "46": "Places"
        },
        "hasValidator": "true"
      },
      {
        "type": "Text",
        "name": "tags",
        "label": "Tags (Keywords)",
        "description": "Separate tags with commas."
      },
      {
        "type": "File",
        "name": "photo",
        "label": "Main Photo"
      },
      {
        "type": "Text",
        "name": "price",
        "label": "Price (US Dollar)"
      },
      {
        "type": "Select",
        "name": "auth_view",
        "label": "View Privacy",
        "description": "Who may see this Page?",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "member": "SitePage Guests Only"
        }
      },
      {
        "type": "Select",
        "name": "sspcreate",
        "label": "Who may create sub pages in this page?",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "splcreate",
        "label": "Poll Create Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "secreate",
        "label": "Event Create Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "smcreate",
        "label": "Music Create Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "auth_comment",
        "label": "Comment Privacy",
        "description": "Who may comment on this Page?",
        "multiOptions": {
          "everyone": "Everyone",
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "member": "SitePage Guests Only"
        },
        "value": "everyone"
      },
      {
        "type": "Select",
        "name": "sdicreate",
        "label": "Discussion Topic Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "spcreate",
        "label": "Photo Privacy",
        "value": "member"
      },
      {
        "type": "Select",
        "name": "sdcreate",
        "label": "Document Privacy",
        "value": "member"
      },
      {
        "type": "Checkbox",
        "name": "search",
        "label": "Show this Page on browse page and in various blocks.",
        "value": 1
      },
      {
        "label": "Status",
        "name": "draft",
        "type": "select",
        "multiOptions": {
          "0": "Saved As Draft",
          "1": "Published"
        }
      },
      {
        "label": "Create",
        "type": "Submit",
        "name": "submit"
      }
    ],
    "fields": {
      "1": [
        {
          "type": "Text",
          "name": "1_1_40_field_40",
          "label": "Specialties",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_1_41_field_41",
          "label": "Colors Available",
          "description": ""
        }
      ],
      "4": [
        {
          "type": "Text",
          "name": "1_4_14_field_14",
          "label": "Overall Length (mm)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_15_field_15",
          "label": "Overall Width (mm)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_16_field_16",
          "label": "Overall Height (mm)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_17_field_17",
          "label": "Mileage Highway (km/liter)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_18_field_18",
          "label": "Mileage City (km/liter)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_19_field_19",
          "label": "Mileage Overall (km/liter)",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_4_20_field_20",
          "label": "Maximum Speed (kmph)",
          "description": ""
        },
        {
          "type": "Select",
          "name": "1_4_21_field_21",
          "label": "Wheel Type",
          "description": "",
          "multiOptions": {
            "13": "Tube-less",
            "14": "Normal"
          }
        }
      ],
      "5": [
        {
          "type": "Text",
          "name": "1_5_37_field_37",
          "label": "Designation",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_5_38_field_38",
          "label": "Salary",
          "description": ""
        }
      ],
      "6": [
        {
          "type": "Text",
          "name": "1_6_39_field_39",
          "label": "Duration (mins)",
          "description": ""
        },
        {
          "type": "Select",
          "name": "1_6_35_field_35",
          "label": "Genre",
          "description": "",
          "multiOptions": {
            "17": "Action",
            "18": "Comedy",
            "19": "Crime",
            "20": "Documentary",
            "21": "Drama",
            "22": "Family",
            "23": "Foreign",
            "24": "Horror",
            "25": "Romance",
            "26": "Sci-Fi",
            "27": "Sports",
            "28": "Suspense",
            "29": "Teen",
            "30": "War"
          }
        }
      ],
      "7": [
        {
          "type": "Text",
          "name": "1_7_33_field_33",
          "label": "Color",
          "description": ""
        },
        {
          "type": "Textarea",
          "name": "1_7_34_field_34",
          "label": "Care Instructions",
          "description": ""
        }
      ],
      "8": [
        {
          "type": "Text",
          "name": "1_8_30_field_30",
          "label": "Unit Area",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_8_31_field_31",
          "label": "Basic Sale Price",
          "description": ""
        },
        {
          "type": "Textarea",
          "name": "1_8_32_field_32",
          "label": "Facilities",
          "description": ""
        }
      ],
      "9": [
        {
          "type": "Text",
          "name": "1_9_28_field_28",
          "label": "Affiliation",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_9_29_field_29",
          "label": "Awards",
          "description": ""
        }
      ],
      "10": [
        {
          "type": "Text",
          "name": "1_10_27_field_27",
          "label": "Specialty",
          "description": ""
        }
      ],
      "11": [
        {
          "type": "Text",
          "name": "1_11_22_field_22",
          "label": "Dimensions",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_11_23_field_23",
          "label": "Power",
          "description": ""
        },
        {
          "type": "Text",
          "name": "1_11_24_field_24",
          "label": "Colors Available",
          "description": ""
        }
      ],
      "12": [
        {
          "type": "Text",
          "name": "1_12_25_field_25",
          "label": "Opening Hours",
          "description": ""
        },
        {
          "type": "Select",
          "name": "1_12_26_field_26",
          "label": "Parking",
          "description": "",
          "multiOptions": {
            "15": "Available",
            "16": "Not-available"
          }
        }
      ]
    },
    "subCategories": {
      "1": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "2": "Bikes",
            "3": "Buses",
            "4": "Cars",
            "5": "Trucks"
          }
        }
      },
      "6": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "7": "Accounting",
            "8": "Advertising",
            "9": "Banking",
            "10": "Engineering",
            "11": "Law"
          }
        }
      },
      "12": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "13": "Movie",
            "14": "Theater Show",
            "15": "TV Channel",
            "16": "TV Show"
          }
        }
      },
      "17": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "18": "Accessories",
            "19": "Apparels",
            "20": "Jewelery",
            "21": "Shoes",
            "22": "Watches"
          }
        }
      },
      "23": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "24": "Apartments",
            "25": "Bungalows",
            "26": "Commercial",
            "27": "Penthouses",
            "28": "Plots"
          }
        }
      },
      "29": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "30": "Athlete",
            "31": "Coach",
            "32": "League",
            "33": "Team"
          }
        }
      },
      "34": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "35": "Destinations",
            "36": "Guides",
            "37": "Hotels",
            "38": "Operators"
          }
        }
      },
      "39": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "40": "Air Conditioners",
            "41": "Cameras",
            "42": "Mobile Phones",
            "43": "Music Players",
            "44": "Refrigerators",
            "45": "Televisions"
          }
        }
      },
      "46": {
        "form": {
          "type": "Select",
          "name": "subcategory_id",
          "label": "Sub-Category",
          "multiOptions": {
            "47": "Restaurants",
            "48": "Theatres",
            "49": "Schools",
            "50": "Hospitals",
            "51": "Malls"
          }
        }
      }
    },
    "formValues": {
      "page_id": 1,
      "title": "c++",
      "page_url": "cpp",
      "body": "this is a programming language which is used very widely",
      "overview": "This is something i have been learning for a lot of time and hope u guys will also like it .",
      "owner_id": 1,
      "package_id": 1,
      "category_id": 39,
      "profile_type": 11,
      "photo_id": 58,
      "price": 0,
      "location": "Gurgaon, Haryana, India",
      "creation_date": "2016-04-05 07:49:32",
      "modified_date": "2016-04-27 12:26:43",
      "approved": 1,
      "featured": 0,
      "sponsored": 0,
      "view_count": 5,
      "comment_count": 0,
      "like_count": 1,
      "review_count": 2,
      "foursquare_text": null,
      "search": 1,
      "closed": 0,
      "declined": 0,
      "pending": 0,
      "aprrove_date": "2016-04-05 07:49:32",
      "draft": 1,
      "subcategory_id": 0,
      "userclaim": 1,
      "offer": 0,
      "email": "",
      "website": "",
      "phone": "",
      "status": "initial",
      "all_post": 1,
      "payment_date": null,
      "expiration_date": "2250-01-01 00:00:00",
      "notes": null,
      "gateway_id": null,
      "gateway_profile_id": null,
      "networks_privacy": null,
      "subsubcategory_id": 0,
      "subpage": 0,
      "parent_id": 0,
      "member_title": "",
      "page_cover": 12,
      "follow_count": 0,
      "fbpage_url": null,
      "badge_id": 0,
      "member_invite": 1,
      "member_approval": 1,
      "member_count": 1,
      "rating": 5
    },
    "field_values": {
      "1": 11,
      "22": "sasas",
      "23": "sasa",
      "24": "sasa"
    }
  }
}

Post Create Form
POST/Sitepages/edit/page_id

Add a Directory Page.

Parameter Required Type Example Description
title yes string Selling by new mobile The title of the page
page_url yes string sellmobile The user given page url
location yes string Gurgaon, Haryana, India The location taken from google location api suggestions
package_id yes int 1 The selected package for Directory Pages
category_id yes int 1 Selected category for Directory Pages
subcategory_id no int 10 Selected subcategory category for Directory Pages
subsubcategory_id no int 21 Selected subsubcategory category for Directory Pages
tags no string database,mobile,data Comma Separated string values relating to the subject of the Directory Page
photo no file image file The front image of the Directory Page
price no int 112 The price of the Item selling in this page
auth_view yes string “everyone” Who can view the Directory Page
auth_comment yes string “everyone” Who can comment the Directory Page
splcreate no string “everyone” Privary setting for Poll creation in directory page
sspcreate no string “everyone” Privary setting for Sub pages creation in directory page
secreate no string “everyone” Privary setting for Event creation in directory page
smcreate no string “everyone” Privary setting for Music creation in directory page
sdicreate no string “everyone” Privary setting for Discussion creation in directory page
spcreate no string “everyone” Privary setting for Photo creation in directory page
sdcreate no string “everyone” Privary setting for Document creation in directory page
search no int 1 Setting to show this page on search results
draft no int 1 Setting to keep this page on draft or not
1_1_40_field_40 no string “The condition is good” Specilities of the Directory page or the product
1_4_14_field_14 no int 100 overall length

Example URI

POST /Sitepages/edit/page_id
Response  400
HideShow
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."
  }
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Delete Directory Page

Delete Directory Page
DELETE/Sitepage/delete/page_id

Deletes the Particular Directory page .

Example URI

DELETE /Sitepage/delete/page_id
Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  500
HideShow
Body
{
  "status_code": 500,
  "error": true,
  "error_code": "internal_server_error",
  "message": null
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Close/Open Directory Page

Close/Open Directory Page
GET/Sitepage/close/page_id

Close / Open the Particular Directory page .

Example URI

GET /Sitepage/close/page_id
Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  500
HideShow
Body
{
  "status_code": 500,
  "error": true,
  "error_code": "internal_server_error",
  "message": null
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Publish Directory Page

Publish Directory Page
POST/Sitepage/publish/page_id

Publish the Particular Directory page .

Parameter Required Type Example Description
search no int 1 search=0 makes the page not searchable in the directory listings in browse action , search=1 makes the page searchable in the directory listings in browe action

Example URI

POST /Sitepage/publish/page_id
Request  valid
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "oauth_parameter_missing",
  "message": "Certain OAuth parameters are missing in your request."
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  500
HideShow
Body
{
  "status_code": 500,
  "error": true,
  "error_code": "internal_server_error",
  "message": null
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Message Owner Of Directory Page

Message Owner of Dirctory Page
GET/Sitepage/messageowner/page_id

Returns the form fields for messaging the owner of Particular Directory Page

Example URI

GET /Sitepage/messageowner/page_id
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": [
    {
      "type": "Text",
      "name": "title",
      "label": "Subject",
      "hasValidators": "true"
    },
    {
      "type": "Textarea",
      "name": "body",
      "label": "Message"
    },
    {
      "type": "Submit",
      "name": "submit",
      "label": "Send Message"
    }
  ]
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Message Owner of Dirctory Page
POST/Sitepage/messageowner/page_id

Send the message to the owner of Particular Directory Page

Parameter Required Type Example Description
title yes string request for phone number The title of the message
body yes string hey,there , please tell me your phone number The description of the message

Example URI

POST /Sitepage/messageowner/page_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  500
HideShow
Body
{
  "status_code": 500,
  "error": true,
  "error_code": "internal_server_error",
  "message": "Internal Server Error"
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": {
    "title": "Please complete this field - it is required."
  }
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Message friend about Directory Page

Message friend about Dirctory Page
GET/Sitepage/tellafriend/page_id

Tell a friend about this Directory Page

Example URI

GET /Sitepage/tellafriend/page_id
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 200,
  "body": {
    "form": [
      {
        "type": "Text",
        "name": "sender_name",
        "label": "Your Name",
        "hasValidator": "true"
      },
      {
        "type": "Text",
        "name": "sender_email",
        "label": "Your Email",
        "has Validator": "true"
      },
      {
        "type": "Text",
        "name": "receiver_emails",
        "label": "To",
        "description": "Separate multiple addresses with commas",
        "hasValidators": "true"
      },
      {
        "type": "Textarea",
        "name": "message",
        "label": "Message",
        "description": "You can send a personal note in the mail.",
        "hasValidator": "true"
      },
      {
        "type": "Checkbox",
        "name": "send_me",
        "label": "Send a copy to my email address."
      },
      {
        "type": "Submit",
        "name": "send",
        "label": "Tell a Friend"
      }
    ]
  }
}

Message friend about Dirctory Page
POST/Sitepage/tellafriend/page_id

Sends the mail containing the message to senders emails about the Directory Page

Parameter Required Type Example Description
sender_name yes string raj Name of the member sending the message
sender_email yes string loren.ipsum@gmail.com Email of the member sending the message
receiver_emails yes string data.ipsum@gmail.com,noah.lemhoon@gmail.com Email of the receivers which will be represented in comma seperated fashion
message yes string This might be the page you like Message which is to be sent.

Example URI

POST /Sitepage/tellafriend/page_id
Response  200
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  204
HideShow
Body
{
  "status_code": 204
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": {
    "message": "Please complete this field - it is required."
  }
}

Information of Directory Page

Information of Directory Page
GET/Sitepage/information/page_id

Returns the basic information and profile fields data of the particular Directory Page

Example URI

GET /Sitepage/information/page_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  400
HideShow
Body
{
  "status_code": 200,
  "body": {
    "basic_information": {
      "1": 1,
      "Posted By:": {
        "link": "/seapi/profile/sasasasasa",
        "name": "sasasasasa"
      },
      "Posted:": "Apr 05, 2016",
      "Last Updated:": "Apr 05, 2016",
      "Views:": 1,
      "Likes:": 1,
      "Category:": "Electronics",
      "Location:": "Gurgaon, Haryana, India",
      "Description:": "this is a programming language which is used very widely"
    },
    "profile_information": {
      "Dimensions": "sasas",
      "Power": "sasa",
      "Colors Available": "sasa"
    }
  }
}

Directory Pages / Album

Directory Page Album Browse

Directory Page Album Browse
GET/sitepage/photos/index/page_id

Returns the album along with pagination for a Particular Directory Page

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of pages in response and use page for the page number. [i.e: If you have 100 pages and the first request has limit=20 and page=1, then in that case the recent 20 pages will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent pages will be returned.]

Example URI

GET /sitepage/photos/index/page_id
URI Parameters
HideShow
itemCount
int (optional) Example: itemCount=10

Set the number of albums you want to display per page , itemCount=10 will show upto 10 albums per page

page
int (optional) Example: page=1

return albums according to page number , page=2 and we suppose itemcount=10 will return albums from 11-20 , similarly page=3 will return albums from 21-30 asn so on…

Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "data": {
      "album_count": 2,
      "albums": {
        "1": {
          "image": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
          "image_normal": "http://example.com/seapi/public/sitepage_page/08/0008_8440.png?c=fc00",
          "image_profile": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
          "image_icon": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
          "content_url": "http://example.com/seapi/pageitems/album/view/page_id/1/album_id/1/slug/c"
        },
        "2": {
          "image": "http://example.com/seapi/public/sitepage_photo/0e/000e_2bb8.jpg?c=772c",
          "image_normal": "http://example.com/seapi/public/sitepage_photo/0f/000f_275e.jpg?c=9ef5",
          "image_profile": "http://example.com/seapi/public/sitepage_photo/0e/000e_2bb8.jpg?c=772c",
          "image_icon": "http://example.com/seapi/public/sitepage_photo/0e/000e_2bb8.jpg?c=772c",
          "content_url": "http://example.com/seapi/pageitems/album/view/page_id/1/album_id/2/slug/cover-photos"
        }
      }
    }
  }
}

Directory Page View Album

Directory Page View Album
GET/sitepage/photos/viewalbum/page_id/album_id

Returns the album along with pagination for a Particular Directory Page

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of pages in response and use page for the page number. [i.e: If you have 100 pages and the first request has limit=20 and page=1, then in that case the recent 20 pages will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent pages will be returned.]

Example URI

GET /sitepage/photos/viewalbum/page_id/album_id
URI Parameters
HideShow
itemCount_photo (optional, int, `itemCount_photo
string (required) Default: 10`) ... Set the number of photos you want to display per page , `itemCount_photo=10` will show upto 10 photos of a particular album per page 
page
int (optional) Example: page=1

return album photos according to page number , page=2 and we suppose itemCount_photo=10 will return album photos from 11-20 , similarly page=3 will return album photos from 21-30 asn so on…

Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "album": {
      "album_id": 1,
      "page_id": 1,
      "owner_id": 1,
      "order": 0,
      "title": "c++",
      "description": "",
      "creation_date": "2016-04-05 07:49:32",
      "modified_date": "2016-04-05 07:53:42",
      "search": 1,
      "photo_id": 7,
      "view_count": 0,
      "comment_count": 0,
      "collectible_count": 1,
      "default_value": 1,
      "like_count": 0,
      "type": null,
      "featured": 0,
      "cover_params": null
    },
    "photos": {
      "7": {
        "album_id": 1,
        "page_id": 1,
        "user_id": 1,
        "order": 2,
        "title": "",
        "description": "",
        "photo_id": 7,
        "view_count": 0,
        "comment_count": 0,
        "like_count": 0,
        "modified_date": "2016-04-05 07:53:42",
        "creation_date": "2016-04-05 07:53:07",
        "photo_hide": 0,
        "file_id": 7,
        "collection_id": 1,
        "images": {
          "image": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
          "image_normal": "http://example.com/seapi/public/sitepage_page/08/0008_8440.png?c=fc00",
          "image_profile": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
          "image_icon": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
          "content_url": "http://example.com/seapi/pageitems/photo/view/page_id/1/album_id/1/photo_id/7"
        }
      },
      "9": {
        "album_id": 1,
        "page_id": 1,
        "user_id": 1,
        "order": 3,
        "title": "",
        "description": "",
        "photo_id": 9,
        "view_count": 0,
        "comment_count": 0,
        "like_count": 0,
        "modified_date": "2016-04-05 07:53:42",
        "creation_date": "2016-04-05 07:53:08",
        "photo_hide": 0,
        "file_id": 9,
        "collection_id": 1,
        "images": {
          "image": "http://example.com/seapi/public/sitepage_page/09/0009_e16d.jpg?c=fe97",
          "image_normal": "http://example.com/seapi/public/sitepage_page/0a/000a_f028.jpg?c=9b02",
          "image_profile": "http://example.com/seapi/public/sitepage_page/09/0009_e16d.jpg?c=fe97",
          "image_icon": "http://example.com/seapi/public/sitepage_page/09/0009_e16d.jpg?c=fe97",
          "content_url": "http://example.com/seapi/pageitems/photo/view/page_id/1/album_id/1/photo_id/9"
        }
      },
      "total_count": 5
    },
    "gutterMenus": [
      {
        "title": "Delete Album",
        "url": "sitepage/photos/deletealbum/1/1",
        "name": "delete"
      },
      {
        "title": "Edit Album",
        "url": "sitepage/photos/editalbum/1/1",
        "name": "edit"
      },
      {
        "title": "Make Featured",
        "url": "sitepage/photos/albumfeatured/1/1",
        "name": "featured"
      },
      {
        "title": "Make Album of the Day",
        "url": "sitepage/photos/addalbumofday/1/1",
        "name": "albumofday"
      },
      {
        "title": "Add Photo",
        "url": "sitepage/photos/addphoto/1/1",
        "name": "addphoto"
      },
      {
        "title": "View Photo",
        "url": "sitepage/photos/viewphoto/1/1/photo_id",
        "name": "viewphoto"
      }
    ]
  }
}

Directory Page edit Album

Directory Page edit album
GET/sitepage/photos/editalbum/page_id/album_id

Returns the edit album form

Example URI

GET /sitepage/photos/editalbum/page_id/album_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "form": [
      {
        "title": "Edit Title",
        "name": "title",
        "value": "database",
        "hasValidator": true
      },
      {
        "type": "select",
        "name": "auth_tag",
        "label": "Tag Post Privacy",
        "description": "Who may tag photos in this album?",
        "multiOptions": {
          "registered": "All Registered Members",
          "owner_network": "Friends and Networks",
          "owner_member_member": "Friends of Friends",
          "owner_member": "Friends Only",
          "owner": "Page Admins"
        },
        "value": "registered"
      },
      {
        "label": "show this album in search results",
        "value": 1,
        "type": "checkbox",
        "name": "search"
      },
      {
        "type": "submit",
        "name": "submit"
      }
    ]
  }
}

Directory Page edit album
POST/sitepage/photos/editalbum/page_id/album_id

Submits the album edit form

Parameter Required Type Example Description
title no string Friend’s Party The title of the album
auth_tag no string registered Permission for tag , in this example all registered users have the permission to tag
search no int 1 1 will dhow this album while searching and 0 will not .

Example URI

POST /sitepage/photos/editalbum/page_id/album_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Directory Page delete Album

Directory Page delete album
DELETE/sitepage/photos/deletealbum/page_id/album_id

Deletes the album

Example URI

DELETE /sitepage/photos/deletealbum/page_id/album_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Directory Page Album - Album of the Day

Directory Page Album - Album of the Day
GET/sitepage/photos/addalbumofday/page_id/album_id

Returns the form for making the album - album of the day

Example URI

GET /sitepage/photos/addalbumofday/page_id/album_id
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "form": [
      {
        "type": "date",
        "name": "startdate",
        "title": "Start Date",
        "required": "true"
      },
      {
        "type": "date",
        "name": "enddate",
        "title": "End Date",
        "required": "true"
      },
      {
        "type": "submit",
        "name": "submit"
      }
    ]
  }
}

Directory Page Album - Album of the Day
POST/sitepage/photos/addalbumofday/page_id/album_id

Makes the album - album of the day

If the album is already present in the album of day list then it updates the startdate and enddate of the album In the albumofday listing.

Parameter Required Type Example Description
startdate yes date 2016-04-27 The start Date of the album of the day
starttime yes date 2016-04-27 The end Date of the album of the day

Example URI

POST /sitepage/photos/addalbumofday/page_id/album_id
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": {
    "startdate": "Please complete this field - it is required."
  }
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Directory Page Album - View Photo

Directory Page Album - View Photo
GET/sitepage/photos/viewphoto/page_id/album_id/photo_id

Returns the details of a particular photo in a Directory Page album.

Example URI

GET /sitepage/photos/viewphoto/page_id/album_id/photo_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "photo": {
      "photo_id": 7,
      "album_id": 1,
      "page_id": 1,
      "user_id": 1,
      "order": 2,
      "title": "",
      "description": "",
      "collection_id": 1,
      "file_id": 7,
      "creation_date": "2016-04-05 07:53:07",
      "modified_date": "2016-04-05 07:53:42",
      "comment_count": 0,
      "like_count": 0,
      "photo_hide": 0,
      "featured": 0,
      "view_count": 0,
      "file_path": {
        "image": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
        "image_normal": "http://example.com/seapi/public/sitepage_page/08/0008_8440.png?c=fc00",
        "image_profile": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
        "image_icon": "http://example.com/seapi/public/sitepage_page/07/0007_6f68.png?c=11a9",
        "content_url": "http://example.com/seapi/pageitems/photo/view/page_id/1/album_id/1/photo_id/7"
      }
    },
    "gutterMenus": [
      {
        "title": "Edit Photo",
        "name": "edit",
        "url": "sitepage/photos/editphoto/1/1/7"
      },
      {
        "title": "Delete Photo",
        "name": "delete",
        "url": "sitepage/photos/deletephoto/1/1/7"
      }
    ]
  }
}

Directory Page Album - Edit Photo

Directory Page Album - Edit Photo
GET/sitepage/photos/editphoto/page_id/album_id/photo_id

returns the form editing the photo title and description

Example URI

GET /sitepage/photos/editphoto/page_id/album_id/photo_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": [
    {
      "title": "Title",
      "name": "title",
      "type": "text"
    },
    {
      "title": "Description",
      "name": "title",
      "type": "text"
    },
    {
      "type": "submit",
      "title": "submit",
      "name": "submit"
    }
  ]
}

Directory Page Album - Edit Photo
POST/sitepage/photos/editphoto/page_id/album_id/photo_id

Updates the title and description of Directory Page album photo.

Parameter Required Type Example Description
title no string Friend’s Party Title of the Image
description no string Friend’s Party and had a lot of fun in it Description of the Image

Example URI

POST /sitepage/photos/editphoto/page_id/album_id/photo_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Directory Page Album - Delete Photo

Directory Page Album - Delete Photo
DELETE/sitepage/photos/deletephoto/page_id/album_id/photo_id

Deletes the photo from Directory page album

Example URI

DELETE /sitepage/photos/deletephoto/page_id/album_id/photo_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Directory Page Album - ADD Photo

Directory Page Album - ADD Photo
POST/sitepage/photos/addphoto/page_id/album_id

Adds a photo to the Directory Page album

Parameter Required Type Example Description
data yes file file A photo

Example URI

POST /sitepage/photos/addphoto/page_id/album_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Directory Pages / Reviews

Browse Directory Page Reviews

Browse Directory Page Reviews
GET/sitepage/reviews/browse/page_id

Return paginated listing of reviews of a Directory Page

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of pages in response and use page for the page number. [i.e: If you have 100 pages and the first request has limit=20 and page=1, then in that case the recent 20 pages will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent pages will be returned.]

Example URI

GET /sitepage/reviews/browse/page_id
URI Parameters
HideShow
search
string (optional) Example: string=value

gets listing of pages which have ‘value’ string in the title of their reviews

Show
string (optional) Example: show=friends_reviews

show the reviews as per the specifications show='' shows reviews posted by everyone , show=friends_reviews only shows reviews of your friends , show=self_reviews shows reviews created by the current user , show=featured shows reviews which are featured

type
string (optional) Example: type=editor
order
string (optional) Example: order=recent

orders the reviews listing , order=recent shows rmost recenet review first , order=rating_highest shows highest rated review first , order=rating_lowest shows lowest rated review first , order=helpfull_most shows the reviews in the descending order of helpful count of the review , order=replay_most shows reviews in the order of most replied reviews desc , order=view_most shows the most viewed review at first

rating
int (optional) Example: rating=1

lists only specified reviews whose rating match the sent parameter , rating=1 shows only those reviews which have 1 rating .

recommend
int (optional) Example: recommend=

shows only those reviews which are recommended.

Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "total_reviews": 1,
    "reviews": [
      {
        "review_id": 1,
        "page_id": 1,
        "owner_id": 2,
        "title": "Value of money",
        "body": "Database",
        "creation_date": "2016-04-28 07:31:01",
        "modified_date": "2016-04-28 07:31:01",
        "view_count": 1,
        "comment_count": 0,
        "like_count": 0,
        "pros": "databse",
        "cons": "database",
        "recommend": 1,
        "featured": 0,
        "rating": 5,
        "owner_title": "bhawin parkeria",
        "owner_image": "http://example.com/seapi/public/user/42/0042_ea08.jpeg?c=9217",
        "owner_image_normal": "http://example.com/seapi/public/user/44/0044_f13b.jpeg?c=cd4d",
        "owner_image_profile": "http://example.com/seapi/public/user/43/0043_a531.jpeg?c=d865",
        "owner_image_icon": "http://example.com/seapi/public/user/45/0045_8756.jpeg?c=f292",
        "page_title": "c++",
        "overall_rating": 5,
        "category_name": "Electronics",
        "image": "http://example.com/seapi/public/sitepage_page/3a/003a_ea08.jpeg?c=9217",
        "image_normal": "http://example.com/seapi/public/sitepage_page/3c/003c_888d.jpeg?c=be21",
        "image_profile": "http://example.com/seapi/public/sitepage_page/3b/003b_a531.jpeg?c=d865",
        "image_icon": "http://example.com/seapi/public/sitepage_page/3d/003d_8756.jpeg?c=f292",
        "content_url": "http://example.com/seapi/pageitem/cpp"
      }
    ]
  }
}

Reviews - Search Form - Directory Page

Reviews - Search Form - Directory Page
GET/sitepage/reviews/search/page_id

Returns the Directory Page review search form

Example URI

GET /sitepage/reviews/search/page_id
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": [
    {
      "type": "Text",
      "name": "search",
      "label": "Search"
    },
    {
      "type": "Select",
      "name": "show",
      "label": "Show",
      "multiOptions": {
        "": "Everyone's Reviews",
        "friends_reviews": "My Friends' Reviews",
        "self_reviews": "My Reviews",
        "featured": "Featured Reviews"
      }
    },
    {
      "type": "Select",
      "name": "type",
      "label": "Reviews Written By",
      "multiOptions": {
        "": "Everyone",
        "editor": "Editors",
        "user": "Users"
      }
    },
    {
      "type": "Select",
      "name": "order",
      "label": "Browse By",
      "multiOptions": {
        "recent": "Most Recent",
        "rating_highest": "Highest Rating",
        "rating_lowest": "Lowest Rating",
        "helpfull_most": "Most Helpful",
        "replay_most": "Most Reply",
        "view_most": "Most Viewed"
      }
    },
    {
      "type": "Select",
      "name": "rating",
      "label": "Ratings",
      "multiOptions": {
        "1": "1 Star",
        "2": "2 Star",
        "3": "3 Star",
        "4": "4 Star",
        "5": "5 Star",
        "": ""
      }
    },
    {
      "type": "Checkbox",
      "name": "recommend",
      "label": "Only Recommended Reviews"
    },
    {
      "type": "Submit",
      "name": "done",
      "label": "Search"
    }
  ]
}

Create Directory Page Review
GET/sitepage/reviews/search/page_id

Returns the review create form

Example URI

GET /sitepage/reviews/search/page_id
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "review_already_present",
  "message": "You have already reviewed on this page"
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "form": [
      {
        "type": "Textarea",
        "name": "pros",
        "label": "Pros",
        "description": "What do you like about this Page?",
        "hasValidator": "true"
      },
      {
        "type": "Textarea",
        "name": "cons",
        "label": "Cons",
        "description": "What do you dislike about this Page?",
        "hasValidator": "true"
      },
      {
        "type": "Textarea",
        "name": "title",
        "label": "One-line summary"
      },
      {
        "type": "Textarea",
        "name": "body",
        "label": "Summary"
      },
      {
        "type": "Radio",
        "name": "recommend",
        "label": "Recommended",
        "description": "Would you recommend this Page to a friend?",
        "multiOptions": {
          "0": "No",
          "1": "Yes"
        }
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Submit"
      }
    ],
    "ratingParams": [
      {
        "type": "Rating",
        "name": "review_rate_0",
        "label": "Overall Rating"
      }
    ]
  }
}

Create Directory Page Review
POST/sitepage/reviews/search/page_id

Posts Data adn creates a review

Parameter Required Type Example Description
pros yes string smart, lightweight Some advantages of the Directory Page
cons yes string over priced Some disadvantages of the page
title yes string value for money Some catchy line
body no string this is a great page Full summary
recommend yes int 1 whether you want to recommend this page to someone
review_rate_0 yes float 3 overall rating of the page

Example URI

POST /sitepage/reviews/search/page_id
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": {
    "pros": "Please complete this field - it is required.",
    "cons": "Please complete this field - it is required.",
    "review_rate_0": "Please complete this field - it is required."
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  204
HideShow
Body
{
  "status_code": 204
}

View Directory Page Review
GET/sitepage/reviews/search/page_id

Returns the review data

Example URI

GET /sitepage/reviews/search/page_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "response": {
      "review_id": 1,
      "page_id": 1,
      "owner_id": 2,
      "title": "Value of money",
      "body": "Database",
      "creation_date": "2016-04-28 07:31:01",
      "modified_date": "2016-04-28 07:31:01",
      "view_count": 1,
      "comment_count": 0,
      "like_count": 0,
      "pros": "lightweight, fast , modest technology",
      "cons": "priced high",
      "recommend": 1,
      "featured": 0,
      "owner_title": "bhawin parkeria",
      "tag": "c++, cpp, computer programming",
      "categoryname": "Electronics",
      "ratingParams": [
        {
          "rating": 5,
          "reviewcat_name": null
        }
      ]
    }
  }
}

Edit Directory Page Review
GET/sitepage/reviews/search/page_id

Returns the edit form of the review

Example URI

GET /sitepage/reviews/search/page_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "data": {
      "review_id": 1,
      "page_id": 1,
      "owner_id": 2,
      "title": "Value of money",
      "body": "Database",
      "creation_date": "2016-04-28 07:31:01",
      "modified_date": "2016-04-28 07:31:01",
      "view_count": 1,
      "comment_count": 0,
      "like_count": 0,
      "pros": "lightweight",
      "cons": "overpriced",
      "recommend": 1,
      "featured": 0,
      "owner_title": "bhawin parkeria",
      "event_type_title": "Events",
      "location": "Gurgaon, Haryana, India",
      "tag": "c++, cpp, computer programming",
      "categoryname": "Electronics",
      "ratingParams": [
        {
          "rating": 5,
          "reviewcat_name": null
        }
      ]
    },
    "form": [
      {
        "type": "Textarea",
        "name": "pros",
        "label": "Pros",
        "description": "What do you like about this Page?",
        "hasValidator": "true"
      },
      {
        "type": "Textarea",
        "name": "cons",
        "label": "Cons",
        "description": "What do you dislike about this Page?",
        "hasValidator": "true"
      },
      {
        "type": "Textarea",
        "name": "title",
        "label": "One-line summary"
      },
      {
        "type": "Textarea",
        "name": "body",
        "label": "Summary"
      },
      {
        "type": "Radio",
        "name": "recommend",
        "label": "Recommended",
        "description": "Would you recommend this Page to a friend?",
        "multiOptions": {
          "0": "No",
          "1": "Yes"
        }
      },
      {
        "type": "Submit",
        "name": "submit",
        "label": "Submit"
      }
    ],
    "ratingParams": [
      {
        "type": "Rating",
        "name": "review_rate_0",
        "label": "Overall Rating"
      }
    ]
  }
}

Edit Directory Page Review
POST/sitepage/reviews/search/page_id

Submits the form updating the review params

Parameter Required Type Example Description
pros yes string smart, lightweight Some advantages of the Directory Page
cons yes string over priced Some disadvantages of the page
title yes string value for money Some catchy line
body no string this is a great page Full summary
recommend yes int 1 whether you want to recommend this page to someone
review_rate_0 yes float 3 overall rating of the page

Example URI

POST /sitepage/reviews/search/page_id
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": {
    "pros": "Please complete this field - it is required.",
    "cons": "Please complete this field - it is required.",
    "review_rate_0": "Please complete this field - it is required."
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Delete Directory Page Review
DELETE/sitepage/reviews/search/page_id

deletes the review

Example URI

DELETE /sitepage/reviews/search/page_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  204
HideShow
Body
{
  "status_code": 204
}

List Comments and Likes Directory Page Review
GET/sitepage/reviews/search/page_id

Lists the comments and on Particular review

Example URI

GET /sitepage/reviews/search/page_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "invalid_method",
  "message": "Incorrect method"
}
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": {
    "comments": {
      "1": {
        "comment_id": 1,
        "resource_type": "sitepagereview_review",
        "resource_id": 2,
        "poster_type": "user",
        "poster_id": 1,
        "body": "this is awesome",
        "creation_date": "2016-04-28 11:31:05",
        "like_count": 0,
        "owner_images": {
          "owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
          "owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
          "owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
          "owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
        },
        "owner_title": "raj"
      }
    },
    "likes": {
      "6": {
        "like_id": 6,
        "resource_type": "sitepagereview_review",
        "resource_id": 2,
        "poster_type": "user",
        "poster_id": 1,
        "creation_date": "2016-04-28 10:33:10",
        "owner_images": {
          "owner_image": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
          "owner_image_normal": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
          "owner_image_profile": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
          "owner_image_icon": "http://example.com/seapi/application/modules/User/externals/images/nophoto_user_thumb_icon.png"
        },
        "owner_title": "dilip"
      }
    }
  }
}

Create comment on Directory Page Review
GET/sitepage/reviews/search/page_id

Returns the reviews comment form

Example URI

GET /sitepage/reviews/search/page_id
Response  200
HideShow
Body
{
  "status_code": 200,
  "body": [
    {
      "type": "text",
      "name": "body",
      "label": "Comment"
    }
  ]
}

Create comment on Directory Page Review
POST/sitepage/reviews/search/page_id

Posts the comment form

Parameter Required Type Example Description
body yes string yeah the comment body

Example URI

POST /sitepage/reviews/search/page_id
Response  400
HideShow
Body
{
  "status_code": 400,
  "error": true,
  "error_code": "validation_fail",
  "message": {
    "body": "Please complete this field - it is required."
  }
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Like / Unlike on Directory Page Review
GET/sitepage/reviews/search/page_id

Like a review or unlikes (if review already liked by user)

Example URI

GET /sitepage/reviews/search/page_id
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}
Response  204
HideShow
Body
{
  "status_code": 204
}

Generated by aglio on 04 May 2016