reviews.getCategories

Description

Returns a list of reviews categories

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • none

Optional parameters

  • category_id :
    the id number of the category

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 11:29:46 -0500" p="0.30936503410339">
   <review_categories count="1">
       <review_category>
           <item_0>
               <id>1</id>
               <name><![CDATA[Untitled Category]]></name>
               <description></description>
               <parentCategory>0</parentCategory>
               <totalItems>13</totalItems>
               <subCategories/>
               <fields>
                   <item_0>
                       <id>8</id>
                       <type><![CDATA[textField]]></type>
                       <label><![CDATA[Untitled]]></label>
                       <defaultValue></defaultValue>
                       <optionsList></optionsList>
                       <maxLength>150</maxLength>
                       <required>1</required>
                       <sequence>1</sequence>
                       <response></response>
                       <optionsCollection>
                           <item_0></item_0>
                       </optionsCollection>
                   </item_0>
                   <item_1>
                       <id>9</id>
                       <type><![CDATA[number]]></type>
                       <label><![CDATA[Number]]></label>
                       <defaultValue></defaultValue>
                       <optionsList></optionsList>
                       <maxLength>150</maxLength>
                       <required>0</required>
                       <sequence>2</sequence>
                       <response></response>
                       <optionsCollection>
                           <item_0></item_0>
                       </optionsCollection>
                   </item_1>
               </fields>
               <associations>
                   <photos></photos>
                   <videos></videos>
                   <files></files>
               </associations>
           </item_0>
       </review_category>
   </review_categories>
</response>

API Methods: reviews.getItems

Description

Returns a list of review items

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • category_id or item_id:
    the id of the category containing the post or the id of the review item.

Optional parameters

  • is_parent :
    the parent id of the category

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 11:40:09 -0500" p="0.083367109298706">
   <review_items count="1">
       <review_item>
           <id>32</id>
           <userId>3</userId>
           <categoryId>1</categoryId>
           <fields>
               <item_0>
                   <id>8</id>
                   <type><![CDATA[textField]]></type>
                   <label><![CDATA[Untitled]]></label>
                   <defaultValue></defaultValue>
                   <optionsList></optionsList>
                   <maxLength>150</maxLength>
                   <required>1</required>
                   <sequence>1</sequence>
                   <response><![CDATA[API Test]]></response>
               </item_0>
               <item_1>
                   <id>9</id>
                   <type><![CDATA[number]]></type>
                   <label><![CDATA[Number]]></label>
                   <defaultValue></defaultValue>
                   <optionsList></optionsList>
                   <maxLength>150</maxLength>
                   <required>0</required>
                   <sequence>2</sequence>
                   <response>0002</response>
               </item_1>
           </fields>
           <associations>
               <photos></photos>
               <videos></videos>
               <files></files>
           </associations>
           <modified><![CDATA[2009-04-02 16:28:14]]></modified>
           <averageRating></averageRating>
       </review_item>
   </review_items>
</response>

reviews.getReviews

Description

Returns a list of reviews

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • none

Optional parameters

  • category_id :
    the id of the category
  • is_parent :
    the parent id of the category
  • review_id :
    the id of the review item
  • item :
    the id of the review
  • user_id :
    the id of the user

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 12:21:40 -0500" p="0.19510984420776">
   <reviews count="1">
       <review>
           <id>17</id>
           <userId>3</userId>
           <itemId>32</itemId>
           <text><![CDATA[Testing from the API]]></text>
           <modified><![CDATA[2009-04-03 12:00:40]]></modified>
           <rating>
               <id>24</id>
               <rating>1</rating>
               <itemType><![CDATA[review_item]]></itemType>
               <itemId>32</itemId>
               <userId>3</userId>
               <modified><![CDATA[2009-04-03 12:00:40]]></modified>
           </rating>
           <user>
               <username><![CDATA[Jerimiah Milton]]></username>
               <firstName></firstName>
               <lastName><![CDATA[Milton]]></lastName>
               <profilePhoto></profilePhoto>
           </user>
           <item>
               <id>32</id>
               <userId>3</userId>
               <categoryId>1</categoryId>
               <fields>
                   <item_0>
                       <id>8</id>
                       <type><![CDATA[textField]]></type>
                       <label><![CDATA[Untitled]]></label>
                       <defaultValue></defaultValue>
                       <optionsList></optionsList>
                       <maxLength>150</maxLength>
                       <required>1</required>
                       <sequence>1</sequence>
                       <response><![CDATA[API Test]]></response>
                   </item_0>
                   <item_1>
                       <id>9</id>
                       <type><![CDATA[number]]></type>
                       <label><![CDATA[Number]]></label>
                       <defaultValue></defaultValue>
                       <optionsList></optionsList>
                       <maxLength>150</maxLength>
                       <required>0</required>
                       <sequence>2</sequence>
                       <response>0002</response>
                   </item_1>
               </fields>
               <associations>
                   <photos></photos>
                   <videos></videos>
                   <files></files>
               </associations>
               <modified><![CDATA[2009-04-02 16:28:14]]></modified>
               <averageRating></averageRating>
           </item>
       </review>
   </reviews>
