API Documentation

Purpose

This document outlines the API methods available, the parameters they receive and the results returned. The objective is to give an overall view of the possibilities available for integration with the Answerbase System.

API Structure: REST

The API is organized based on principles of Representational State Transfer (REST). All the methods are invoked via an HTTP Request implementing HTTP authentication and HTTP verbs and are answered by appropriate HTTP Status code and (when required) a result as either JSON or XML.

The base subdomain of the API is: https://xxxx.services.answerbase.com, where the xxxx represents your sitename. You can look up the exact subdomain in your admin site under Customization > API.

Authentication

All API methods require an OAuth 2.0 authorization token to be attached in the HTTP request header (to see how to obtain the token, see get token method description). The token should be included as Authorization parameter, with value set to "token_type access_token" (the type of token and the token itself, separated with space).

Example:

request.addHeader("authorization", "bearer test_SjT-ovlgrq92voBba-g4P")

All the API calls have to be made over HTTPS. A call made over HTTP or not containing a token will fail.

Http Status Codes

The API returns an appropriate HTTP status code for every request:

• 200 OK -- This status code will be returned when a successful request has been made.
• 201 Created -- This status code indicates that the request has succeeded and has led to the creation of a resource.
• 400 Bad Request -- This status code will be returned if there is an issue with the submitted data. An error message will also be included in the response.
• 401 Not Authorized -- This status code will be returned if the API request:
  • Contained no token
  • Contained invalid token
  • Contained expired token
• 429 Too Many Requests -- This status code will be returned if the API request exeded the maximum allowed requests.
• 500 Internal Server Error -- This status code will be returned if there is an error with the API.

For a list of all possible status codes, please use this reference.

Parameters

Encoding

All data should be UTF-8 encoded.

Content-Type

When making POST/PUT requests, you must include the following HTTP header:

Content-Type: application/x-www-form-urlencoded

Unless one of the parameters is of type file, in which case you must include:

Content-Type: multipart/form-data

Currently, application/json is not supported.

Dates

All dates are passed and returned in the following format: m/d/y h:M:s

ex: 9/27/2008 9:35:47

Note: The times are expressed in client's local time zone

Format

The results are returned in JSON (default) or XML. You can use HTTP "Accept" header to specify the required format

Example:

request.addHeader("accept", "application/json")
request.addHeader("accept", "application/xml")

http://clientanswerssite.com/api/vX/answers/1?format=json
http://clientanswerssite.com/api/vX/answers/1?format=xml 

Errors and wrapping

Generally, if a result couldn't be retrieved from the API, a corresponding HTTP error code is issued together with an explanation (if any available).

For example, if a request contained no token, a following response would be issued:

401 Unauthorized
{
"message": "Authorization has been denied for this request."
}

200 OK
{
"statusCode": 401,
"errors": [
    "Unauthorized",
    "Authorization has been denied for this request."
],
"result": null
}

General Notes

Categories and Tags

In the administration site of your Answerbase Q&A site you have the feature preference option to choose whether you want to use “categories” or “tags” in your site. There are a range of methods that accept both "categories" and "tags" as parameters, but depending on your preference setting, only one of these will be relevant for your site. Likewise many methods can return both <categories> and <tags> and while for consistency both of those xml nodes are always returned, only the relevant one for your site is populated with data.

User Identifiers

Many of the API methods take a user identifier as one of the input parameters. Depending on the type of the id is to be used, one of the parameters listed below should be specified within the request:

Question Core

    [
    id                  :int
    answersCount        :int
    followerCount       :int
    url                 :string
    publicationTime     :datetime
    lastUpdateTime      :datetime
    latestAnswerTime    :datetime
    status              :{open|closed}
    type                :{public|private}
    title               :title
    details             :string
    user                :user core
    topanswer           :answer
    categories          [:category]
    tags                [:tag]
    product             :product
    externalurl         :string
    urlslug             :string
    metatitle           :string
    metadescription     :string
    metakeywords        :string
    index               :bool
    follow              :bool
    includeinsitemap    :bool
    canonical           :string
    locked              :bool
    ]

