Description

Entity for organizations in the organization service.

Hierarchy (view full)

Implements

Constructors

Properties

addressLine1: string

Address line 1 of the organization

addressLine2: string

Address line 2 of the organization

addressLine3: string

Address line 3 of the organization

ancestorIds: string[]

The ancestor IDs (in order from root to this entity)

ancestorNamePath: string

The ancestor entity name path (comma separated name path, starting from root)

auditStatus: "waiting_for_review" | "in_review" | "rejected" | "approved" | "change_requested" | "waiting_for_change_review"

Current auditing status of the organization

branchName: string

Organization branch name

certificateImageId: string

A base64 string containing the organization's certificate image.

certifiedQualifications: Qualification[]

Qualifications that need to be reviewed to change

childrenCount: number

The number of children this organization has

customFields: Record<string, unknown>

Custom fields

depth: number

The depth that this entity is in the tree

description: string

Organization description

iconImageId: string

A base64 string containing the organization's certificate image.

logoImageId: string

A base64 string containing the organization's logo image.

name: string

Name of the organization

numberOfProjects: string

Number of Projects

parentId: null | string

The parent entity's ID

phoneNumber: string

Contact number for the organization.

pictureUrl: string

URL for the organization's picture.

postalCode: string

Postal code address

qualifications: Qualification[]

Qualification that user can change without review

reviewStats?: {
    averageRate?: number;
    averageSubRates?: Record<string, number>;
    totalCount?: number;
}

The current statistics for reviews made against this organization.

Type declaration

  • Optional averageRate?: number

    The average 'rate' value for all reviews made against this organization.

  • Optional averageSubRates?: Record<string, number>

    The average value for all 'subRates' for all reviews made against this user.

  • Optional totalCount?: number

    The total number of reviews made against this organization.

size: string

Scope of the organization (employee count)

status: "cancelled" | "normal" | "restricted" | "prohibited"

Current organization status

typeId: string

Type of the organization

url: string

The URL of the organization's website

Organization users

Generated using TypeDoc