Table of Contents

Class Organisation

Namespace
BiExcellence.OpenBi.Api.Organisations
Assembly
BiExcellence.OpenBi.Api.Client.dll

An organisation (e.g. a customer or business unit) that users and usergroups can be assigned to. Every user linked to it gets the usergroups and roles linked to it, and the auth object values it owns restrict their data. It can also have a CMS site of its own (the HostHeader* fields).

public sealed record Organisation : IOrganisation
Inheritance
object
Organisation
Implements

Properties

AdditionalInfo1

A free-text additional information field; the server does not interpret it.

[JsonPropertyName("additionalInfo1")]
public string? AdditionalInfo1 { get; init; }

Property Value

string

AdditionalInfo2

A second free-text additional information field; the server does not interpret it.

[JsonPropertyName("additionalInfo2")]
public string? AdditionalInfo2 { get; init; }

Property Value

string

Address

The street address.

[JsonPropertyName("address")]
public string? Address { get; init; }

Property Value

string

Branch

A free-text classification field; the server does not interpret it.

[JsonPropertyName("branch")]
public string? Branch { get; init; }

Property Value

string

City

The city of the address.

[JsonPropertyName("city")]
public string? City { get; init; }

Property Value

string

Country

The country of the address.

[JsonPropertyName("country")]
public string? Country { get; init; }

Property Value

string

CustomAttributes

The values of the custom table attributes defined for organisations (table ORGANISATION, see GetTableAttributesAsync(IOpenBiApiClient, string, CancellationToken)), by attribute name. They are also passed on to the organisation's CMS site.

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

Property Value

Dictionary<string, JsonElement>

CustomerNumber

The organisation's customer number. Free text; the server does not interpret it.

[JsonPropertyName("customerNumber")]
public string? CustomerNumber { get; init; }

Property Value

string

Description

A free-text description of the organisation.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

Email

The contact e-mail address.

[JsonPropertyName("email")]
public string? Email { get; init; }

Property Value

string

Fax

The fax number.

[JsonPropertyName("fax")]
public string? Fax { get; init; }

Property Value

string

HostHeaderHost

The host name of the organisation's own CMS site, with the same syntax as Host. When set, the server serves a site on this host that is built from HostHeaderId and the other HostHeader* fields; when empty, the organisation has no site of its own.

[JsonPropertyName("hostHeaderHost")]
public string? HostHeaderHost { get; init; }

Property Value

string

HostHeaderId

The id of the HostHeader the organisation's site copies its remaining settings from (web file container, SSL requirement, custom attributes). Without one, the site has only the organisation's own settings. Only used when HostHeaderHost is set.

[JsonPropertyName("hostHeaderId")]
public string? HostHeaderId { get; init; }

Property Value

string

HostHeaderPageId

The entry page of the organisation's site - the id of a CMS item template with tag PAGE. Overrides the entry page of HostHeaderId when set.

[JsonPropertyName("hostHeaderPageId")]
public string? HostHeaderPageId { get; init; }

Property Value

string

HostHeaderRoleId

The id of the CMS role whose content the organisation's site serves. Overrides the role of HostHeaderId when set.

[JsonPropertyName("hostHeaderRoleId")]
public string? HostHeaderRoleId { get; init; }

Property Value

string

Id

The id of the organisation. Server-assigned (a GUID) on create when left empty.

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

Property Value

string

IsActive

Whether the organisation is marked active. Informational: CMS pages can read it, but the server does not block the members of an inactive organisation.

[JsonPropertyName("isActive")]
public bool IsActive { get; init; }

Property Value

bool

Name

The display name of the organisation.

[JsonPropertyName("name")]
public string? Name { get; init; }

Property Value

string

Phone

The contact phone number.

[JsonPropertyName("phone")]
public string? Phone { get; init; }

Property Value

string

PostalCode

The postal code of the address.

[JsonPropertyName("postalCode")]
public string? PostalCode { get; init; }

Property Value

string

RegistrationCode

A free-text registration code; the server does not interpret it.

[JsonPropertyName("registrationCode")]
public string? RegistrationCode { get; init; }

Property Value

string

Segment

A free-text classification field; the server does not interpret it.

[JsonPropertyName("segment")]
public string? Segment { get; init; }

Property Value

string

Website

The website URL.

[JsonPropertyName("website")]
public string? Website { get; init; }

Property Value

string