Organization UEI

← Back to Question Bank

Details

Form

Sample version of the rendered form.

Unique Entity Identifier (UEI)*

Data

Form Data

What the form data looks like when it is submitted.

{
  "uei": "AB1234567890"
}

CommonGrants Data

What the data looks like translated to the CommonGrants data model using the mapping-to-cg.

{
  "organizations": {
    "primary": {
      "uei": "AB1234567890"
    }
  }
}

Schemas

JSON Schema

Provides the structure and data validation for this question.

$id: QuestionOrgUei.yaml
type: object
required:
  - uei
unevaluatedProperties:
  not: {}
examples:
  - uei: AB1234567890
description: The Unique Entity Identifier (UEI) for the applicant organization
x-ui-schema:
  type: VerticalLayout
  elements:
    - type: Control
      scope: '#/properties/uei'
      label: Unique Entity Identifier (UEI)
x-mapping-to-cg:
  organizations:
    primary:
      uei:
        field: uei
x-mapping-from-cg:
  uei:
    field: organizations.primary.uei
x-entity:
  - primaryOrg
x-tags:
  - organization
  - identifier
properties:
  uei:
    description: The organization's Unique Entity Identifier from SAM.gov
    $schema: https://json-schema.org/draft/2020-12/schema
    $id: samUEI.yaml
    type: string
    examples:
      - 12ABC34DEF56
    pattern: ^[A-z0-9]{12}$

UI Schema

Describes how to present the question in the form UI.

{
  "type": "VerticalLayout",
  "elements": [
    {
      "type": "Control",
      "scope": "#/properties/uei",
      "label": "Unique Entity Identifier (UEI)"
    }
  ]
}

Mappings

Mapping to CommonGrants

How to translate this question into the CommonGrants ProposalBase data model.

{
  "organizations": {
    "primary": {
      "uei": {
        "field": "uei"
      }
    }
  }
}

Mapping from CommonGrants

How to pre-fill this question with data from the ProposalBase data model.

{
  "uei": {
    "field": "organizations.primary.uei"
  }
}