v_ Calendar Event Widget

patch

https://app.financekey.com/OData/v_CalendarEventWidgets({key})

This view is used to present calendar events in widget list charts and on dashboards.

Path Params

key

string

required

Body Params

calendarDate

string | null

The CalendarDate field is a primary key in the CalendarEventWidget table and is of the data type nvarchar with a maximum length of 4000 characters. This field stores the specific date for each calendar event widget, ensuring that each record in the table has a unique identifier. With its flexible data type and large length allowance, the CalendarDate field can accommodate various date formats, making it a versatile and reliable way to organize and reference calendar events within the widget.

nameHtml

string | null

The NameHtml field in the CalendarEventWidget table is of data type nvarchar and has a maximum length of 463 characters. This field will be used to store the name of a specific event in HTML format. This can include formatting, images, and links, allowing for a visually appealing and interactive title for the event. With a generous character limit, the NameHtml field allows for detailed and creative event names to be displayed in the CalendarEventWidget.

typeHtml

string | null

The TypeHtml field in the CalendarEventWidget table is of data type nvarchar and can hold a maximum of 268 characters. This field is typically used to store HTML code, allowing for the customization and formatting of text displayed in relation to calendar events. This data type is flexible and can accommodate a wide range of characters, making it a versatile option for storing HTML code.

calendarId

date-time

required

The CalendarId field in the CalendarEventWidget table stores a unique date and time value in the datetime2 data type format. This field is used to identify and organize individual calendar events within the widget. It allows for easy sorting and retrieval of events based on specific dates and times. The datetime2 data type offers increased accuracy and flexibility for recording dates and times, making it a reliable choice for managing calendar events.

eventId

int32

The EventId field in the CalendarEventWidget table is of data type int and is used to uniquely identify each event within the widget. This field serves as a primary key and allows for efficient tracking and organization of events. It can be automatically generated or manually assigned, but must be a unique number for each event. The EventId is essential for managing and displaying events on the widget, providing a simple and reliable way to identify and retrieve specific event information.

title

string

required

length between 1 and 256

The field 'Title' in the 'CalendarEventWidget' table is of data type nvarchar and has a maximum length of 256 characters. This field holds the title or name of a calendar event, providing a concise description of the event. It allows for easy identification and organization of events within the widget. The nvarchar data type allows for both letters and numbers, making the field versatile for a variety of event titles. With a generous maximum length of 256 characters, this field can accommodate longer event titles without truncation. Overall, the 'Title' field in the 'CalendarEventWidget' table plays an essential role in accurately representing and managing calendar events.

itemId

string | null

The ItemId field in the CalendarEventWidget table is a nvarchar data type with a maximum length of 64 characters. This field is used to uniquely identify each event in the calendar widget. The ItemId can contain numbers, letters, and special characters, making it a versatile identifier for different types of events. This field is essential for organizing and categorizing events within the widget, allowing users to easily distinguish between different events. It is also useful for linking events to other data or external sources. By limiting the length to 64 characters, it ensures that the ItemId remains concise yet descriptive.

eventTypeId

string | null

The EventTypeId field in the CalendarEventWidget table is a nvarchar data type with a maximum length of 64 characters. It is used to identify and classify the type of event that is associated with the widget. This field allows for efficient organization and sorting of events within the calendar widget. It can contain a wide variety of event types such as meetings, appointments, birthdays, holidays, and more. The field provides a clear and concise way to identify and differentiate between different types of events in the widget.

calendarEventId

int32

The CalendarEventId is a field within the CalendarEventWidget table that stores a unique numerical identifier for each calendar event. This data type is set to int, or integer, meaning it can only contain whole numbers. This allows for efficient sorting, filtering, and retrieval of specific events within the table. The CalendarEventId serves as a primary key, ensuring each event has a distinct identifier, and is used to link the event to other related data within the database. This field is essential for effective organization and management of calendar events in the CalendarEventWidget table.

rowNumber

int64 | null

The RowNumber field is a bigint data type that belongs to the CalendarEventWidget table. It is used to keep track of the sequential order of rows within the table. This field is important for maintaining the structure and organization of the data within the table, allowing for efficient retrieval and manipulation of data. The RowNumber field is essential for maintaining the integrity and accuracy of data within the CalendarEventWidget table.

Response

200

Language

URL

Response

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