FAQ Site Topics

Authentication

LibraryH3lp supports cookie-based authentication. To learn more, you can read the details on authentication.

HTTP and HTTPS

Requests are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

FAQ Topic Instance Resource

An FAQ topic instance resource represents a single FAQ topic contained within a FAQ site. FAQ Questions can be tagged with one or more topics.

Resource URI

/2013-07-21/faqs/{FAQId}/topics/{topicId}

Resource Properties

A FAQ topic resource is represented by the following properties:

Property	Description
id	Unique integer identifier for a FAQ topic.
account_id	Integer ID of the account to which a topic belongs.
topic	String containing the topic description.

HTTP GET

Retrieve the details of a FAQ topic.

Response

Returns a JSON response containing a representation of a FAQ topic, including the properties above.

Example

GET /2013-07-21/faqs/2817/topics/2237

{
  "id": 9884,
  "account_id": 2031,
  "topic": "example topic"
}

HTTP POST

Not supported.

HTTP PATCH, PUT

Modify the properties of an existing FAQ topic.

Optional PATCH, PUT data

You may include, as JSON PUT data, any of the following properties.

Property	Description
topic	String containing the topic description.

Response

Returns an empty response.

HTTP DELETE

Delete a FAQ topic.

Response

Returns an empty response.

Example

DELETE /2013-07-21/faqs/2817/topics/2237

FAQ Topics List Resource

The FAQ Topics list resource represents all the FAQ topics used in a FAQ site.

Resource URI

/2013-07-21/faqs/3060/topics

HTTP GET

Returns all the FAQ topics used in a FAQ site.

Response

Returns a JSON response containing a list of FAQ topic resources.

Example - list all FAQ topics

GET /2013-07-21/faqs/3060/topics

[
  {
    "id": 2237
    "topic": "example topic",
    "account_id": 2031
  }
]

HTTP POST

Create a new FAQ topic.

Required POST data

You must include, as JSON POST data, all of the following properties.

Property	Description
topic	String containing the topic text.

Response

If successful, returns a JSON response containing the resource representation of the newly created FAQ topic.

Example - successful creation of a FAQ topic

POST /2013-07-21/faqs/3060/topics


{
  "id": 2240,
  "topic": "my new topic",
}

HTTP PATCH, PUT

Not supported.

HTTP DELETE

Not supported.