Documentation

Survey.php

This api exposes CiviCRM survey/petition records.

Tags
note

Campaign component must be enabled.

note

There is no "petition" api. Surveys and petitions are the same basic object and this api is used for both.

Table of Contents

Functions

civicrm_api3_survey_create()  : array<string|int, mixed>
Create or update a survey.
_civicrm_api3_survey_create_spec()  : mixed
Adjust Metadata for Create action.
civicrm_api3_survey_get()  : array<string|int, mixed>
Returns array of surveys matching a set of one or more group properties.
civicrm_api3_survey_delete()  : array<string|int, mixed>
Delete an existing survey.
_civicrm_api3_survey_getlist_defaults()  : array<string|int, mixed>
Set default getlist parameters.

Functions

civicrm_api3_survey_create()

Create or update a survey.

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

Array per getfields metadata.

Return values
array<string|int, mixed>

api result array

_civicrm_api3_survey_create_spec()

Adjust Metadata for Create action.

_civicrm_api3_survey_create_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_survey_get()

Returns array of surveys matching a set of one or more group properties.

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

Array of properties. If empty, all records will be returned.

Return values
array<string|int, mixed>

API result Array of matching surveys

civicrm_api3_survey_delete()

Delete an existing survey.

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

This method is used to delete any existing survey given its id.

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

[id]

Return values
array<string|int, mixed>

api result array

_civicrm_api3_survey_getlist_defaults()

Set default getlist parameters.

_civicrm_api3_survey_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>
Parameters
$request : array<string|int, mixed>
Tags
see
_civicrm_api3_generic_getlist_defaults
Return values
array<string|int, mixed>

        
On this page

Search results