</response>

reviews.editCategory

Description

Edits or creates a new review category

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • none

Optional parameters

  • field_id :
    the id of the category field
  • field_type :
    the type of field to create or edit
  • field_label :
    the label of the field
  • max_length :
    the maximum amount of characters a field is allowed
  • default_value :
    the default value of a field
  • required :
    whether or not a field is required
  • options_list :
    a list of options for a field, comma separated
  • sequence :
    the sequence of the the fields
  • delete :
    set to 1 and supply a field_id to delete a field
  • category_id :
    the id of the category – Required when using a field_id or a field_type
  • image :
    this is the photo itself which should be encapsulated as part of a multipart/form-data submission via an HTTP POST action. This parameter is required to upload a new photo to the site.
  • image_title :
    the title of the photo
  • image_description :
    the description of the photo
  • user_id :
    Required when adding a photo
  • category_name :
    the name of the category
  • category_description :
    the description of the category
  • parent_category :
    the parent id of the category

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 13:38:58 -0500" p="0.043804883956909">
   <review_categories count="1">
       <review_category>
           <category_id>2</category_id>
       </review_category>
   </review_categories>
</response>

Description

Edits or creates a new review category

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • none

Optional parameters

  • field_id :
    the id of the category field
  • field_type :
    the type of field to create or edit
  • field_label :
    the label of the field
  • max_length :
    the maximum amount of characters a field is allowed
  • default_value :
    the default value of a field
  • required :
    whether or not a field is required
  • options_list :
    a list of options for a field, comma separated
  • sequence :
    the sequence of the the fields
  • delete :
    set to 1 and supply a field_id to delete a field
  • category_id :
    the id of the category – Required when using a field_id or a field_type
  • image :
    this is the photo itself which should be encapsulated as part of a multipart/form-data submission via an HTTP POST action. This parameter is required to upload a new photo to the site.
  • image_title :
    the title of the photo
  • image_description :
    the description of the photo
  • user_id :
    Required when adding a photo
  • category_name :
    the name of the category
  • category_description :
    the description of the category
  • parent_category :
    the parent id of the category

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 13:38:58 -0500" p="0.043804883956909">
   <review_categories count="1">
       <review_category>
           <category_id>2</category_id>
       </review_category>
   </review_categories>
</response>

Description

Edits or creates a new review category

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • none

Optional parameters

  • field_id :
    the id of the category field
  • field_type :
    the type of field to create or edit
  • field_label :
    the label of the field
  • max_length :
    the maximum amount of characters a field is allowed
  • default_value :
    the default value of a field
  • required :
    whether or not a field is required
  • options_list :
    a list of options for a field, comma separated
  • sequence :
    the sequence of the the fields
  • delete :
    set to 1 and supply a field_id to delete a field
  • category_id :
    the id of the category – Required when using a field_id or a field_type
  • image :
    this is the photo itself which should be encapsulated as part of a multipart/form-data submission via an HTTP POST action. This parameter is required to upload a new photo to the site.
  • image_title :
    the title of the photo
  • image_description :
    the description of the photo
  • user_id :
    Required when adding a photo
  • category_name :
    the name of the category
  • category_description :
    the description of the category
  • parent_category :
    the parent id of the category

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 13:38:58 -0500" p="0.043804883956909">
   <review_categories count="1">
       <review_category>
           <category_id>2</category_id>
       </review_category>
   </review_categories>
</response>

reviews.Item

Description

Edits or creates a new review item

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • category_id :
    the id number of the category to which review item belongs
  • user_id :
    the user_id of the review item to which it belongs
  • *REQUIRED FIELDS* :
    any of the fields marked required – these are dynamic

Optional parameters

  • item_id :
    the id of the review item – Required if an image is included
  • image :
    this is the photo itself which should be encapsulated as part of a multipart/form-data submission via an HTTP POST action. This parameter is required to upload a new photo to the site.
  • image_title :
    the title of the photo
  • image_description :
    the description of the photo
  • image_description :
    the description of the photo
  • *FIELDS* :
    any field which is tied to the category – these are dynamic

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 14:05:58 -0500" p="0.096014976501465">
   <review_items count="1">
       <review_item>
           <item_id>34</item_id>
       </review_item>
   </review_items>
</response>

reviews.editReview

Description

Edits or creates a new review

Authentication

This method requires authentication without user credentials.

API Version

Version 2

Required parameters

  • item_id :
    the id number of the review
  • user_id :
    the user_id of the review
  • rating :
    the rating of the review
  • review :
    the actual review

Optional parameters

  • review_id :
    the id of the review item

Example response

<?xml version="1.0"?>
<response status="ok" time="Wed, 08 Apr 2009 14:03:31 -0500" p="0.12843608856201">
   <reviews count="1">
       <review>
           <review_id>17</review_id>
       </review>
   </reviews>
</response>