JSON
{
    "title": "What are routers?",
    "id": 2530123,
    "details": "I don't know what the word refers to",
    "answersCount": 1,
    "followerCount": 3,
    "url": "https://abc.answerbase.com/2530123/What-are-routers",
    "status": "closed",
    "publicationtime": "Oct 22, 2018 - 12:39 PM",
    "latestAnswertime": "Oct 22, 2018 - 12:39 PM",
    "type": "public",
    "user":
        {
            "username": "admin",
            "id": 2040897,
            "sso_userid": "",
            "displayName": "admin",
            "firstname": "",
            "lastname": "",
            "points": 0,
            "totalRank": "1",
            "profileUrl": null
        },
    "categories": [
        {
            "name": "Power Tools, 14",
            "id": 818040,
            "externalId": "14",
            "url": "https://abc.answerbase.com/Topic/Power-Tools/818040",
            "questionscount": 13,
            "childCategories": []
        }
    ],
    "tags": [],
    "product": null,
    "comments": null,
    "topAnswer": null,
    "externalurl": null,
    "urlslug": "What-are-routers",
    "metatitle": "What are routers?",
    "metadescription": "What a router is and how it is used to connect computers",
    "metakeywords": "Router, packet, network, LAN, WAN",
    "index": true,
    "follow": true,
    "includeinsitemap": true,
    "canonical": "https://abc.answerbase.com/2530123/What-are-routers",
    "locked": false,
}

Question

    [
    id                  :int
    answersCount        :int
    followerCount       :int
    url                 :string
    publicationTime     :datetime
    lastUpdateTime      :datetime
    latestAnswerTime    :datetime
    status              :{open|closed}
    type                :{public|private}
    title               :title
    details             :string
    user                :user core
    answers             [:answer]
    categories          [:category]
    tags                [:tag]
    product             :product
    attachments         [:attachment]
    comments            [:comment]
    relatedContentList  [:relatedContent]
    externalurl         :string
    urlslug             :string
    metatitle           :string
    metadescription     :string
    metakeywords        :string
    index               :bool
    follow              :bool
    includeinsitemap    :bool
    canonical           :string
    locked              :bool
    ]

JSON
{
    "title": "pop ceiling how much cost 12*10",
    "id": 2746864,
    "details": "POP Ceilings Design,174975,All India,DIR",
    "answersCount": 1,
    "followerCount": 13,
    "url": "https://abc.answerbase.com/2746864/pop-ceiling-how-much-cost-12-10",
    "status": "closed",
    "publicationtime": "May 16, 2019 - 06:46 PM",
    "latestAnswertime": "May 16, 2019 - 06:48 PM",
    "type": "public",
    "user": 
        {
            "username": "86217019",
            "id": 2205889,
            "sso_userid": "",
            "displayName": "",
            "firstname": "",
            "lastname": "",
            "points": 0,
            "totalRank": "",
            "profileUrl": null
        },
    "attachments": [],
    "categories": [
        {
            "name": "POP Ceiling Work",
            "id": 944370,
            "externalId": "164287",
            "url": "https://abc.answerbase.com/Topic/POP-Ceiling-Work/944370",
            "questionscount": 3,
            "childCategories": []
        }
    ],
    "tags": [],
    "product": null,
    "comments": [],
    "topAnswer": null,
    "answers": [
        {
        "id": 2746867,
        "text": "7200<br /><br />Answered By : <a href=
                "https://www.mart.com/senseofstyle/">Sense Of Style</a>",
        "published": "true",
        "publicationTime": "May 16, 2019 - 06:48 PM",
        "isBestAnswer": "false",
        "goodVotes": 0,
        "badVotes": 0,
        "source": null,
        "user": 
            {
                "username": "category_k",
                "id": 2048719,
                "sso_userid": "",
                "displayName": "Jim",
                "firstname": "",
                "lastname": "",
                "points": 0,
                "totalRank": "3",
                "profileUrl": null
            },
        "questionId": 2746864,
        "attachments": [],
        "comments": []
        }
    ],
    "relatedContentList": [
        {
            "id": 349610,
            "title": "How to boost my sales",
            "url": "https://sellingpower.com/10-tips-to-improve-your-sales",
            "viewCount": 0,
            "clickCount": 0,
            "clickRate": 0.0
        }
    ],
    "externalurl": null,
    "urlslug": "What-are-routers",
    "metatitle": "What are routers?",
    "metadescription": "What a router is and how it is used to connect computers",
    "metakeywords": "Router, packet, network, LAN, WAN",
    "index": true,
    "follow": true,
    "includeinsitemap": true,
    "canonical": "https://abc.answerbase.com/2530123/What-are-routers",
    "locked": false,
}
    

Answer

