Comments API endpoint help

Comments

• x00 MVP

  January 2018

  You are better off using the basic read only api. there little documentation on the api endpoint

  All the information you need can be found with

  https://open.vanillaforums.com/discussion/35687.json

  grep is your friend.

  1
• x00 MVP

  January 2018

  Note: be careful don't expect the data to be sanitised.

  grep is your friend.

  0
• burnet New

  January 2018

  Thanks @x00 for the information! I thought the v2 API was more fleshed out.

  Is there any docs at all for the read only API? Like limits, pagination, etc?

  0
• x00 MVP

  January 2018 edited January 2018

  not really.

  The read only API uses the same controller it is just retunring the data used rather than the page. You can also just return the view and not the whole page.

  You have CountComments and Pageand you can count the number of comment on that page. The rest you can work out.

  adding .jsonto the url Is a a quick way of adding ?DeliveryMethod=JSON&DeliveryType=DATA

  This is the best you will get in terms of documentation.

  // Delivery type enumerators:
  define('DELIVERY_TYPE_ALL', 'ALL'); // Deliver an entire page
  define('DELIVERY_TYPE_ASSET', 'ASSET'); // Deliver all content for the requested asset
  define('DELIVERY_TYPE_VIEW', 'VIEW'); // Deliver only the view
  define('DELIVERY_TYPE_BOOL', 'BOOL'); // Deliver only the success status (or error) of the request
  define('DELIVERY_TYPE_NONE', 'NONE'); // Deliver nothing
  define('DELIVERY_TYPE_MESSAGE', 'MESSAGE'); // Just deliver messages.
  define('DELIVERY_TYPE_DATA', 'DATA'); // Just deliver the data.
  
  // Delivery method enumerators
  define('DELIVERY_METHOD_XHTML', 'XHTML');
  define('DELIVERY_METHOD_JSON', 'JSON');
  define('DELIVERY_METHOD_XML', 'XML');
  /**
   * @since 2.1
   */
  define('DELIVERY_METHOD_TEXT', 'TXT');
  define('DELIVERY_METHOD_PLAIN', 'PLAIN');
  define('DELIVERY_METHOD_RSS', 'RSS');
  

  Also library/core/class.controller.php give you an idea of what is goign on

  if you wanted just the view you could do ?DeliveryMethod=JSON&DeliveryType=VIEW

  grep is your friend.

  0
• x00 MVP

  January 2018 edited January 2018

  Out of interest what are you trying to do what si this for?

  grep is your friend.

  0
• burnet New

  January 2018

  The goal is to essentially search a set of discussions for a few conditions, based on their content - Thanks again for the info, makes sense, I will give this a go.

  0