Faq (Admin)

Companies can create some FAQ context and maintain its FAQ items. This module makes possible to manipulate that entities.

A FAQ item can be associated to one or more contexts and it is technically independent of a context. You can see the model representation bellow.

Data modelling of FAQ system

FAQ items entities are I18n compliant.

FAQ Model (Example)

{
  "id": "e9aa37cd-0d43-425e-828a-1fda093cbdf1",
  "createdAt": "2022-09-15T14:19:47.052Z",
  "updatedAt": "2022-09-15T14:19:47.052Z",
  "context": {
    "id": "e9aa37cd-0d43-425e-828a-1fda093cbdf2",
    "createdAt": "2022-09-15T14:19:47.052Z",
    "updatedAt": "2022-09-15T14:19:47.052Z",
    "name": "pre-sale"
  }
  "question": {
    "pt-br": "Como comprar?",
    "en": "How to purchase?"
  },
  "answer": {
    "pt-br": "Basta colocar o cartao de credito e pagar que adicionamos a sua wallet.",
    "en": "You can put your items into your cart, click on purchase and pay with your credit card."
  },
  "externalUrl": "https://w3block.io/faqitem"
}

Service Methods

Creates a new FAQ context inside a company

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Lists all company FAQ contexts

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Gets some company FAQ context by ID

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Updates some company FAQ context

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Lists all FAQ context items

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Gets some specific FAQ item by ID from some FAQ context

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Creates a FAQ item and associate it to one or more contexts

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Lists all FAQ items available in the company independent of context

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Gets some FAQ item of company by ID

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Updates some FAQ item, including re-association of contexts

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file