PartnerFaqsController API Documentation

Partner FAQs API Documentation

This document provides documentation for the Partner FAQs API endpoints available in the Points.Api system.

Table of Contents

• Authentication
• Endpoints
  • Get Partner Sections

Authentication

All endpoints in the Partner FAQs API require JWT Bearer authentication. Include the JWT token in the Authorization header of your requests:

Authorization: Bearer {your_jwt_token}

Endpoints

Get Partner Sections

Retrieves FAQ sections for a specific partner.

URL: /api/PartnerFaqs/Partner/{partnerId}

Method: GET

Auth required: Yes (JWT Bearer token)

URL Parameters:

• partnerId (long) - ID of the partner

Success Response:

• Code: 200 OK
• Content: List of FAQ sections with their questions and answers

Example Request:

GET /api/PartnerFaqs/Partner/123 HTTP/1.1
Host: your-api-domain.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Example Response:

[
  {
    "id": 1,
    "title": "General Questions",
    "order": 1,
    "isActive": true,
    "questions": [
      {
        "id": 101,
        "question": "How do I earn points?",
        "answer": "You can earn points by completing activities such as running, cycling, and participating in challenges.",
        "order": 1,
        "isActive": true
      },
      {
        "id": 102,
        "question": "How do I redeem my points?",
        "answer": "You can redeem your points for rewards in the Rewards section of the app.",
        "order": 2,
        "isActive": true
      }
    ]
  },
  {
    "id": 2,
    "title": "Technical Support",
    "order": 2,
    "isActive": true,
    "questions": [
      {
        "id": 201,
        "question": "How do I reset my password?",
        "answer": "You can reset your password by clicking on the 'Forgot Password' link on the login page.",
        "order": 1,
        "isActive": true
      },
      {
        "id": 202,
        "question": "How do I update my profile?",
        "answer": "You can update your profile by going to the Profile section in the app settings.",
        "order": 2,
        "isActive": true
      }
    ]
  }
]

The response contains an array of FAQ sections, each with a title, order, active status, and a list of questions. Each question has an ID, the question text, answer text, display order, and active status.