[
    id              :int
    text            :string
    published       :bool
    publicationTime :datetime
    isBestAnswer    :bool
    goodVotes       :int
    badVotes        :int
    source          :string
    user            :user core
    questionId      :int
    attachments     [:attachment]
    comments        [:comment]
]

JSON
{
    "id": 2752187,
    "text": "This Digital Download card is something that needs to be shipped out 
                to you. We do not have the songs available for instant download at 
                this time.",
    "published": "true",
    "publicationTime": "Jul 02, 2019 - 11:29 AM",
    "isBestAnswer": "false",
    "goodVotes": 2,
    "badVotes": 0,
    "source": null,
    "user": 
        {
            "username": "Robin",
            "id": 2216272,
            "sso_userid": "6134b233-4c2d-4b2d-9f4a-47f58f4a216e",
            "displayName": "Robin",
            "firstname": "",
            "lastname": "",
            "points": 0,
            "totalRank": "",
            "profileUrl": null
        },
    "questionId": 2752186,
    "attachments": [],
    "comments": []
}

Attachment

[
    name            :string
    fileurl         :string
]

JSON
{
    "name": "Grand Canyon"
    "fileurl": "http://abc.answerbase.com/canyon.jpg"
}

Comment

[
    id              :id
    text            :string
    published       :bool
    publicationDate :datetime
    goodVotes       :int
    user            :user core
    relatedPost     :relatedPost
]

JSON
{
    "text": "Can you please clarify?",
    "id": 2752200,
    "published": "true",
    "publicationDate": "Oct 04, 2019 - 11:36 PM",
    "goodVotes": 0,
    "user": 
        {
            "username": "lumin",
            "id": 201,
            "sso_userid": "",
            "displayName": "lumin",
            "firstname": "",
            "lastname": "",
            "points": 50,
            "totalRank": "",
            "profileUrl": null
        },
    "relatedPost": 
        {
            "id": 2752038,
            "url": "https://abc.answerbase.com/2752038/test-33",
            "type": "question"
        }
}

User Core

[
    username            :string
    id                  :int
    sso_userid          :string
    displayName         :string
    firstname           :string
    lastname            :string
    points              :int (earned within the specific timeframe and categories)
    totalRank           :int
    profileUrl          :string
]

JSON:
{
    "username": "david",
    "id": 4,
    "sso_userid": "xy878",
    "displayName": "goliath",
    "firstname": "David",
    "lastname": "Martinez",
    "points": 60,
    "totalRank": 5,
    "profileUrl": "http://abc.answerbase.com/david"
}

User

[
    username            :string
    id                  :int
    sso_userid          :string
    displayName         :string
    firstname           :string
    lastname            :string
    title               :string
    organization        :string
    website             :string
    address             :string
    city                :string
    region              :string
    country             :string
    profileEmail        :string
    homeNumber          :string
    officeNumber        :string
    mobileNumber        :string
    faxNumber           :string
    facebookUrl         :string
    twitterUrl          :string
    linkedInUrl         :string
    googleUrl           :string
    points              :int    (total points earned, in some cases within the 
                                specific timeframe and categories specified)
    totalRank           :int
    questionsAnswered   :string
    staffexpert         :string
    imageUrl            :string
    profileUrl          :string
    askQuestionUrl      :string
    topCategories       :string
    topTags             :string
    aboutMe             :string
    customFields        [:customField]
    acceptsPromotionalEmails: bool
]

JSON:
{
    "username": "betty",
    "id": 202,
    "sso_userid": "",
    "displayName": "betty",
    "firstname": "",
    "lastname": "",
    "points": 50,
    "totalRank": "",
    "profileUrl": "http://abc.answerbase.com/Profile/betty/"
    "title": "",
    "organization": "",
    "aboutMe": "",
    "website": "",
    "address": "",
    "city": "",
    "region": "",
    "country": "",
    "profileEmail": "",
    "homeNumber": "",
    "officeNumber": "",
    "mobileNumber": "",
    "faxNumber": "",
    "facebookUrl": "",
    "twitterUrl": "",
    "linkedInUrl": "",
    "googleUrl": "",
    "customFields": [],
    "questionsAnswered": 12,
    "staffexpert": "true",
    "imageUrl": "https://abc.answerbase.com/images/Avatars/avatar_01.jpg",
    "askQuestionUrl": "https://abc.answerbase.com/ask?expertId=202",
    "topCategories": "Support",
    "topTags": "",
    "acceptsPromotionalEmails": "true"
}

Category

