Documentation

Dedupe.php

This api exposes CiviCRM dedupe functionality.

Table of Contents

Functions

civicrm_api3_dedupe_get()  : array<string|int, mixed>
Get rows for any cached attempted merges on the passed criteria.
_civicrm_api3_dedupe_get_spec()  : mixed
Get rows for getting dedupe cache records.
civicrm_api3_dedupe_delete()  : array<string|int, mixed>
Delete rows for any cached attempted merges on the passed criteria.
civicrm_api3_dedupe_create()  : array<string|int, mixed>
Get the statistics for any cached attempted merges on the passed criteria.
civicrm_api3_dedupe_getstatistics()  : array<string|int, mixed>
Get the statistics for any cached attempted merges on the passed criteria.
_civicrm_api3_dedupe_getstatistics_spec()  : mixed
Adjust Metadata for Create action.
civicrm_api3_dedupe_getduplicates()  : array<string|int, mixed>
Get the duplicate contacts for the supplied parameters.
_civicrm_api3_dedupe_getduplicates_spec()  : mixed
Adjust Metadata for getduplicates action.. The metadata is used for setting defaults, documentation & validation.

Functions

civicrm_api3_dedupe_get()

Get rows for any cached attempted merges on the passed criteria.

civicrm_api3_dedupe_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_dedupe_get_spec()

Get rows for getting dedupe cache records.

_civicrm_api3_dedupe_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
$params : array<string|int, mixed>

civicrm_api3_dedupe_delete()

Delete rows for any cached attempted merges on the passed criteria.

civicrm_api3_dedupe_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
throws
UnauthorizedException
Return values
array<string|int, mixed>

civicrm_api3_dedupe_create()

Get the statistics for any cached attempted merges on the passed criteria.

civicrm_api3_dedupe_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
throws
UnauthorizedException
Return values
array<string|int, mixed>

civicrm_api3_dedupe_getstatistics()

Get the statistics for any cached attempted merges on the passed criteria.

civicrm_api3_dedupe_getstatistics(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_dedupe_getstatistics_spec()

Adjust Metadata for Create action.

_civicrm_api3_dedupe_getstatistics_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_dedupe_getduplicates()

Get the duplicate contacts for the supplied parameters.

civicrm_api3_dedupe_getduplicates(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_dedupe_getduplicates_spec()

Adjust Metadata for getduplicates action.. The metadata is used for setting defaults, documentation & validation.

_civicrm_api3_dedupe_getduplicates_spec(array<string|int, mixed> &$params) : mixed
Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.


        
On this page

Search results