AnnotatedString

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

  • The annotation attribute is optional and uses a ShortString type to associate an annotation with a character string.

  • This entity is used consistently across all feed types, such as Email, Fax, and Phone, to provide additional context to the string value.

  • Examples in XML and JSON formats demonstrate how to use AnnotatedString with its annotation attribute for different data types.

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"
      }
    ]