XP-Dev.com Documentation

Old Forum Topics API

This user guide only applies if your account and project is on our old platform, i.e. if your project's URL begins with https://xp-dev.com rather than https://<your-account>.xp-dev.com. If your account is on our new platform, you should be using this user guide instead.

Each Forum Topic Object has the following attributes:

Attribute Description
id Unique Forum Topic ID
title Forum Topic title
description Forum Topic description in Textile
descriptionHtml Forum Topic description in HTML
forum Forum ID that the Forum Topic belongs to
sticky Whether this is Forum Topic is sticky or not

List All Forum Topics for a Forum

GET request to https://xp-dev.com/api/v1/forumtopics/forum/<forum-id>:

curl https://xp-dev.com/api/v1/forumtopics/forum/3

Responses will be a list of Forum Topics Objects:

{"response":[
    {
        "id":2,
        "description":"I need some Subversion help",
        "forum":3,
        "title":"Subversion Help",
        "sticky":false,
        "htmlDescription":"<p>I need some Subversion help</p>"
    },
    ...
]}

List All Forum Topics for a Project

GET request to https://xp-dev.com/api/v1/forumtopics/project/<project-id>:

curl https://xp-dev.com/api/v1/forumtopics/project/3

Responses will be a list of Forum Topics Objects.

Create a New Forum Topic

POST request to https://xp-dev.com/api/v1/forumtopics/ with the following attributes:

Mandatory:

  • forum
  • title
  • description
  • sticky

Example request:

curl -X POST -H 'Content-Type: application/json' -d '{"description":"I need Subversion help","forum":4,"title":"Subversion Help","sticky":false}' https://xp-dev.com/api/v1/forumtopics/

Responses will be in the form of a single Forum Topic Object

Get a Single Forum Topic

GET request to https://xp-dev.com/api/v1/forumtopics/<forumtopic-id>. For example:

curl https://xp-dev.com/api/v1/forumtopics/6

Responses will be in the form of a single Forum Topic Object

Update a Single Forum Topic

PUT request to https://xp-dev.com/api/v1/forumtopics/<forumtopic-id> with the following attributes:

Mandatory:

  • title
  • description
  • sticky

Example request:

curl -X PUT -H 'Content-Type: application/json' -d '{"description":"I need Subversion help","title":"Subversion Help","sticky":true}' https://xp-dev.com/api/v1/forumtopics/6

Responses will be in the form of a single Forum Topic Object

Delete a Single Forum Topic

DELETE request to https://xp-dev.com/api/v1/forumtopics/<forumtopic-id>:

curl -X DELETE https://xp-dev.com/api/v1/forumtopics/6

Feel free to contact us if you need any assistance.