AnnotatedString

  • AnnotatedString is used for character strings and adds an optional annotation of up to 16 characters.

  • The annotation attribute is optional, of type ShortString, and provides an annotation for a character string.

  • Examples are provided for using AnnotatedString with Email, Fax, and Phone in both XML and JSON formats.

Use AnnotatedString for character strings. It adds an annotation of up to 16 characters to an element.

Attributes

The following table describes the attributes for AnnotatedString:

Attribute Required? Type Description
annotation Optional ShortString An annotation of up to 16 characters that's associated with a character string.

Examples

Email

XML

    <Email annotation="work">john.a.smith@26003.org</Email>

JSON

    "Email": [
      {
        "annotation": "work",
        "value": "john.a.smith@26003.org"
      }
    ]

Fax

XML

    <Fax annotation="cell">304-555-0971</Fax>

JSON

    "Fax": [
      {
        "annotation": "cell",
        "value": "304-555-0971"
      }
    ]

Phone

XML

    <Phone annotation="office">304-555-1234</Phone>

JSON

    "Phone": [
      {
        "annotation": "office",
        "value": "304-555-1234"
      }
    ]