Enumerations: Overview of Methods

Enumeration methods return information about the values of types: address type, activity type, object type, and others.

Quick navigation: all methods

How to Work with Enumeration MethodsHow to Work with Enumeration Methods

Determine what data you need and select the enumeration method. For example, if you need to retrieve all legal addresses of a contact:

1. use the method crm.enum.addresstype to find out the identifier for the legal address type

2. use the obtained identifier in the TYPE_ID filter parameter in the method crm.address.list

Relationship of Enumeration Methods with CRM ObjectsRelationship of Enumeration Methods with CRM Objects

CRM Object. The method crm.enum.ownertype returns identifiers for object types. Use the ID of the object type in the entityTypeId parameter value of the methods crm.item.*, crm.activity.*.

Order. The method crm.enum.getorderownertypes returns object types to which an order can be linked. Use the id of the object type in the ownerTypeId parameter value of the methods crm.orderentity.*.

Description Type. The method crm.enum.contenttype returns types of descriptions. Use the ID of the description type in the DESCRIPTION_TYPE parameter value of the methods crm.activity.*.

Activity. The method crm.enum.activitytype returns types of activities. Use the ID of the activity type in the TYPE_ID parameter value of the methods crm.activity.*.

Status. The method crm.enum.activitystatus returns types of activity statuses. Use the ID of the activity status in the STATUS parameter value of the methods crm.activity.*.

Priority. The method crm.enum.activitypriority returns types of activity priorities. Use the ID of the priority in the PRIORITY parameter value of the methods crm.activity.*.

Direction. The method crm.enum.activitydirection returns types of activity directions. Use the ID of the direction in the DIRECTION parameter value of the methods crm.activity.*.

Notification. The method crm.enum.activitynotifytype returns types of notifications for activities. Use the ID of the notification type in the NOTIFY_TYPE parameter value of the methods crm.activity.*.

Address. The method crm.enum.addresstype returns types of addresses. Use the ID of the address type in the TYPE_ID parameter value of the methods crm.address.*.

CRM Operating Mode. The method crm.enum.settings.mode returns the type of CRM. Use this method to decode the ID type value returned by the method crm.settings.mode.get.

Overview of MethodsOverview of Methods

Scope: crm

Who can perform methods: depending on the method

Method	Description
crm.enum.fields	Returns descriptions of enumeration fields
crm.enum.ownertype	Returns object types in CRM
crm.enum.getorderownertypes	Returns identifiers of object types to which order binding is available
crm.enum.addresstype	Returns types of addresses
crm.enum.settings.mode	Returns descriptions of CRM operating modes
crm.enum.activitytype	Returns enumeration items "Activity Types"
crm.enum.activitypriority	Returns enumeration items "Activity Priorities"
crm.enum.contenttype	Returns enumeration items "Description Type"
crm.enum.activitydirection	Returns enumeration items "Activity Direction" for emails and calls
crm.enum.activitynotifytype	Returns enumeration items "Notification Type for Activity Start" for meetings and calls
crm.enum.activitystatus	Returns enumeration items "Status"