Phone

A phone number.

Table

Property	Type	Required	Description
countryCode	string	Yes	The international country code (e.g., "+1" for US/Canada).
number	string	Yes	The local phone number without the country code.
extension	string	No	Optional extension number for the phone line.
isMobile	boolean	No	Indicates whether this is a mobile/cell phone number.

Formats

Example

A JSON example of this model.

{
  "countryCode": "+1",
  "number": "555-123-4567",
  "extension": "123",
  "isMobile": false
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: Phone.yaml
type: object
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.
required:
  - countryCode
  - number
unevaluatedProperties:
  not: {}
examples:
  - countryCode: "+1"
    number: 555-123-4567
    extension: "123"
    isMobile: false
  - countryCode: "+1"
    number: 444-456-1230
    isMobile: true
description: A phone number.

TypeSpec

The TypeSpec code for this model.

/** A phone number. */
@example(Examples.Phone.mobile)
@example(Examples.Phone.withExtension)
@Versioning.added(CommonGrants.Versions.v0_2)
model Phone {
  /** The international country code (e.g., "+1" for US/Canada). */
  @pattern("^\\+[1-9][0-9]{0,3}$")
  countryCode: string;

  /** The local phone number without the country code. */
  number: string;

  /** Optional extension number for the phone line. */
  extension?: string;

  /** Indicates whether this is a mobile/cell phone number. */
  isMobile?: boolean = false;
}

Changelog

Version	Changes	Schema
0.2.0	Added Phone model	Phone.yaml

PhoneCollection

A collection of phone numbers for a person or organization.

Table

Property	Type	Required	Description
primary	Phone	Yes	The person's primary phone number.
fax	Phone	No	The person's fax number, if applicable.
otherPhones	record<Phone>	No	Additional phone numbers not covered by the standard fields.

Formats

Example

A JSON example of this model.

{
  "primary": {
    "countryCode": "+1",
    "number": "444-456-1230",
    "isMobile": true
  },
  "fax": {
    "countryCode": "+1",
    "number": "555-123-4567",
    "extension": "123",
    "isMobile": false
  },
  "otherPhones": {
    "support": {
      "countryCode": "+1",
      "number": "333-456-1230",
      "isMobile": false
    },
    "marketing": {
      "countryCode": "+1",
      "number": "444-456-1230",
      "isMobile": true
    }
  }
}

JSON Schema

The JSON Schema for this model.

$schema: https://json-schema.org/draft/2020-12/schema
$id: PhoneCollection.yaml
type: object
properties:
  primary:
    $ref: Phone.yaml
    description: The person's primary phone number.
  fax:
    $ref: Phone.yaml
    description: The person's fax number, if applicable.
  otherPhones:
    $ref: "#/$defs/RecordPhone"
    description: Additional phone numbers not covered by the standard fields.
required:
  - primary
unevaluatedProperties:
  not: {}
examples:
  - primary:
      countryCode: "+1"
      number: 444-456-1230
      isMobile: true
    fax:
      countryCode: "+1"
      number: 555-123-4567
      extension: "123"
      isMobile: false
    otherPhones:
      support:
        countryCode: "+1"
        number: 333-456-1230
        isMobile: false
      marketing:
        countryCode: "+1"
        number: 444-456-1230
        isMobile: true
  - primary:
      countryCode: "+1"
      number: 444-456-1230
      isMobile: true
    otherPhones:
      home:
        countryCode: "+1"
        number: 333-456-1230
        isMobile: false
description: A collection of phone numbers for a person.
$defs:
  RecordPhone:
    type: object
    properties: {}
    unevaluatedProperties:
      $ref: Phone.yaml

TypeSpec

The TypeSpec code for this model.

/** A collection of phone numbers for a person. */
@example(Examples.Phone.personalCollection)
@example(Examples.Phone.orgCollection)
@Versioning.added(CommonGrants.Versions.v0_2)
model PhoneCollection {
  /** The person's primary phone number. */
  primary: Fields.Phone;

  /** The person's fax number, if applicable. */
  fax?: Fields.Phone;

  /** Additional phone numbers not covered by the standard fields. */
  otherPhones?: Record<Fields.Phone>;
}

Changelog

Version	Changes	Schema
0.2.0	Added PhoneCollection model	PhoneCollection.yaml