[
    name                :string
    id                  :int
    externalId          :string
    url                 :string
    questionscount      :int
    childCategories     :[:category]
]

JSON
{
    "name": "Power Tools",
    "id": 818040,
    "externalId": "14",
    "url": "https://abc.answerbase.com/Topic/Power-Tools/818040",
    "questionscount": 13,
    "childCategories": [
    {
        "name": "Black & Decker Power Tools",
        "id": 991183,
        "externalId": "182950",
        "url": "https://abc.answerbase.com/Topic/Black-Decker-Power-Tools/991183",
        "questionscount": 0,
        "childCategories": []
    },
    {
        "name": "Bosch Power Tools",
        "id": 991176,
        "externalId": "180538",
        "url": "https://abc.answerbase.com/Topic/Bosch-Power-Tools/991176",
        "questionscount": 0,
        "childCategories": []
    }
    ]
}

Tag

[
    name                :string
    id                  :int
    externalId          :string
    url                 :string
    questionscount      :int
]

JSON
{
    "name": "Advice",
    "id": 818041,
    "externalId": "147",
    "url": "https://abc.answerbase.com/Topic/Advice/818041",
    "questionscount": 6
}

Product

    [
    name                :string
    id                  :int
    sku                 :string
    imageurl            :string
    questioncount       :int
    price               :decimal
    description         :string
    category            [:category]
    ]

JSON
{
    "name": "Digital Manuals: Spanish Edition",
    "id": 115158,
    "sku": "978149089",
    "url": "https://products.onlineshop.com/product/9781470739089-digital-vbs-leader-manuals-spanish.do?sortby=priceAscend&page=2&refType=&from=fn",
    "imageurl": "https://cdn.yourzoom.com/gp/9781470739089/9781470739089.yz/large.jpg",
    "questioncount": 0,
    "price": 0.0,
    "description": "Digital Leader Manuals: Spanish Edition",
    "category": null
}

Related Content

[
    id                  :int
    url                 :string
    title               :string
    viewCount           :int
    clickCount          :int
    clickRate           :decimal
]

JSON
{
    "id": 349610,
    "title": "How to boost my sales",
    "url": "https://sellingpower.com/10-tips-to-improve-your-sales-performance",
    "viewCount": 20,
    "clickCount": 0,
    "clickRate": 0.0
}

Related Post

[
    id                  :int
    url                 :string
    type                :string
]

JSON
{
    "id": 2752038,
    "url": "https://abc.answerbase.com/2752038/test-33",
    "type": "question"
}

Token

[
    access_token    :string
    token_type      :string
    expires_in      :int (seconds)
]

Note: This object is returned as JSON only, XML format is not available

JSON
{
    "access_token": "test_SjT-ovlgrq92vFtr2qo0zPjNmpLN7tyo9znoBba",
    "token_type": "bearer",
    "expires_in": 86399
}

Get question

Gets a question with specified ID

GET /api/v2/questions/:id

Parameters

Sample request

GET /api/v2/questions/100?includeUnpublishedComments=true

Response

An question object.

Get question list

Gets a list of questions based on a range of parameters

GET /api/v2/questions/list

Parameters

Sample request

GET /api/v2/questions/list?keywords=best pizza&withanswers=true

Response

A list of question core objects.

Search questions

Returns a list of questions that matches the parameters passed. Contrary to the GetQuestionsList method, this method uses the search index, not the database directly, and takes into account similarities, typing errors, keyword proximity etc.

GET /api/v2/questions/search

Parameters

Sample request

GET /api/v2/questions/search?maxresults=10&keywords=old buildings

Response

A list of question core objects.

Get featured question

Returns a random featured question associated with one or more of the categories. If no categories are specified, the random question will be picked from the entire pool of featured questions.

GET /api/v2/questions/getfeaturedquestion

Parameters

Sample request

GET /api/v2/questions/getfeaturedquestion?categoryids=12,34

Response

A question objects.

Get featured questions

Returns a list of questions similar to the keywords passed, based on a range of parameters. This method uses the search index, not the database directly, and takes into account similarities, typing errors, keyword proximity etc.

GET /api/v2/questions/getfeaturedquestions

Parameters

Sample request

GET /api/v2/questions/getfeaturedquestions?categories=law,economy&maxresults=5&orderby=random

Response

A list of question core objects.

Get questions for autosuggest

Returns a list of questions similar to the question typed passed. This method uses the search index, not the database directly, and takes into account similarities, typing errors, keyword proximity etc.

