Skip to content

Agency Scheme

An Agency Scheme is an organisation scheme whose items are the Agencies that maintain structures. The scheme always has the fixed id AGENCIES and version 1.0; the owning agency of the scheme is the parent of its agencies (for example IMF.STA maintains the agencies IMF.STA.xxx). Documents start ref: "AgencyScheme=AGENCY:AGENCIES(1.0)".

The Agency Scheme shares its layout with the Data Consumer Scheme, Data Provider Scheme, Metadata Provider Scheme and, with one extra field, the Organisation Unit Scheme. Contacts are described in full on this page.

Simple form

An agency with an English name only, and no contacts, is written as ID: "name".

format: "fusion-yaml(1.0.0)"
ref: "AgencyScheme=SDMX:AGENCIES(1.0)"
name: "TEST"
items:
- BIS: "Bank for International Settlements"
- ECB: "European Central Bank"
- ESTAT: "Eurostat"
- IMF: "International Monetary Fund"
Source: agencyscheme/testSdmxScheme.yaml (trimmed)

The document starts with the common header. The body is:

  • items: the agencies, in scheme order, written as described in Items.

Complex form

An agency becomes an object when it has contacts, as well as for the usual reasons (a description, a non-English name, a uri, annotations or links).

format: "fusion-yaml(1.0.0)"
ref: "AgencyScheme=IMF.STA:AGENCIES(1.0)"
name: "TEST"
items:
- HR:
    name: "HR"
    contacts:
    - name: "Alexie Plexie"
      role: "Human Reources"
      role-fr: "Reources Le Human"
      department: "HR"
      department-fr: "Le HR"
      email: "hr@gmail.com"
      phone:
      - "+44 1234 888777"
      - "01234 412345"
      fax: "+44 123 333444"
      uri: "https://acy.org/contact/hr"
- IT:
    name: "IT"
    description: "In the basement"
- STATISTICS: "STATISTICS"
- MANAGEMENT: "MANAGEMENT"
Source: agencyscheme/testContactUri.yaml

  • HR has a contact, so it is an object holding name and contacts.
  • IT has a description, so it is an object holding name and description.
  • STATISTICS and MANAGEMENT have only an English name, so they stay in the simple form.

Contacts

contacts is an array of contact objects, in the order held by the organisation. Contacts have no id key; each array entry is a plain object. All contact fields are optional and are written in this order:

Field Value Written when
id String The contact has an id.
name, name-xx Localised text The contact has the name.
role, role-xx Localised text The contact has the role.
department, department-xx Localised text The contact has the department.
email Value or array of strings The contact has at least one email address.
phone Value or array of strings The contact has at least one telephone number.
fax Value or array of strings The contact has at least one fax number.
x400 Value or array of strings The contact has at least one X.400 address.
uri Value or array of strings The contact has at least one URI.

The contact details (email, phone, fax, x400, uri) follow the value or array rule: one value is written as a string, several as an array, in the order held by the contact.

A contact using every field:

- HR:
    name: "HR"
    contacts:
    - id: "HR_HEAD"
      name: "Alexie Plexie"
      role: "Head of HR"
      department: "HR"
      email: "hr@acy.org"
      phone: "+44 1234 888777"
      fax: "+44 123 333444"
      x400: "G=Alexie;S=Plexie;O=ACY;C=GB"
      uri: "https://acy.org/contact/hr"

Field reference

Field Value Written when
partial true The scheme is partial.
items Array of agencies The scheme has at least one agency.
items[].ID String (the English name), or an object Always, one entry per agency.
items[].ID.name, name-xx Localised text The agency has the name.
items[].ID.description, description-xx Localised text The agency has the description.
items[].ID.uri String The agency has a URI.
items[].ID.contacts Array of contacts The agency has contacts.
items[].ID.annotations Annotations The agency has annotations.
items[].ID.links Links The agency has links.

An agency is written in the simple form when it has exactly one name, in English, no description, no uri, no annotations, no links and no contacts.