Contact

The contact resource is based on a vCard contact and contains a subset of its properties. The “Address” structure represents an address of organization or individual.

Schema of the Contact type: download

{
   "apsVersion": "2.0",

   "name": "Contact",

   "id": "http://aps-standard.org/types/core/contact/1.2",

   "properties": {
      "email": {
         "type": "string",
         "format": "email"
      },
      "notificationEmail": {
         "type": "string",
         "format": "email"
      },
      "givenName": {
         "type": "string" 
      },
      "additionalName": {
         "type": "string" 
      },
      "familyName": {
         "type": "string" 
      },
      "fullName": {
         "type": "string" 
      },
      "displayName": {
         "type": "string",
         "default": "" 
      },
      "organizationName": {
         "type": "string"
      },
      "organizationUnit": {
         "type": "array",
         "items": {
            "type":"string"
         }
      },
      "title": {
         "type": "string"
      },
      "addressPostal": {
         "type": "Address"
      },
               
      "telVoice": {
         "type": "string"
      },
      "telHome": {
         "type": "string"
      },
      "telWork": {
         "type": "string"
      },
      "telCell": {
         "type": "string"
      },
      "telFax": {
         "type": "string"
      },
      "telPager": {
         "type": "string"
      },
               
      "tz": {
         "type": "string"
      },
      "note": {
         "type": "string"
      },    
      "url": {
         "type": "string"
      },
      "avatarUrl": {
         "type": "string",
         "readonly": true
      },
      "locale": {
         "type": "string",
         "default": "en_US"
      }
   },
   
   "structures": {
      "Address": {
         "type": "object",
         
         "properties": {
            "postOfficeBox": {
               "type": "string"
            },
            "extendedAddress": {
               "type": "string"
            },
            "streetAddress": {
               "type": "string"
            },
            "locality": {
               "type": "string"
            },
            "region": {
               "type": "string"
            },
            "postalCode": {
               "type": "string"
            },
            "countryName": {
               "type": "string"
            }     
         }
      }
   }
}

The properties inside the Address structure are filled according to HCARD-PROFILE and HCARD.

The properties of the Contact type are filled according to the classes defined in HCARD-PROFILE. The other properties are explained below:

Property	Description
avatarUrl	URL of an image file containing the user photo. The user or the customer administrator can upload a user photo using the control panel. Once this is done, the system will assign the URL of the uploaded image to the property as in this example: “avatarUrl”: “/user-photos/dd9cf660-493b-4ddb-b970-0930ad766fb5/1455789933769”
displayName	Any descriptive name of the contact, for example, the full name or nick name.
fullName	The full name of a contact as defined by the fn class in HCARD-PROFILE. If any of the “givenName”, “familyName” or “additionalName” properties is defined, the “fullName” property must be defined as well.
notificationEmail	An email address for receiving notifications. This is used if the user needs to receive notifications from the platform at a different address to their main email address (the email property) used for authentication.

Note

All phone number properties with the name prefix tel, except for telVoice, must comply with the number structure for geographic area as specified by the ITU-T E.164 standard:

<country code>#<national destination code>#<subscriber number>#<ext>

The telVoice property can be of any format.

← Application

User →