GET /api/v2/questions/autosuggest

Parameters

Sample request

GET /api/v2/questions/autosuggest?query=how long time does the shipping take?

Response

JSON
{
    "query": "asking a question with attachments?",
    "suggestions": [
        "how to order",
        "new guest post 2309uoi"
    ],
    "data": [
        "https://abc.qa.answerbase.com/68575/how-to-order",
        "https://abc.qa.answerbase.com/68587/new-guest-post-2309uoi"
    ]
}
        

Get deleted

Returns a list of question ids for questions that have been deleted.

GET /api/v2/questions/getdeleted

Parameters

Sample request

GET /api/v2/questions/getdeleted?deletedsincedate=2019-01-01

Response

JSON
{
    "totalCount": 3240,
    "questionIds": [
        {
            "deletetime": "2019-01-02T01:24:22",
            "id": 2578345
        },
        {
            "deletetime": "2019-01-03T00:56:56",
            "id": 2588625
        },
        {
            "deletetime": "2019-01-03T06:16:22",
            "id": 2589551
        }
    ]
}

Get by user

Returns a list of questions asked, answered, visited etc. by the user

GET /api/v2/questions/getbyuser

Parameters

Sample request

GET /api/v2/questions/getbyuser?userid=202&type=viewedby

Response

A list of question core objects.

Ask question

Allows a question to be submitted to the application.

POST /api/v2/questions/ask

Input

Sample request

POST /api/v2/questions/
{
"title": "How can it be done?",
"username": "testuser"
}

Response

JSON
{
    "id"     :"99999",
    "url"    :"",
}

Update question

Allows a question to be updated.
Note that the categories/tags passed replace the existing associated categories/tags, so they need to be passed even if they aren't updated as otherwise they will be removed from the question.

PUT /api/v2/questions/:id

Input

Sample request

PUT /api/v2/questions/100
{
"closed": "true"
}

Response

Follow question

Allows a user to follow the specified question.

PUT /api/v2/questions/:id/follow

Input

Sample request

PUT /api/v2/questions/100/follow
{
"username": "testuser"
}

Response

Unfollow question

Allows a user to unfollow the specified question.

PUT /api/v2/questions/:id/unfollow

Input

Sample request

PUT /api/v2/questions/100/unfollow
{
    "username": "testuser"
}

Response

Report question

Flags a question for review

PUT /api/v2/questions/:id/report

Input

Sample request

    PUT /api/v2/questions/100/report
    {
    "username" : "testuser"
    }

Response

Get answer

Gets an answer with specified ID

GET /api/v2/answers/:id

Parameters

Sample request

GET /api/v2/answers/100?includeUnpublishedComments=true

Response

An answer object.

Add answer

Adds a new answer

POST /api/v2/answers/add

Input

Sample request

POST /api/v2/answers/
{
"questionId": "1",
"username": "testuser"
"answer": "That should be Central Perk!"
}

Response

Update answer

Updates given fields of an answer

PUT /api/v2/answers/:id

Input

Sample request

PUT /api/v2/answers/100
{
"answer" : "No spelling mistakes this time!",
"published" : "true"
}

Response

Report answer

Flags an answer for review

PUT /api/v2/answers/:id/report

Input

Sample request

PUT /api/v2/answers/100/report
{
"username" : "testuser"
}

Response

Vote for answer

Allows a user to vote for an answer

PUT /api/v2/answers/:id/vote/:score

Input

Sample request

PUT /api/v2/answers/100/vote/1
{
"username" : "testuser"
}

Response

Get user

Gets a user with the specified id

GET /api/v2/users/get

Parameters

Sample request

GET /api/v2/users/get?userid=202

Response

A user object.

Get user list

Gets a list of users based on a range of parameters

GET /api/v2/users/list

Parameters

Sample request

GET /api/v2/users/list?keywords=betty

Response

A list of user objects.

Get staff experts

Gets a list of users who are defined as staff experts

GET /api/v2/users/staffexperts

Parameters

Sample request

GET /api/v2/users/staffexperts?categoryIds=322

Response

A list of user objects.

Get featured expert

Returns a random featured expert related to at least one of the categories passed. If no categories are specified, then the expert will be chosen from the entire pool of featured experts.

GET /api/v2/users/featuredexpert

Parameters

Sample request

GET /api/v2/users/featuredexpert?categoryIds=309

Response

A user object.

Get top experts

Returns the experts that earned most points within the specified parameters. If no parameters are specified, the overall top experts are returned. The experts are sorted by highest points first.

