Name | Type/Value | Range/Length | Description |
ID | number | positive integer | Optional. A valid ID for an individual, must be set in a modify() call |
uName | string | 1-31 characters | Optional. The unique name of the individual. Used in Whitebeam tags to implement access control functions |
name | string | 0-240 characters | Optional. A general text field that normally holds the name of the individual. |
parent | number | poitive integer | Optional. Read only field, setting this field in a modify or create has no effect. The valid ID of the parent Individual, or 0 (root) to indicate that the Individual has no parent |
phone | string | 0 - 32 characters | Optional. Phone number as ASCII digits |
fax | string | 0 - 32 characters | Optional. Fax number as ASCII digits |
description | string | 0-240 characters | Optional. A general text field that normally holds the description of the contact object |
email | string | 0 - 240 characters | Optional. Email address |
customData | MetaData | 0-200K characters total object size | Optional. storage for formatted JavaScript objects |
type | string | 'INDIVIDUAL' | 'OU' | 'COMMUNITY' | Optional. The type of this entity |
memberOf | array of numbers | | Optional. Array of contact_ids for which this record is a member. Only returned if bit 2 of allData is set. eg (allData & 4)==4 |
relevance | number | positive integer | Optional. Read only field. Returned as part of iterator search for keyword relevance. Returns number of keywords matched by this record |
parentName | string | 0-240 characters | Optional. The name field for the parent of an individual or OU. If no parent (or a community) this field will be null . |
value | number | integer | Optional. Arbitrary field value. Most useful for creating a weighted search order within a result set. |
keywords | string | | Optional. Plain text field intended to store search words or stemmed search words |
location | struct location | see definition | Optional. Optional longitude and latitude for this contact. Available from version : 1.3.4 |
distance | number | | Optional. Returned if allData requests distance data AND a search location/radius was specified Available from version : 1.3.4 |
password | string | | Optional. The hashed value for the stored password. This is return if bit 7 of the allData field is set. Available from version : 1.3.9 |
modifiedTime | date | JavaScript Date object | Optional.
The date/time at which this contact record was last changed. This field is usually
automatically updated by the system on create/modify requests. This behaviour can be
over-ridden by the modifyTimestamp flag.
Available from version : 1.3.12 |
modifyTimestamp | bool | | Optional. This flag is used as follows: - If this flag is missing (not specified) the creating or modifying a contact record will
cause the modifiedTime to be set to the current date/time.
- If bit 1 is set then the modifiedTime flag will not be changed for modify requests
Other bits are reserved for future features and should be left 0. Available from version : 1.3.12 |
dateTime | date | JavaScript Date object | Optional.
An arbitrary date/time value that can store an application specific date (eg a date of birth). The result set can be constrained to a date
range by specifying minDateTime and maxDateTime in the search request.
Available from version : 1.3.28 |