Contact (contact)

Description

Address book contact.
Used in applications and services that regularly communicate with the same set of subscribers: selective meetings, alerts, etc.
Can be synchronized with LDAP in scheduled scripts.

Limitations

  • The collection is available only in working domains.

Fields

Entity structure
{
  "id": uuid,
  "autokey": int,
  "displayname": str,
  "department": str,
  "jobtitle": str,
  "number": str,
  "numlocal": str,
  "numpublic": str,
  "mobile": str,
  "mobile2": str,
  "mobile3": str,
  "roomnum": str,
  "roomnum2": str,
  "roomnum3": str,
  "email": str,
  "email2": str,
  "email3": str,
  "photo": str,
  "opts": {
    "title": str,
    "comment": str,
    "groups": array<str>,
    "priority": int | null
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}
Table 1. Fields
Specification Description

Field: id
Mode: inout
Type: uuid
Default: generated

Identifier. Can be specified at creation, otherwise generated by the system.

Field: autokey
Mode: out
Type: int
Default: generated

Sequence number. Generated automatically and is the key field used for linking. Cannot be changed. At entity creation it must be absent or equal to -1. Used to associate with other entities.

Field: displayname
Mode: in
Type: str
Default: required

Display name

Field: department
Mode: in
Type: str
Default: empty

Department.
Not used by the system. For storage and project use only.

Field: jobtitle
Mode: in
Type: str
Default: empty

Job title.
Not used by the system. For storage and project use only.

Field: number
Mode: in
Type: str
Default: required

Primary phone number.

Field: numlocal
Mode: in
Type: str
Default: empty

Additional phone number (internal).
Not used by the system. For storage and project use only.

Field: numpublic
Mode: in
Type: str
Default: empty

Additional phone number (external).
Not used by the system. For storage and project use only.

Field: mobile
Mode: in
Type: str
Default: empty

Primary mobile phone number.
Not used by the system. For storage and project use only.

Field: mobile2
Mode: in
Type: str
Default: empty

Additional mobile phone number 2.
Not used by the system. For storage and project use only.

Field: mobile3
Mode: in
Type: str
Default: empty

Additional mobile phone number 3.
Not used by the system. For storage and project use only.

Field: roomnum
Mode: in
Type: str
Default: empty

Reserved conference room number.
Not used by the system. For storage and project use only.

Field: roomnum2
Mode: in
Type: str
Default: empty

Reserved conference room number 2.
Not used by the system. For storage and project use only.

Field: roomnum3
Mode: in
Type: str
Default: empty

Reserved conference room number 3.
Not used by the system. For storage and project use only.

Field: email
Mode: in
Type: str
Default: empty

Primary email mailbox.
Not used by the system. For storage and project use only.

Field: email2
Mode: in
Type: str
Default: empty

Additional email mailbox.
Not used by the system. For storage and project use only.

Field: email3
Mode: in
Type: str
Default: empty

Additional email mailbox.
Not used by the system. For storage and project use only.

Field: photo
Mode: in
Type: str
Default: empty

Photo.
Not used by the system. For storage and project use only.

Field: opts
Mode: in
Type: object
Compound field

Field: opts.title
Mode: in
Type: str
Default: empty

Arbitrary title

Field: opts.comment
Mode: in
Type: str
Default: empty

Arbitrary comment

Field: opts.groups
Mode: inout
Type: array<str>
Default: empty

Codes of contact groups (the code field) that include this contact. Automatically linked with the corresponding group field and can be changed by the system.

Field: opts.priority
Mode: in
Type: int | null
Default: null

Personal contact priority used when building the alert list. Synchronized with group priorities.

Field: ext
Mode: inout
Type: object
Compound field

Allows extending the compound with arbitrary keys and values

Field: ext.ct
Mode: out
Type: date
Default: generated

Object creation time

Field: ext.lwt
Mode: out
Type: date
Default: generated

Time of last modification of the object

See also

Logical roles

  • mdc and sdc store contacts.

  • svc synchronizes contacts with LDAP using scripts.