GET /api/v2/users/topexperts

Parameters

Sample request

GET /api/v2/users/topexperts?categoryIds=309

Response

A user object.

Get user point summary

Gets the summary of points earned for the user with the specified id

GET /api/v2/users/get/pointsummary

Parameters

Sample request

GET /api/v2/users/get/pointsummary?userid=202

Response

JSON
{
    "username": "betty",
    "totalPoints": 3039,
    "thumbUpPoints": 0,
    "bestAnswerPoints": 25,
    "askQuestionPoints": 8,
    "answerQuestionPoints": 0,
    "votingPoints": 5,
    "systemPoints": 2876
}

Get user subscriptions

Returns the list of categories, tags or products that the user is subscribed to.

GET /api/v2/users/get/subscriptions

Parameters

Sample request

GET /api/v2/users/get/subscriptions?userid=202

Response

JSON
{
    "username"          :"betty",
    "categories"        [:category],
    "tags"              [:tag],
    "products"          [:product]
    "subscribedToAll"   :bool
}

Add user subscription

Creates a subscription to the category, tag or product specified.

POST /api/v2/users/addsubscription

Parameters

Sample request

POST /api/v2/users/addsubscription

Response

Remove user subscription

Removes a subscription to the category, tag or product specified.

POST /api/v2/users/removesubscription

Parameters

Sample request

POST /api/v2/users/removesubscription

Response

Register user

Allows a user to be registered in the application.
Note: If you submit a username and an email address that already exists for an existing user, a new user is not created, but the existing user id returned instead.

POST /api/v2/users

Input

Sample request

    POST /api/v2/users
    {
    "username": "testuser",
    "password": "passw0rd",
    "email": "testuser@domain.com",
    }

Response

JSON
{
    "id": 100,
    "newuser", true
}

Update user

Allows a user’s data to be updated.

PUT /api/v2/users/update

Input

Sample request

PUT /api/v2/users/100
{
    "userid": 202,
    "displayname": "testuser",
    "firstname": "John"
}

Response

Get user permissions

Retrieves a user’s permissions

GET /api/v2/users/get/permissions

Input

Sample request

GET /api/v2/users/get/permissions?userid=202

Response

JSON
{
    "canpostquestions": true,
    "canpostanswers": true,
    "allowlinks": true,
    "linksfollow": false,
    "featured": false,
    "visibleonlists": true,
    "haspublicprofile": true,
    "istrusted": true,
    "allowdirectquestions": true,
    "username": "dave"
}

Update user permissions

Allows a user’s permissions to be updated.

PUT /api/v2/users/permissions

Input

Sample request

PUT /api/v2/users/permissions
{
    "userid": 202
    "canpostquestions": false,
    "canpostanswers": false
}

Response

Get user email settings

Retrieves the users email notification settings.

GET /api/v2/users/get/emailsettings

Input

Sample request

GET /api/v2/users/emailsettings?userid=202

Response

JSON
{
    "questionNewAnswersNotification": true,
    "answerNewAnswersNotification": false,
    "answerAcceptedNotification": false,
    "questionCommentsAfterNotification": false,
    "questionNewCommentsNotification": false,
    "answerCommentsAfterNotification": false,
    "answerNewCommentsNotification": false,
    "watchedQuestionsNotification": false,
    "watchedQuestionsNewCommentsNotification": false,
    "questionNewAnswerCommentsNotification": false,
    "username": "dave"
}

Update user email settings

Allows you to update the email notification settings for each user.

PUT /api/v2/users/emailsettings

Input

Sample request

PUT /api/v2/users/emailsettings
{
    "userid": 202,
    "questionnewanswersnotification": true,
    "answernewanswersnotification": true
}

Response

Get user activity notifications list

Gets a list of activity notifications for the user order by most recent first

GET /api/v2/account/activitynotifications/list

Parameters

Sample request

GET /api/v2/account/activitynotifications/list?userid=2216272&maxresults=2

Response

JSON
{
    totalnotificationscount      :int
    unviewednotificationscount   :int
    notifications                [{
                                       "id"           :int,
                                       "text"         :string,
                                       "title"        :string,
                                       "createtime"   :datetime,
                                       "url"          :string,
                                       "viewed"       :bool
                                 }]
}

