Dynamics CRM API

Connects to Dynamics CRM service.

Closes the connection to Dynamics CRM service. Use always after you finish working with the service.

Returns true if connected to the service.

Get specific Dynamics CRM web service. These are the method parameters:

• service (int) - service type. It can be one of the options listed in the following table.

  Value	Result Service
  0	CRM 2011 - returns service class from CozyRoc.Dynamics.Crm2011.OrganizationService namespace CRM 4.0 - returns CrmService class from CozyRoc.Dynamics.Crm.Service namespace. CRM 3.0 - returns service class from CozyRoc.Dynamics.Crm3.Service namespace.
  1	CRM 2011 - Not available. CRM 4.0 - returns MetadataService class from CozyRoc.Dynamics.Crm.MetadataService namespace. CRM 3.0 - returns service class from CozyRoc.Dynamics.Crm3.MetadataService namespace.
  2	CRM 2011 - returns service class from CozyRoc.Dynamics.Crm2011.DiscoveryService namespace. CRM 4.0 - returns CrmDiscoveryService class from CozyRoc.Dynamics.Crm.DiscoveryService namespace. CRM 3.0 - Not available.

Gets organizations list.

Gets entities list with specific privilege. These are the method parameters:

• privilege (int) - entity privilege. It can be one of the options listed in the following table.

  Value	Description
  0	Privilege unspecified. All entities will be returned.
  1	Return entities, which permit record creation.
  2	Return entities, which can be read.
  3	Return entities, which can be updated.
  4	Return entities, which permit record removal.

Query Dynamics CRM service. The method returns XML string with the result of the query. These are the method parameters:

• fetchXML (string) FetchXML query statement.

DEPRECATED: Use IEntity.GetAttributes method instead.

Get entity attributes. The method returns array of IAttribute objects. These are the method parameters:

• entity (string) - entity name.

Get attributes specified in query. The method returns array of IAttribute objects. These are the method parameters:

• fetchXML (string) - FetchXML query statement.

DEPRECATED: Use GetEntity method instead.

Construct object, which will be used to manipulate entity. The method returns ICrmEntity object. These are the method parameters:

• name (string) - entity name.

DEPRECATED: Use IEntity interface instead.

Creates record in entity. The method returns string with identifier of the created record. These are the method parameters:

• entity (ICrmEntity) - object with create data.
• ignoreMissingId - specify to ignore attributes referencing missing data.
• detectDuplicate - specify to enable duplicate detection rule.

DEPRECATED: Use IEntity interface instead.

Updates existing record in entity. These are the method parameters:

• entity (ICrmEntity) - object with update data.
• ignoreMissingId - specify to ignore attributes referencing missing data.
• detectDuplicate - specify to enable duplicate detection rule.

DEPRECATED: Use IEntity interface instead.

Deletes record in entity. These are the method parameters:

• entity (ICrmEntity) - object with delete data.

DEPRECATED: Use IEntity interface instead.

Update and insert a record in destination entity. These are the method parameters:

• entity (ICrmEntity) - object with update data.
• ignoreMissingId - specify to ignore attributes referencing missing data.

Get object used to manage Dynamics CRM entity. The method returns IEntity object. These are the method parameters:

• name (string) - entity name.

Specify deployment type. This property has the options listed in the following table.

Specify the name or IP address of the Dynamics CRM server.

Specify user name to access the Dynamics CRM service.

Specify user password to access the Dynamics CRM service.

Specify organization name. Note: Not available in CRM 3.0

Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.

Specify if all clients should use the same connection. This property has the options listed in the following table.

Specify the name or IP address of the proxy server.

Specify the port number on the proxy server to use for the connection.

Specify user name to access the proxy server.

Specify password to access the proxy server.

Returns attribute name.

Returns true if attribute can be read.

Returns true if attribute can be specified for record creation.

Returns true if attribute can be specified for record update.

Returns true if attribute is primary key.

Returns SSIS attribute type.

Returns attribute entity reference if attribute is lookup.

Returns internal AttributeMetadata object.

Returns attribute type. It can be one of the options listed in the following table.

Returns attribute length.

Returns attribute precision.

Returns attribute scale.

Adds attribute. The method returns the index of the newly inserted attribute. These are the method parameters:

• name (string) - attribute name.
• attributeType (int) - attribute type. For valid values check CrmType property in IAttribute interface.
• reference (string) - entity reference. Only used when dealing with lookup attributes.

Return count of attributes.

Sets attribute value. These are the method parameters:

• index (int) - attribute index.
• value (object) - attribute value.

Returns attribute value. These are the method parameters:

• index (int) - attribute index.

Constructs DynamicEntity object.

Returns the entity name this object is associated with.

Get entity attributes. The method returns array of IAttribute objects.

Constructs new Dynamics CRM entity data instance.

Sets attribute value in entity instance. These are the method parameters:

• entity (object) - entity instance.
• name (string) - attribute name.
• value (object) - attribute value.

Returns attribute value from entity instance. These are the method parameters:

• entity (object) - entity instance.
• name (string) - attribute name.

Creates records in entity. The method returns array of IStatus objects for each input object. These are the method parameters:

• list (object array) - array of Dynamics CRM entities to create.
• ignoreMissingId - specify to ignore attributes referencing missing data.
• detectDuplicate - specify to enable duplicate detection rule.

Updates existing records in entity. The method returns array of IStatus objects for each input object. These are the method parameters:

• list (object array) - array of Dynamics CRM entities with update data.
• ignoreMissingId - specify to ignore attributes referencing missing data.
• detectDuplicate - specify to enable duplicate detection rule.

Create records and update existing records in entity. The method returns array of IStatus objects for each input object. These are the method parameters:

• list (object array) - array of Dynamics CRM entities with create and update data.
• ignoreMissingId - specify to ignore attributes referencing missing data.

Delete existing records in entity. The method returns array of IStatus objects for each input object. These are the method parameters:

• list (object array) - array of Dynamics CRM entities to delete.

Returns the Dynamics CRM entity identifier.

Returns the Dynamics CRM error code. If zero, there is no error.

Returns the Dynamics CRM status message.