Generic Phone

← Back to Question Bank

Details

Form

Sample version of the rendered form.

Phone Number

Country Code*

Phone Number*

Extension

Is Mobile?

Data

Form Data

What the form data looks like when it is submitted.

{
  "countryCode": "+1",
  "number": "444-456-1230",
  "isMobile": true
}

CommonGrants Data

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

{
  "countryCode": "+1",
  "number": "444-456-1230",
  "isMobile": true
}

Schemas

JSON Schema

Provides the structure and data validation for this question.

$id: QuestionPhone.yaml
type: object
examples:
  - countryCode: '+1'
    number: 444-456-1230
    isMobile: true
  - countryCode: '+1'
    number: 555-123-4567
    extension: '123'
    isMobile: false
description: A generic phone number question
x-ui-schema:
  type: Group
  label: Phone Number
  elements:
    - type: Control
      scope: '#/properties/countryCode'
      label: Country Code
    - type: Control
      scope: '#/properties/number'
      label: Phone Number
    - type: Control
      scope: '#/properties/extension'
      label: Extension
    - type: Control
      scope: '#/properties/isMobile'
      label: Is Mobile?
x-mapping-to-cg:
  countryCode:
    field: countryCode
  number:
    field: number
  extension:
    field: extension
  isMobile:
    field: isMobile
x-mapping-from-cg:
  countryCode:
    field: countryCode
  number:
    field: number
  extension:
    field: extension
  isMobile:
    field: isMobile
x-tags:
  - generic
  - phone
required:
  - countryCode
  - number
properties:
  countryCode:
    type: string
    pattern: ^\+[1-9][0-9]{0,3}$
    description: The international country code (e.g., "+1" for US/Canada).
  number:
    type: string
    description: The local phone number without the country code.
  extension:
    type: string
    description: Optional extension number for the phone line.
  isMobile:
    type: boolean
    default: false
    description: Indicates whether this is a mobile/cell phone number.

UI Schema

Describes how to present the question in the form UI.

{
  "type": "Group",
  "label": "Phone Number",
  "elements": [
    {
      "type": "Control",
      "scope": "#/properties/countryCode",
      "label": "Country Code"
    },
    {
      "type": "Control",
      "scope": "#/properties/number",
      "label": "Phone Number"
    },
    {
      "type": "Control",
      "scope": "#/properties/extension",
      "label": "Extension"
    },
    {
      "type": "Control",
      "scope": "#/properties/isMobile",
      "label": "Is Mobile?"
    }
  ]
}

Mappings

Mapping to CommonGrants

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

{
  "countryCode": {
    "field": "countryCode"
  },
  "number": {
    "field": "number"
  },
  "extension": {
    "field": "extension"
  },
  "isMobile": {
    "field": "isMobile"
  }
}

Mapping from CommonGrants

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

{
  "countryCode": {
    "field": "countryCode"
  },
  "number": {
    "field": "number"
  },
  "extension": {
    "field": "extension"
  },
  "isMobile": {
    "field": "isMobile"
  }
}