EXAMPLE:
{
    "totalnotificationscount": 9,
    "unviewednotificationscount": 0,
    "notifications": [
        {
            "id": 334203,
            "text": "Your answer was recognized as the best answer to",
            "title": "How much is it if I buy in bulk?",
            "createtime": "2019-01-22T10:09:51",
            "url": "https://abc.answerbase.com/2604600/How-much#answer2604629",
            "viewed": true
        },
        {
            "id": 97966,
            "text": "<a class=\"userpopuplink\" href=\"http://abc.answerbase.com/
                    Profile/david2/\">david2</a> answered a question you also 
                    answered",
            "title": "new question",
            "createtime": "2018-07-03T07:44:57",
            "url": "https://abc.answerbase.com/2466998/new-question#answer2467047",
            "viewed": true
        }
    ]
}
    

Update user activity notification

Updates a user activity notification to be viewed

PUT /api/v2/account/activitynotifications/:id/setview

Input

Sample request

PUT api/v2/account/activitynotifications/688637/setview
{
    "viewtime": "2019-10-16",
}

Response

Get category

Gets a category with the specified id

GET /api/v2/categories/get

Parameters

Sample request

GET /api/v2/categories/get?id=8877

Response

A category object.

Get categories list

Gets a list of categories based on a range of parameters

GET /api/v2/categories/list

Parameters

Sample request

GET /api/v2/categories/list?restrictToFirstLevel=true

Response

A list of category objects.

Add Category

Creates a new category

POST /api/v2/categories/add

Parameters

Sample request

    POST /api/v2/categories/add
    {
    "externalid": "SHOES123",
    "name": "Ordinary Shoes",
    "url": "https://yoursite.com/ordinaryshoes",
    "categoryparentexternalid": "FOOTWEAR123"
    }

Response

(empty)

Update Category

Updates a category with the specified id

PUT /api/v2/categories/update

Parameters

Sample request

    PUT /api/v2/categories/update
    {
    "externalid": "SHOES123",
    "name": "Ordinary Shoes",
    "url": "https://yoursite.com/ordinaryshoes",
    "categoryparentexternalid": "FOOTWEAR123"
    }

Response

(empty)

Get tag

Gets a tag with the specified id

GET /api/v2/tags/get

Parameters

Sample request

GET /api/v2/tags/get?id=8377

Response

A tag object.

Get tags list

Gets a list of tags

GET /api/v2/tags/list

Parameters

Sample request

GET /api/v2/tags/list?maxresults=10

Response

A list of tag objects.

Search Tags

Searches for tags by keywords

GET /api/v2/tags/search

Parameters

Sample request

GET /api/v2/tags/search?keywords=indoor&maxresults=10

Response

A list of tag objects.

Tags autosuggest

Searches for tags by keywords

GET /api/v2/tags/autosuggest

Parameters

Sample request

GET /api/v2/tags/autosuggest?term=cooling

Response

JSON
{
"totalCount": 3,
"tags": [
    {
        "label": "cooling",
        "id": 4400,
        "value": "cooling"
    },
    {
        "label": "cooling2",
        "id": 18729,
        "value": "cooling2"
    },
    {
        "label": "coolingTest",
        "id": 24882,
        "value": "coolingTest"
    }
    ]
}
    

Get products list

Gets a list of products based on a range of parameters

GET /api/v2/products/list

Parameters

Sample request

GET /api/v2/products/list?maxresults=10

Response

A list of product objects.

Get product categories

Gets a list of product categories based on a range of parameters

GET /api/v2/products/getcategories

Parameters

Sample request

GET /api/v2/products/getcategories?maxresults=10

Response

A list of category objects.

Products autosuggest

Searches for products by keywords

GET /api/v2/products/autosuggest

Parameters

Sample request

GET /api/v2/products/autosuggest?query=answerbase

Response

JSON
{
  "query": "answerbase",
  "suggestions": [
    "Answerbase Blue",
    "Answerbase Red"
  ],
  "data": [
    "https://lumincreative.com/question_answer_system_ws.html",
    "http://121026224127.3dcart.net/Answerbase-Red_p_8.html"
  ]
}

Add Product

Creates a new product

POST /api/v2/products/add

Input

Sample request

POST /api/v2/products/add
{
    "externalid": "SHOES123",
    "SKU": "123",
    "name": "Luxury Shoes",
    "price": "999.99"
}

Response

JSON
{
    "id": 102
}

Update Product

Updates an existing product

PUT /api/v2/products/update

Input

Sample request

PUT /api/v2/products/update
{
    "externalid": "SHOES456",
    "name": "Sandals",
    "price": "59.49"
}

