Profile Extension Schema

Purpose: Describes a type of extension available for the customer profiles.

Description

Describes one of the Profile Extension resources. Before your application can start adding extensions to a given profile, your application must define this extension's schema, which includes its nested attributes.

Resource

Field	Type	Mandatory	Description
name	string	yes	The unique, case-insensitive name of the extension. The name must start with a letter, and can be followed with letters, numbers, or underscores. The name is restricted to a maximum of 26 characters (Maximum RDBMS shared limit on creation of index).
type	token	yes	Extensions come in the following forms: Single-valued: a single extension record is associated with a given customer. Multi-valued: multiple extension records can be associated with any given customer. Classifier: the single-valued extension has no attribute. Only single-valued profile extensions are supported for now.
attributes	array	no	The array of zero or more attribute objects. Empty when type="classifier".

Example

The following schema describes the Address extension.

  "name":"Address",
  "type":"single-valued",    
  "attributes": [
      {"name":"AddressType","type":"integer","default":0},
      {"name":"Address","type":"string","length":256},
      {"name":"City","type":"string","length":32},
      {"name":"County","type":"string","length":32},
      {"name":"PostCode","type":"string", "length":10},
      {"name":"Country","type":"string","length":32}
      ]

Related Operations

• Create Profile Extension Schema
• Query Profile Extensions Schema