Help Categories

post

https://app.financekey.com/OData/HelpCategories

The HelpCategory table is an essential component of the Help package, designed to categorize and organize information related to various assistance topics. This table contains a list of categories that users can refer to when seeking help or support on a particular subject. It stores details such as category name, description, and any relevant keywords that can help users easily find the information they need. This table serves as a reference guide for navigating through the vast amount of help resources available and helps users quickly identify the most relevant information to their needs. With the HelpCategory table, users can efficiently manage their search and access the assistance they require, making the Help package an invaluable tool for troubleshooting and problem-solving.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

helpCategoryId

int32

The HelpCategoryId is a unique identifier that is used to identify a specific category within the HelpCategory table. This field is of the data type int, which means it can only store whole numbers. It serves as the primary key for the table, allowing for efficient data retrieval and organization. Each record in the table is assigned a unique HelpCategoryId, ensuring that no duplicates exist. This field is essential for maintaining the integrity and accuracy of data in the HelpCategory table, as it is used to establish relationships with other tables. With the use of this identity field, different categories of help can be easily differentiated and referenced within the database.

parentHelpCategoryId

int32 | null

The ParentHelpCategoryId field is an integer value that is used to classify and organize the HelpCategory table. It serves as a reference to the parent category of a particular help category. This field is crucial for creating a hierarchical structure within the table, allowing for a better understanding and organization of the different help categories. The data type of this field is int, which means it can only store whole numbers. This field is particularly useful when there are multiple levels of help categories and enables easy navigation through the categories. Additionally, it ensures the integrity and accuracy of the data in the table, as only valid parent category IDs can be entered.

prompt

string | null

The Prompt field in the HelpCategory table is of data type nvarchar and has a maximum length of 64 characters. This field is designed to store short, descriptive prompts related to different help categories. These prompts provide a brief explanation or title for the help category, making it easier for users to navigate and find the information they need. With this field, the HelpCategory table enhances the user experience by providing clear and concise prompts for each category.

description

string | null

The 'Description' field in the 'HelpCategory' table is of the data type nvarchar with a maximum length of 256 characters. This field will contain a brief explanation or summary of the category it is associated with, allowing for easy understanding and organization of the help topics. The nvarchar data type allows for the storage of both Unicode and non-Unicode character data, making it ideal for displaying text in multiple languages. The maximum length of 256 characters ensures that the description is concise and can be easily viewed and comprehended by users. This field is an essential component of the 'HelpCategory' table, providing valuable context and information for the different categories of help topics.

comment

string | null

Miscellaneous notes and information for the entry or record.

entityId

string | null

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!