civicrm_uf_group_deletecivicrm_participant_createcivicrm_contribution_getcivicrm_contact_searchIn the list below you will find all the API's in version 2 and their functions. In the column 'assigned to' you can add your name if you are taking on the task of migrating this API or function to version 3. You can either commit to migratiing a complete API, or a function within an API. If you do want to migrate a function within the API, be sure to check if no one is migrating the complete API! Once you have finished the API or function, please change the status to:
- "commited" (if you have svn access and committed the change to http://svn.civicrm.org/civicrm/branches/trunk.api/) in the v3 folder
- "posted on forum" if you have no svn access but have posted the new code (preferably as a patch or a diff) on the api forum
Documentation on the v3 API's can be found here: http://api.civicrm.org/v3/
It is obviously also possible that you want to add API's that are v3 compliant, please add them to the list below!
Migrating is not complicated. This how to should put on in the right track. We need your help to make the changes possible for the next version, you can do only one function, it will already be very useful and appreciated.
If you want to help but do not know how to deal with any of this, please put a post on the forum. The API team will pick it up and help you to help us :-)
(be careful at the moment, Xavier and Eileen still need to mark what they already have done....will remove this warning when that is done)
API file (version 2) |
API function (version 2) |
Assigned to |
New function name |
Status |
||
|---|---|---|---|---|---|---|
Activity |
complete API file |
|
|
|
||
|
civicrm_activities_get_contact |
|
civicrm_activity_get |
Removed |
||
|
civicrm_activity_create |
|
|
|
||
|
civicrm_activity_custom_get |
|
civicrm_activity_get |
|
||
|
civicrm_activity_delete |
|
|
|
||
|
civicrm_activity_delete |
|
|
|
||
|
civicrm_activity_get |
|
civicrm_activity_get |
|
||
|
civicrm_activity_get_contact |
|
|
|
||
|
civicrm_activity_get_types |
|
|
|
||
|
civicrm_activity_processemail |
|
|
|
||
|
civicrm_activity_process_email |
|
|
|
||
|
civicrm_activity_update |
|
|
|
||
|
|
|
|
|
||
ActivityContact |
complete API file |
|
|
|
||
|
civicrm_activity_contact_get |
|
|
|
||
|
|
|
|
|
||
ActivityType |
complete API file |
|
|
|
||
|
civicrm_activity_type_create |
|
|
|
||
|
civicrm_activity_type_delete |
|
|
|
||
|
civicrm_activity_type_get |
|
|
|
||
|
|
|
|
|
||
Case |
complete API file |
|
|
|
||
|
civicrm_case_activity_create |
|
|
|
||
|
civicrm_case_create |
|
|
|
||
|
civicrm_case_delete |
|
|
|
||
|
civicrm_case_get |
|
|
|
||
|
civicrm_case_update |
|
|
|
||
|
|
|
|
|
||
Constant |
complete API file (1 function only) |
|
|
|
||
|
|
|
|
|
||
Contact |
complete API file |
|
|
|
||
|
civicrm_contact_add |
|
|
|
||
|
civicrm_contact_check_custom_params |
|
|
|
||
|
civicrm_contact_check_params |
|
|
|
||
|
civicrm_contact_create |
|
|
|
||
|
civicrm_contact_delete |
|
|
|
||
|
civicrm_contact_format_create |
|
|
|
||
|
civicrm_contact_get |
|
|
|
||
|
civicrm_contact_search |
|
|
|
||
|
civicrm_contact_search_count |
|
|
|
||
|
civicrm_contact_update |
|
|
|
||
|
civicrm_replace_contact_formatted |
|
|
|
||
|
|
|
|
|
||
Contribution |
complete API file |
|
|
|
||
|
civicrm_contribute_transact |
|
|
|
||
|
civicrm_contribution_add |
|
|
|
||
|
civicrm_contribution_delete |
|
|
|
||
|
civicrm_contribution_format_create |
|
|
|
||
|
civicrm_contribution_get |
|
|
|
||
|
civicrm_contribution_search |
|
|
not in v3 - get only |
||
|
|
|
|
|
||
CustomGroup |
complete API file |
|
|
|
||
|
civicrm_custom_field_create |
|
|
|
||
|
civicrm_custom_field_delete |
|
|
|
||
|
civicrm_custom_group_create |
|
|
|
||
|
civicrm_custom_group_delete |
|
|
|
||
|
|
|
|
|
||
Domain |
complete API file |
|
|
|
||
|
civicrm_domain_create |
|
|
|
||
|
civicrm_domain_get |
|
|
|
||
|
|
|
|
|
||
EntityTag |
complete API file |
|
|
|
||
|
civicrm_entity_tag_add |
|
|
|
||
|
civicrm_entity_tag_common |
|
|
|
||
|
civicrm_entity_tag_display |
|
|
|
||
|
civicrm_entity_tag_get |
|
|
|
||
|
civicrm_entity_tag_remove |
|
|
|
||
|
civicrm_tag_entities_get |
|
|
|
||
|
|
|
|
|
||
Event |
complete API file |
|
|
|
||
|
civicrm_event_create |
|
|
|
||
|
civicrm_event_delete |
|
|
|
||
|
civicrm_event_get |
|
|
|
||
|
civicrm_event_search |
|
|
|
||
|
|
|
|
|
||
File |
complete API file |
|
|
|
||
|
civicrm_entity_file_create |
|
|
|
||
|
civicrm_entity_file_delete |
|
|
|
||
|
civicrm_files_by_entity_get |
|
|
|
||
|
civicrm_file_by_entity_add |
|
|
|
||
|
civicrm_file_create |
|
|
|
||
|
civicrm_file_delete |
|
|
|
||
|
civicrm_file_get |
|
|
|
||
|
civicrm_file_update |
|
|
|
||
|
|
|
|
|
||
Group |
complete API file |
elMobile |
|
|
||
|
civicrm_group_add |
|
|
|
||
|
civicrm_group_delete |
|
|
|
||
|
civicrm_group_get |
|
|
|
||
|
|
|
|
|
||
GroupContact |
complete API file |
|
|
|
||
|
civicrm_group_contact_add |
|
|
|
||
|
civicrm_group_contact_common |
|
|
|
||
|
civicrm_group_contact_get |
|
|
|
||
|
civicrm_group_contact_pending |
|
|
|
||
|
civicrm_group_contact_remove |
|
|
|
||
|
civicrm_group_contact_update_status |
|
|
|
||
|
|
|
|
|
||
GroupNesting |
complete API file |
|
|
|
||
|
civicrm_group_nesting_create |
|
|
|
||
|
civicrm_group_nesting_get |
|
|
|
||
|
civicrm_group_nesting_remove |
|
|
|
||
|
|
|
|
|
||
GroupOrganization |
complete API file |
|
|
|
||
|
civicrm_group_organization_create |
|
|
|
||
|
civicrm_group_organization_get |
|
|
|
||
|
civicrm_group_organization_remove |
|
|
|
||
|
|
|
|
|
||
Location |
complete API File |
|
|
|
||
|
civicrm_location_add |
|
|
|
||
|
civicrm_location_delete |
|
|
|
||
|
civicrm_location_delete |
|
|
|
||
|
civicrm_location_update |
|
|
|
||
|
|
|
|
|
||
Mailer |
complete API file |
|
|
|
||
|
civicrm_mailer_event_bounce |
|
|
|
||
|
civicrm_mailer_event_click |
|
|
|
||
|
civicrm_mailer_event_confirm |
|
|
|
||
|
civicrm_mailer_event_domain_unsubscribe |
|
|
|
||
|
civicrm_mailer_event_forward |
|
|
|
||
|
civicrm_mailer_event_open |
|
|
|
||
|
civicrm_mailer_event_reply |
|
|
|
||
|
civicrm_mailer_event_resubscribe |
|
|
|
||
|
civicrm_mailer_event_subscribe |
|
|
|
||
|
civicrm_mailer_event_unsubscribe |
|
|
|
||
|
|
|
|
|
||
Membership |
complete API file |
|
|
|
||
|
civicrm_contact_memberships_get |
|
|
|
||
|
civicrm_contact_membership_create |
|
|
|
||
|
civicrm_membership_delete |
|
|
|
||
|
civicrm_membership_statuses_get |
|
|
|
||
|
civicrm_membership_types_get |
|
|
|
||
|
|
|
|
|
||
MembershipContact |
complete API file |
|
|
|
||
|
civicrm_membership_contact_create |
|
|
|
||
|
civicrm_membership_contact_get |
|
|
|
||
|
|
|
|
|
||
MembershipContributionLink |
complete API file |
|
|
|
||
|
civicrm_membershipcontributionlink_create |
|
|
|
||
|
civicrm_membershipcontributionlink_get |
|
|
|
||
|
|
|
|
|
||
MembershipStatus |
complete API file |
|
|
|
||
|
civicrm_membership_status_calc |
|
|
|
||
|
civicrm_membership_status_create |
|
|
|
||
|
civicrm_membership_status_delete |
|
|
|
||
|
civicrm_membership_status_get |
|
|
|
||
|
civicrm_membership_status_update |
|
|
|
||
|
|
|
|
|
||
MembershipType |
complete API file |
|
|
|
||
|
civicrm_membership_type_create |
|
|
|
||
|
civicrm_membership_type_delete |
|
|
|
||
|
civicrm_membership_type_get |
|
|
|
||
|
civicrm_membership_type_update |
|
|
|
||
|
|
|
|
|
||
Note |
complete API file |
|
|
|
||
|
civicrm_note_create |
|
|
|
||
|
civicrm_note_delete |
|
|
|
||
|
civicrm_note_get |
|
|
|
||
|
civicrm_note_tree_get |
|
|
|
||
|
civicrm_note_update |
|
|
|
||
|
|
|
|
|
||
Participant |
complete API file |
|
|
|
||
|
civicrm_create_participant_formatted |
|
|
|
||
|
civicrm_participant_check_params |
|
|
|
||
|
civicrm_participant_create |
|
|
|
||
|
civicrm_participant_delete |
|
|
|
||
|
civicrm_participant_get |
|
|
|
||
|
civicrm_participant_payment_create |
|
|
|
||
|
civicrm_participant_payment_delete |
|
|
|
||
|
civicrm_participant_payment_update |
|
|
|
||
|
civicrm_participant_search |
|
|
|
||
|
civicrm_participant_update |
|
|
|
||
|
|
|
|
|
||
Relationship |
complete API file |
|
|
|
||
|
civicrm_contact_relationship_get |
|
|
|
||
|
civicrm_get_relationships |
|
|
|
||
|
civicrm_relationship_create |
|
|
|
||
|
civicrm_relationship_delete |
|
|
|
||
|
civicrm_relationship_get |
|
|
|
||
|
civicrm_relationship_update |
|
|
|
||
|
|
|
|
|
||
RelationshipType |
complete API file |
|
|
|
||
|
civicrm_relationshipType_get |
|
nil |
rejected |
||
|
civicrm_relationship_types_get |
|
|
|
||
|
civicrm_relationship_type_add |
|
civicrm_relationship_type_create |
|
||
|
civicrm_relationship_type_delete |
|
|
|
||
|
civicrm_relationship_type_update |
|
|
|
||
|
|
|
|
|
||
Tag |
complete API file |
XAV |
|
|
||
|
civicrm_tag_create |
|
|
|
||
|
civicrm_tag_delete |
|
|
|
||
|
civicrm_tag_get |
|
|
|
||
|
|
|
|
|
||
UFGroup |
complete API file |
|
|
|
||
|
civicrm_profile_html_validate |
Eileen |
|
rejected |
|
|
|
civicrm_uf_create_html_get |
|
|
rejected |
|
|
|
civicrm_uf_field_create |
|
|
|
||
|
civicrm_uf_field_delete |
|
|
|
||
|
civicrm_uf_field_update |
|
|
|
||
|
civicrm_uf_group_create |
|
|
|
||
|
civicrm_uf_group_delete |
|
|
|
||
|
civicrm_uf_group_update |
|
|
|
||
|
civicrm_uf_group_weight |
|
|
|
||
|
civicrm_uf_id_get |
Eileen |
civicrm_uf_match_get |
Committed - |
||
|
civicrm_uf_match_id_get |
Eileen |
civicrm_uf_match_get |
Committed - civicrm_uf_match_get |
||
|
civicrm_uf_profile_fields_get |
Eileen |
nil |
Removed (left in v2 as not compliant & would seem to be ufField function?) |
||
|
civicrm_uf_profile_groups_get |
Eileen |
nil |
Removed (left in v2 as not compliant & would seem to be ufField function?) |
|
|
|
civicrm_uf_profile_html_by_id_get |
Eileen |
nil |
Not in v3 |
||
|
civicrm_uf_profile_html_get |
Eileen |
nil |
Removed (left in v2 as not compliant & would seem to be ufField function?) |
|
|
|
civicrm_uf_profile_title_get |
|
nil |
|
|
|
|
|
|
|
|
||
UFJoin |
complete API file |
|
|
|
||
|
civicrm_uf_join_add |
Eileen |
civicrm_uf_join_create |
Committed |
||
|
civicrm_uf_join_edit |
Eileen |
civicrm_uf_join_create |
Committed |
||
|
civicrm_uf_join_id_find |
Eileen |
civicrm_uf_join_get |
Committed |
||
|
civicrm_uf_join_UFGroupId_find |
Eileen |
civicrm_uf_join_get |
Committed |
||
|
|
|
|
|
||
utils |
complete API file |
|
|
|
||
|
civicrm_api_check_permission |
|
|
|
||
|
civicrm_check_contact_dedupe |
|
|
|
||
|
civicrm_create_error |
|
|
|
||
|
civicrm_create_success |
Erik Hommel |
|
committed |
||
|
civicrm_duplicate |
|
|
|
||
|
civicrm_error |
|
|
|
||
|
civicrm_verify_mandatory |
Xavier Dutoit |
|
committed |
