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

Enumeration methods are called without parameters. The response contains an array of items with the fields ID, NAME, SYMBOL_CODE, and SYMBOL_CODE_SHORT — their description is returned by the method crm.enum.fields. The method crm.enum.getorderownertypes uses a different format: the fields id, name, code, and attribute.

Pass the identifier you receive to the parameter of the method you requested the enumeration for.

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.*.

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 list of CRM operating modes. Use it to decode the ID value returned by the method crm.settings.mode.get.

Activity EnumerationsActivity Enumerations

Activity enumerations are deprecated and no longer being developed. Current activity types, statuses, and directions are described in the Activities in CRM section.

The group of methods crm.activity.* uses the values of these enumerations:

• Activity. The method crm.enum.activitytype returns activity types for the TYPE_ID parameter
• Status. The method crm.enum.activitystatus returns activity statuses for the STATUS parameter
• Priority. The method crm.enum.activitypriority returns activity priorities for the PRIORITY parameter
• Direction. The method crm.enum.activitydirection returns activity directions for the DIRECTION parameter
• Notification. The method crm.enum.activitynotifytype returns notification types for the NOTIFY_TYPE parameter
• Description Type. The method crm.enum.contenttype returns description types for the DESCRIPTION_TYPE parameter

Overview of MethodsOverview of Methods

Scope: crm

Who can perform methods: any user

Method	Description
crm.enum.fields	Returns descriptions of the fields of enumeration items
crm.enum.getorderownertypes	Returns identifiers of object types to which order binding is available
crm.enum.ownertype	Returns object types in CRM
crm.enum.addresstype	Returns types of addresses
crm.enum.settings.mode	Returns descriptions of CRM operating modes

Deprecated MethodsDeprecated Methods

The methods below are no longer being developed.

Method	Description
crm.enum.activitytype	Returns enumeration items "Activity Types"
crm.enum.activitydirection	Returns enumeration items "Activity Direction" for e-mails and calls
crm.enum.activitypriority	Returns enumeration items "Activity Priorities"
crm.enum.activitynotifytype	Returns enumeration items "Notification Type for Activity Start" for meetings and calls
crm.enum.contenttype	Returns enumeration items "Description Type"
crm.enum.activitystatus	Returns enumeration items "Status"