Identifiers

0.3.0 release

Welcome to the Open Fibre Data Standard 0.3.0 release.

We want to hear your feedback on the standard and its documentation. For general feedback, questions and suggestions, you can comment on an existing discussion or start a new one. For bug reports or feedback on specific elements of the data model and documentation, you can comment on the issues in the issue tracker or you can create a new issue.

To comment on or create discussions and issues, you need to sign up for a free GitHub account. If you prefer to provide feedback privately, you can email info@opentelecomdata.net.

In OFDS, there are two types of identifier: global identifiers and local identifiers.

Global identifiers

The following identifiers are globally unique:

Network identifier
Organisation identifiers

Network identifier

To ensure that a network’s .id is globally unique, it must be a universally unique identifier as defined by RFC 4122.

Network identifiers should be consistent across each version of the data about a network.

For more information, see how to generate universally unique identifiers.

Organisation identifiers

To ensure that an organisation’s .identifier is globally unique, it has two components:

Schema

Title	Description	Type
`identifier/id`		string
Identifier	The identifier assigned to the organisation in the register identified in `.scheme`.
`identifier/scheme`		string
Scheme	The register from which the identifier in `.id` is drawn, from the open organisationIdentifierScheme codelist.

Example

The following example shows the .identifier for an organisation registered at Ghana’s Registrar General’s Department, the scheme code for which is GH-RGD:

{
    "id": "CS111111111",
    "scheme": "GH-RGD",
    "legalName": "FibreCo Ghana Limited",
    "uri": "https://example.com/companies/CS111111111"
}

The .identifier.scheme field ensures that the identifier is globally unique, even if the same identifier appears in more than one scheme.

Local identifiers

Most identifiers in OFDS only need to be unique among the identifiers used for the same type of object within the same scope. For example, node identifiers only need to be unique with the scope of the .nodes array. Uniqueness constraints are specified in the description of each identifier.

Some local identifiers are used for cross-referencing. For example, an organisation’s .id is a local identifier used for cross-referencing from fields such as Node.physicalInfrastructureProvider.id.