Response

JSON
{
    "id": 105
}

Update Category

Updates a category with the specified id

PUT /api/v2/products/categoryupdate

Parameters

Sample request

    PUT /api/v2/products/categoryupdate
    {
    "externalid": "SHOES123",
    "name": "Ordinary Shoes",
    "url": "https://yoursite.com/ordinaryshoes"
    }

Response

(empty)

Get comment

Gets a comment with the specified id

GET /api/v2/comments/:id

Parameters

Sample request

GET /api/v2/comments/24402

Response

A comment object.

Add comment

Allows a comment to be submitted to the application.

POST /api/v2/comments/add

Input

Sample request

POST /api/v2/comments/add
{
    "postid": 20010
    "text": "This is a new comment"
    "userid": 202
    "published": false
}

Response

{
    "id": 2752219
}

Update comment

Allows a comment to be updated.

PUT /api/v2/comments/:id

Input

Sample request

PUT /api/v2/comments/24402
{
    "published": false
}

Response

Report comment

Flags a comment for review

PUT /api/v2/comments/:id/report

Input

Sample request

PUT /api/v2/comments/100/report
{
    "username" : "testuser"
}

Response

Vote comment

Allows a user to vote for a comment. Only positive votes (likes) are allowed.

PUT /api/v2/comments/:id/vote

Input

Sample request

PUT /api/v2/comments/100/vote/1
{
    "username" : "testuser"
}

Response

Post image

Allows you to post an image to be used in new questions or answers.

POST /api/v2/files/postimage

Input

Sample request

PUT /api/v2/files/postimage
{
    "imageWidth": 50,
    "imageHeight": 50
}

Response

JSON
{
    "url"    :"",
}

Add Related Content

Allows you to associate “related content” to specific questions.

POST /api/v2/content/addrelatedcontent

Input

Sample request

POST /api/v2/content/addrelatedcontent
{
    "contentId": 520,
    "title": "A search engine"
    "url": "https://google.com"
}

Response

Log pageview

Registers a view of a particular page of content. This is used to determine popularity of for example questions.

POST /api/v2/content/:id/logview

Input

Sample request

POST /api/v2/content/2752038/logview
{
    "userId": 202,
    "PageName": "/2752038/What-is-the-best-saw",
    "QueryString": "?uid=2216726&ac=5219312208",
    "Referrer": "https://google.com",
    "IPAddress": "127.0.0.1",
    "UserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Firefox/47.0"
}

Response

Add points

Add a custom points type to a user.

POST /api/v2/points/add

Input

Sample request

POST /api/v2/points/add
{
    "externalid": "ex1992",
    "userid": 202
}

Response

{
    "id": 2752219
}

Get email notifications list

Gets a list of emails sent out by the system within a timeperiod

GET /api/v2/email/notificationslist

Parameters

Sample request

GET /api/v2/email/notificationslist?fromDateTime=2024-01-30 14:00

Response

JSON
{
    "totalCount": int,
    "emails": [
        {
        "id": int,
        "sso_userid": string,
        "createtime": datetime,
        "subject": string,
        "body": string,
        "type": string,
        "questionid": int,
        "product_ids": [],
        "productcategory_ids": [],
        "category_ids": [],
        "external_product_ids": [],
        "external_productcategory_ids": [],
        "external_category_ids": []
        }]
}

EXAMPLE:
{
    "totalCount": 19,
    "emails": [
    {
        "id": 15853073,
        "sso_userid": 9989,
        "createtime": "2024-02-25T16:00:50",
        "subject": "New Answer to Your Question: I need replacement Axles",
        "body": "Dear Guest, We're notifying you about a new answer",
        "type": "4",
        "questionid": 4843101,
        "product_ids": [123],
        "productcategory_ids": [],
        "category_ids": [],
        "external_product_ids": ["x56556"],
        "external_productcategory_ids": [],
        "external_category_ids": []
    },
    ...
    ]
}

Get a token

Retrieving a 24-hour valid token for user's credentials:

POST /api/v2/token

Input

Sample request

POST /api/v2/token
{
"grant_type": "password",
"username": "abc.answerbase.com",
"password": "2kefHUowd3tdm2Opwdkhasd"
}

Response

Version 2.1

- Updated methods Get Questions List, Search Questions and Get Featured Questions adding "productexternalid" as optional parameter to filter the questions by.

- Added Add Product and Update Product methods

Version 2.0

New API published