Skip to main content

FAQ Management API

The FAQ API allows you to manage frequently asked questions organized by categories. FAQs can be scoped to specific user roles (guide, tourist, or both).

FAQ Categories

Get All FAQ Categories

curl -X GET https://api.kinconecta.com/api/faq-categories \
  -H "Content-Type: application/json"

Response

id
integer
required
Unique identifier for the FAQ category
name
string
required
Category name (max 120 characters)
roleScope
enum
required
Target audience for this category
sortOrder
integer
required
Display order (default: 0)

Get FAQ Category by ID

curl -X GET https://api.kinconecta.com/api/faq-categories/{id} \
  -H "Content-Type: application/json"

Path Parameters

id
integer
required
The FAQ category ID

Response

Returns a single FAQ category object or 404 if not found.

Create FAQ Category

curl -X POST https://api.kinconecta.com/api/faq-categories \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Booking Questions",
    "roleScope": "tourist",
    "sortOrder": 2
  }'

Request Body

name
string
required
Category name (max 120 characters)
roleScope
enum
required
Target audience: guide, tourist, or both
sortOrder
integer
default:"0"
Display order

Response

Returns the created FAQ category object.

Update FAQ Category

curl -X PUT https://api.kinconecta.com/api/faq-categories/{id} \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Category Name",
    "roleScope": "both",
    "sortOrder": 1
  }'

Path Parameters

id
integer
required
The FAQ category ID to update

Request Body

name
string
required
Updated category name
roleScope
enum
required
Updated role scope
sortOrder
integer
Updated display order

Response

Returns the updated FAQ category object or 404 if not found.

Delete FAQ Category

curl -X DELETE https://api.kinconecta.com/api/faq-categories/{id} \
  -H "Content-Type: application/json"

Path Parameters

id
integer
required
The FAQ category ID to delete

Response

Returns 204 No Content on success.

FAQ Items

Get All FAQ Items

curl -X GET https://api.kinconecta.com/api/faq-items \
  -H "Content-Type: application/json"

Response

id
long
required
Unique identifier for the FAQ item
faqCategoryId
integer
required
Associated category ID
question
string
required
The FAQ question (max 300 characters)
answer
string
required
The FAQ answer (text field)
isActive
boolean
required
Whether the FAQ item is active (default: true)
sortOrder
integer
required
Display order within category (default: 0)

Get FAQ Item by ID

curl -X GET https://api.kinconecta.com/api/faq-items/{id} \
  -H "Content-Type: application/json"

Path Parameters

id
long
required
The FAQ item ID

Response

Returns a single FAQ item object or 404 if not found.

Create FAQ Item

curl -X POST https://api.kinconecta.com/api/faq-items \
  -H "Content-Type: application/json" \
  -d '{
    "faqCategoryId": 1,
    "question": "How do I book a tour?",
    "answer": "Browse available tours, select one, and click the Book Now button...",
    "isActive": true,
    "sortOrder": 3
  }'

Request Body

faqCategoryId
integer
required
The category this FAQ belongs to
question
string
required
The FAQ question (max 300 characters)
answer
string
required
The FAQ answer (text field)
isActive
boolean
default:"true"
Whether the FAQ is active
sortOrder
integer
default:"0"
Display order within category

Response

Returns the created FAQ item object.

Update FAQ Item

curl -X PUT https://api.kinconecta.com/api/faq-items/{id} \
  -H "Content-Type: application/json" \
  -d '{
    "faqCategoryId": 1,
    "question": "Updated question?",
    "answer": "Updated answer...",
    "isActive": false,
    "sortOrder": 5
  }'

Path Parameters

id
long
required
The FAQ item ID to update

Request Body

All fields from the create request.

Response

Returns the updated FAQ item object or 404 if not found.

Delete FAQ Item

curl -X DELETE https://api.kinconecta.com/api/faq-items/{id} \
  -H "Content-Type: application/json"

Path Parameters

id
long
required
The FAQ item ID to delete

Response

Returns 204 No Content on success.

Build docs developers (and LLMs) love