DCAT-US 3.0: Agents

Agents

Data information classes including Agent, Organization, and Kind, which describe organizations, people, and contact information.

Class Agent #

A person, organization, software agent, or other entity involved with a resource

  • Type: object
  • Additional properties: Any type allowed

Example:

{
    "@type": "Agent",
    "name": "National Climate Data Center",
    "category": [
        "https://example.gov/concepts/federal-agency"
    ]
}
Property Type Requirement Level Title/Description
name string Mandatory The name of the agent
@id string Optional  
@type string Optional  
category null or array of Concept classes Optional The type of the agent that makes the item available

Agent > name #

Requirement: Mandatory

The name of the agent

  • Type: string
  • Required: Yes

Examples:

"National Climate Data Center"
"U.S. Department of Commerce Data Stewardship Office"

Agent > @id #

Requirement: Optional

  • Type: string
  • Format: iri

Example:

"https://example.gov/agents/data-steward-001"

Agent > @type #

Requirement: Optional

  • Type: string
  • Default: "Agent"

Agent > category #

Requirement: Optional

The type of the agent that makes the item available

  • Type: null or array of Concept classes

Each item of this array must be:

  • Concept: A controlled term or label, optionally drawn from a concept scheme

Class Organization #

An organization involved with a resource, including parent or child organizations

  • Type: object
  • Additional properties: Any type allowed

Examples:

{
    "@type": "Organization",
    "name": "National Climate Data Center",
    "altLabel": "NCDC"
}
{
    "@id": "https://example.gov/organizations/census-bureau",
    "@type": "Organization",
    "name": "U.S. Census Bureau",
    "prefLabel": "United States Census Bureau",
    "altLabel": "Census Bureau",
    "notation": [
        "USCB",
        "CB"
    ],
    "subOrganizationOf": [
        {
            "@id": "https://example.gov/organizations/doc",
            "@type": "Organization",
            "name": "U.S. Department of Commerce"
        }
    ]
}
Property Type Requirement Level Title/Description
name string Mandatory The full name of the Organization
@id string Optional  
@type string Optional  
altLabel null or string Optional alternative name (trading name, colloquial name) for an organization
notation null or array of string Optional List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD)
prefLabel null or string Optional Preferred or legal name of the organization
subOrganizationOf null or array of Organization classes Optional Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization

Organization > name #

Requirement: Mandatory

The full name of the Organization

  • Type: string
  • Required: Yes

Examples:

"National Climate Data Center"
"U.S. Census Bureau"

Organization > @id #

Requirement: Optional

  • Type: string
  • Format: iri

Example:

"https://example.gov/organizations/census-bureau"

Organization > @type #

Requirement: Optional

  • Type: string
  • Default: "Organization"

Organization > altLabel #

Title: alternative label

Requirement: Optional

alternative name (trading name, colloquial name) for an organization

  • Type: null or string

Examples:

"NCDC"
"Census Bureau"

Organization > notation #

Requirement: Optional

List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD)

  • Type: null or array of string

Example:

[
    "USCB",
    "CB"
]

Each item of this array must be:

Abbreviation #

  • Type: string

Organization > prefLabel #

Title: preferred label

Requirement: Optional

Preferred or legal name of the organization

  • Type: null or string

Example:

"United States Census Bureau"

Organization > subOrganizationOf #

Requirement: Optional

Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization

Each item of this array must be:

  • Organization: An organization involved with a resource, including parent or child organizations

Class Kind #

Contact information for an individual or entity

  • Type: object
  • Additional properties: Any type allowed

Examples:

{
    "@type": "Kind",
    "fn": "Climate Data Support Team",
    "hasEmail": "mailto:climate-support@example.gov",
    "organization-name": "National Climate Data Center",
    "tel": "+1-555-123-4567"
}
{
    "@type": "Kind",
    "fn": "Dr. Jane Smith",
    "hasEmail": "mailto:jane.smith@example.gov"
}
Property Type Requirement Level Title/Description
fn string Mandatory The formatted text of the name of the contact
hasEmail string Mandatory Email address for the contact in mailto: format (for example, mailto:support@example.gov)
@id string Optional  
@type string Optional  
address null or array of Address classes Optional The address of the contact
family-name null or string Optional The family name of the contact
given-name null or string Optional The given name of the contact
organization-name null or string Optional The name of the organization to contact
tel null or string Optional The telephone number for the contact
title null or string Optional The position role of the person to contact

Kind > fn #

Title: formatted name

Requirement: Mandatory

The formatted text of the name of the contact

  • Type: string
  • Required: Yes

Examples:

"Climate Data Support Team"
"Dr. Jane Smith"

Kind > hasEmail #

Title: Email

Requirement: Mandatory

Email address for the contact in mailto: format (for example, mailto:support@example.gov)

  • Type: string
  • Required: Yes

Examples:

"mailto:climate-support@example.gov"
"mailto:jane.smith@example.gov"

Restrictions:

  • Must match regular expression: ^mailto:[\w\_\~\!\$\&\'\(\)\*\+\,\;\=\:.-]+@[\w.-]+\.[\w.-]+?$ Test

Kind > @id #

Requirement: Optional

  • Type: string
  • Format: iri

Example:

"https://example.gov/contacts/climate-support-001"

Kind > @type #

Requirement: Optional

  • Type: string
  • Default: "Kind"

Kind > address #

Requirement: Optional

The address of the contact

  • Type: null or array of Address classes

Each item of this array must be:

  • Address: A single physical address

Kind > family-name #

Requirement: Optional

The family name of the contact

  • Type: null or string

Example:

"Smith"

Kind > given-name #

Requirement: Optional

The given name of the contact

  • Type: null or string

Example:

"Jane"

Kind > organization-name #

Requirement: Optional

The name of the organization to contact

  • Type: null or string

Example:

"National Climate Data Center"

Kind > tel #

Title: telephone

Requirement: Optional

The telephone number for the contact

  • Type: null or string

Example:

"+1-555-123-4567"

Kind > title #

Title: position title

Requirement: Optional

The position role of the person to contact

  • Type: null or string

Example:

"Senior Climate Data Scientist"