FAQs

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 Instance Resource

An FAQ instance resource represents a single FAQ connected to the user account provided during authentication.

Resource URI

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

Resource Properties

A FAQ resource is represented by the following properties:

Property	Description
id	Unique integer identifier for a FAQ.
cname	Optional string containing the CNAME record for the FAQ. If no CNAME is present, cname is null.
name	String that uniquely identifies the FAQ. The name of a FAQ becomes part of the subdomain for the FAQ's URL. E.g. NAME.ask.libraryh3lp.com
email	String containing an e-mail address or contact page URL for the FAQ's email integration.
queueId	Integer representing the ID of the queue used in this FAQ's chat integration.
serviceTypeId	Integer representing the chat widget style used for the FAQ's chat integration. Can be either 2 (pop-out) or 3 (follow-me).
widgetId	Integer representing the chat widget skin ID used for the FAQ's chat integration. If widgetId is null, a default, themed chat widget is used.
theme	String indicating the theme used by the FAQ. The possible themes are: amelia, cerulean, cyborg, default, default2, flatly, littlechambre, journal, readable, readable2, simplex, simplex2, slate, spacelab, spruce, spruce2, superhero, and united.
public	Boolean indicating if a FAQ requires authentication. True indicates no authentication is required.
stats_overview	Summary of the statistics for this FAQ. The stats_overview is a JSON object with the following fields, all of which are integer values: num_questions, num_views, num_likes, num_dislikes, num_searches, num_topics.

HTTP GET

Retrieve a FAQ's information.

Response

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

Example

GET /2013-07-21/faqs/2817

{
  "id": 2817,
  "cname": null,
  "name": "example_faq",
  "email": "support@libraryh3lp.com",
  "queueId": 8724,
  "serviceTypeId": 2,
  "widgetId": null,
  "theme": "default2"
  "public": true
  "stats_overview": {
    "num_questions": 4,
    "num_views": 4,
    "num_likes": 2,
    "num_dislikes": 2,
    "num_searches": 0,
    "num_topics": 1
  }
}

HTTP POST

Not supported.

HTTP PATCH, PUT

Modify the properties of an existing FAQ.

Optional PATCH, PUT data

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

Property	Description
cname	String containing the CNAME record for the FAQ.
name	String that uniquely identifies the FAQ. The name of a FAQ becomes part of the subdomain for the FAQ's URL. E.g. NAME.ask.libraryh3lp.com
email	String containing an e-mail address or contact page URL for the FAQ's email integration.
queueId	Integer representing the ID of the queue used in this FAQ's chat integration.
serviceTypeId	Integer representing the chat widget style used for the FAQ's chat integration. Can be either 2 (pop-out) or 3 (follow-me).
widgetId	Integer representing the chat widget skin ID used for the FAQ's chat integration. If widgetId is null, a default, themed chat widget is used.
theme	String indicating the theme used by the FAQ. The possible themes are: amelia, cerulean, cyborg, default, default2, flatly, littlechambre, journal, readable, readable2, simplex, simplex2, slate, spacelab, spruce, spruce2, superhero, and united.
public	Boolean indicating if a FAQ requires authentication. True indicates no authentication is required.

Response

Returns an empty response.

Example

PUT /2013-07-21/faqs/2817
{
  "name": "my-renamed-FAQ"
}

HTTP DELETE

Delete a FAQ.

Response

Returns an empty response.

Example

DELETE /2013-07-21/faqs/2817

FAQs List Resource

The FAQs list resource represents the set of FAQs managed by the user whose credentials were used to make the API request.

Resource URI

/2013-07-21/faqs

HTTP GET

Returns all the FAQs managed by the user whose credentials were used to make the API request.

Response

Returns a JSON response containing a list of FAQ resources.

Example - list all FAQs

GET /2013-07-21/faqs

[
  {
    "id": 2817
    "name": "example_faq",
    "cname": null,
    "email": "support@libraryh3lp.com",
    "queue": "example_queue",
    "public": true
  }
]

HTTP POST

Create a new FAQ.

Required POST data

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

Property	Description
name	String that uniquely identifies the FAQ. The name of a FAQ becomes part of the subdomain for the FAQ's URL. E.g. NAME.ask.libraryh3lp.com

Response

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

Example - successful creation of a FAQ

POST /2013-07-21/faqs
{
  "id": 3060,
  "name": "my-new-FAQ",
  "cname": null,
  "email": null,
  "queueId": null,
  "widgetId": null,
  "theme": "default2",
  "public": true,
  "stats_overview": {
    "num_questions": 0,
    "num_views": 0,
    "num_likes": 0,
    "num_dislikes": 0,
    "num_searches": 0,
    "num_topics": 0
  }
}

HTTP PATCH, PUT

Not supported.

HTTP DELETE

Not supported.