Skip to content

RequestsAndEntities

Johan Vervloet edited this page Apr 3, 2015 · 3 revisions

Requests and entities

civicrm.net supports these entities:

  • Contact
  • Event
  • Membership
  • Relationship
  • Address
  • Email
  • Im
  • Phone
  • Website
  • LocBlock

If you want to address the API, you send a request. Depending on the method you call, the result will be one entity or a result that contains zero or more entities.

A request class is significantly different from a result, mainly because of the way Chaining and Filtering are implemented. For every entity, an entity request exits.

The requests are defined in Chiro.CiviCrm.Api/DataContracts/Requests. Entity classes are in Chiro.CiviCrm.Api/DataContracts/Entities.

To summarize: you send a request to the API, and the API returns an entity, or a result containing a list of entities. To find out what methods civicrm.net supports, take a look at Chiro.CiviCrm.Api/ICiviCrmApi.cs.

Clone this wiki locally