@ts4ocds/core/organization/identifier.ts

TS4OCDS is a library of TypeScript entities that takes an approach to befriend large OCDS JSONs with your per-project routine of writing whole lotta interfaces for them.

/**
 * @packageDocumentation
 * @module Standard.Organization
 */

import { Initializable } from '@ts4ocds/utils';

/**
 * A unique identifier for a party ({@link Organization | organization}).
 */
export class Identifier extends Initializable<Identifier> {
  /**
   * The identifier of the {@link Organization | organization} in the selected scheme.
   */
  public id?: string | number;

  /**
   * {@link Organization} identifiers should be taken from an existing organization identifier list.
   * The scheme field is used to indicate the list or register from which the identifier is taken.
   * This value should be taken
   * from the [Organization Identifier Scheme](https://standard.open-contracting.org/1.1/en/schema/codelists/#organization-identifier-scheme) codelist.
   */
  public scheme?: string;

  /**
   * The legally registered name of the {@link Organization | organization}.
   */
  public legalName?: string;

  /**
   * A URI to identify the {@link Organization | organization}, such as those provided by
   * [Open Corporates](http://www.opencorporates.com) or some other relevant URI provider.
   * This is not for listing the website of the {@link Organization | organization}:
   * that can be done through the {@link ContactPoint.url | URL field} of the Organization contact point.
   */
  public uri?: string;
}