FAQ Site Templates

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

An FAQ template instance resource represents a FAQ template used to render a FAQ site.

Resource URI

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

Resource Properties

A FAQ template resource is represented by the following properties:

Property	Description
id	Unique integer identifier for a FAQ template.
name	String containing the template's name.
content	String containing the template's content.
revisions	Array of revision objects. The last 10 revisions made to a template are retained.

HTTP GET

Retrieve the details of a FAQ template.

Response

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

Example

GET /2013-07-21/faqs/2817/templates/44737

{
  "id": 44737,
  "name": "login.html",
  "content": "<div id="tag-cloud"></div>",
  "revisions": [{
    "revision": 1,
    "created": "2015-05-18T13:58:14.808-04:00",
    "editor": "ashelton"
  }]
}

HTTP POST

Not supported.

HTTP PATCH, PUT

Modify the properties of an existing FAQ template.

Optional PATCH, PUT data

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

Property	Description
content	String containing the template content.

Response

Returns a JSON response representing the updated template resource.

Example

PUT /2013-07-21/faqs/2817/templates/44737
{
  "content": "<div id="tag-cloud">tag cloud</div>",
}

{
  "id": 44737,
  "name": "tag-cloud.html",
  "content": "<div id="tag-cloud">tag cloud</div>",
  "revisions": [{
    "revision": 1,
    "created": "2015-05-18T13:58:14.808-04:00",
    "editor": "ashelton"
  }, {
    "revision": 2,
    "created": "2015-05-19T10:11:25.170-04:00",
    "editor": "ashelton"
  }]
}

HTTP DELETE

Not supported.

FAQ Templates List Resource

The FAQ Templates list resource represents all the FAQ templates for a FAQ site.

Resource URI

/2013-07-21/faqs/3060/templates

HTTP GET

Returns all the FAQ templates for a FAQ site.

Response

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

Example - list all FAQ templates

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

[
  {
    "id": 44737
    "name": "tag-cloud.html",
    "content": "<div id="tag-cloud"></div>",
    "revisions": [{
      "revision": 1,
      "created": "2015-05-18T13:58:14.808-04:00",
      "editor": "ashelton"
    }]
  },
  ...
]

HTTP POST

Not supported.

HTTP PATCH, PUT

Not supported.

HTTP DELETE

Not supported.