Search Topics by Params

All API requests should contain authorization headers.

Search for published topics by criteria from the query parameters.

Request

GET /faq/{faqName}/topics/search?cleanText={cleanText}&skip={skip}&take={take}&viewCountPeriod={viewCountPeriod}

Query Parameters

NameTypeRequiredComments

faqName

string

yes

The name of the FAQ instance for the request

categoryId

nullable integer

no

The topic category unique id. If not null, only topics associated with that category id will be returned.

The default value is null.

cleanText

bool

no

If true the request returns the topic's content without HTML tags.

The default values is false

query

string

no

A text query used to search within topic titles or content. If not null, only topics containing this specified text in their title or body will be returned.

The default value is null

skip

integer

no

The number of topics to be skipped from the results.

The default value is 0

take

integer

no

The maximum number of tickets displayed in the results.

The default value is 10

viewCountPeriod

nullable integer

no

The number of days for topic viewing statistics. Use this property to retrieve topic views within a specific period in days.

If a value is set, it returns the view counts for that number of days; if set to null, all view counts will be returned.

The default value is null

Response

{
    "data": {
        "items": [
            {
                "isPublished": true,
                "link": "faq.socialboards.com/southsideblueroyaljewelry/category/452/policies--support/topic/10002243/payment-methods--installment-plans",
                "publishTime": "2023-12-19T14:42:57.563867+00:00",
                "usefulCount": 0,
                "attachments": [],
                "bannerImageLink": null,
                "category": {
                    "activeTopicCount": 1,
                    "creationTime": "2023-12-19T14:28:09.7019105+00:00",
                    "creatorId": "dd5a1046-98c7-4e12-9bc4-1c5aa35cf403",
                    "description": "Learn about our payment methods, return policies, store locations, and how to contact our dedicated customer support team for any inquiries or assistance",
                    "id": 452,
                    "imageLink": null,
                    "isPublished": true,
                    "isSticky": true,
                    "lastUpdateTime": "2023-12-21T08:29:55.7316364+00:00",
                    "publishedTopicCount": 1,
                    "title": "Policies & Support",
                    "totalUsefulness": 0,
                    "viewCount": 0
                },
                "content": "At [Jewelry Store Name], we offer flexible payment options to make your purchase experience convenient and tailored to your preferences. Explore our diverse range of payment methods and installment plans designed to accommodate your needs.\r\n1. Accepted Payment Methods:\r\n*\t\r\nCredit & Debit Cards: We accept major credit cards such as Visa, Mastercard, American Express, and Discover, providing a secure and straightforward payment process.\r\n*\t\r\nOnline Payment Gateways: Simplify your transactions by using trusted online payment gateways like PayPal or other secure platforms for hassle-free purchases.\r\n\r\n2. Bank Transfers and Wire Transfers:\r\n*\t\r\nBank-to-Bank Transfers: Opt for direct bank transfers or wire transfers for larger purchases, ensuring a seamless transaction process.\r\n*\t\r\nInstructions Provided: Contact our customer service for detailed instructions on how to proceed with bank transfers to complete your payment.\r\n\r\n3. Installment and Payment Plans:\r\n*\t\r\nFlexible Installments: Benefit from our installment plans allowing you to spread the cost of your purchase over a set period, making high-value purchases more manageable.\r\n*\t\r\nCustomizable Plans: Discuss personalized installment options with our team to tailor a payment plan that suits your financial preferences and the specifics of your purchase.\r\n\r\n4. Secure Transactions & Privacy:\r\n*\t\r\nSafe and Secure Transactions: Rest assured, all payment methods and transactions adhere to the highest security standards to protect your sensitive information.\r\n*\t\r\nPrivacy Protection: We prioritize customer privacy and confidentiality, ensuring that your payment details are handled securely and with the utmost discretion.\r\n\r\n5. Terms and Conditions:\r\n*\t\r\nClear Terms: Review the terms and conditions associated with different payment methods and installment plans to understand the applicable fees, interest rates (if any), and repayment schedules.\r\n*\t\r\nTransparency: We maintain transparency in our payment processes, providing clear information to facilitate informed decisions regarding your purchases and payments.\r\n\r\n6. Assistance and Inquiries:\r\n*\tPayment Assistance: Should you require guidance or have inquiries regarding payment methods or installment plans, our customer service team is available to assist you.",
                "creationTime": "2023-12-19T14:42:51.9941409+00:00",
                "description": "Details about accepted payment methods, security measures, and the availability of installment/payment plans",
                "id": 10002243,
                "isSticky": true,
                "lastUpdateTime": "2023-12-21T13:40:38.0697042+00:00",
                "logoLink": null,
                "tableOfContents": "[]",
                "tags": [
                    {
                        "id": 444,
                        "name": "Support"
                    }
                ],
                "title": "Payment Methods & Installment Plans",
                "totalUsefulness": 0,
                "viewCount": 0
            }
        ],
        "totalResultsCount": 1
    },
    "errorCode": -1,
    "errorText": null
}

Data field will contain Topic Search Result model.

Last updated