Class Inquiry

Namespace

BiExcellence.OpenBi.Api.Inquiries

Assembly

BiExcellence.OpenBi.Api.Client.dll

A submitted web inquiry (e.g. a contact-form submission), linked to an Inquirer. Captured by the CMS, not created through the REST API; the free-form answers are its InquiryField rows.

public sealed record Inquiry : IInquiry

Inheritance

object

Inquiry

Implements

IInquiry

Properties

Comment

The message text of the submitted form.

[JsonPropertyName("comment")]
public string? Comment { get; init; }

Property Value

string

CustomAttributes

The values of the custom table attributes defined for inquiries (table INQUIRIES, see GetTableAttributesAsync(IOpenBiApiClient, string, CancellationToken)), by attribute name.

[JsonPropertyName("customAttributes")]
public Dictionary<string, JsonElement>? CustomAttributes { get; init; }

Property Value

Dictionary<string, JsonElement>

Date

When the inquiry was captured. Server-assigned.

[JsonPropertyName("date")]
public DateTimeOffset Date { get; init; }

Property Value

DateTimeOffset

Host

The host name the form was submitted on.

[JsonPropertyName("host")]
public string? Host { get; init; }

Property Value

string

Id

The id of the inquiry, a GUID assigned when it is captured.

[JsonPropertyName("id")]
public string Id { get; init; }

Property Value

string

InquirerId

The id of the Inquirer who sent the inquiry.

[JsonPropertyName("inquirerId")]
public string? InquirerId { get; init; }

Property Value

string

Path

The path and query string of the request that submitted the form.

[JsonPropertyName("path")]
public string? Path { get; init; }

Property Value

string

Status

The processing status, free text. The CMS contact form captures an inquiry as new.

[JsonPropertyName("status")]
public string? Status { get; init; }

Property Value

string

Url

The full URL of the request that submitted the form. RedistributeInquiryAsync(IOpenBiApiClient, string, CancellationToken) passes it to the lead distributors as the source.

[JsonPropertyName("url")]
public string? Url { get; init; }

Property Value

string

UserId

The username of the logged-on user who submitted the form; empty when it was sent by an anonymous visitor.

[JsonPropertyName("userId")]
public string? UserId { get; init; }

Property Value

string