Skip to main content
Vindicia Knowledge Center

Campaign.fetchAllCampaigns

Campaign.fetchAllCampaigns

Campaign.fetchAllCampaigns

This method returns an array of Campaign objects, filtered by CampaignState, if specified.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

status: the (optional) CampaignState of the Campaign(s) you wish to have returned. To fetch all Campaigns, set status to MatchAnyState.

page: the page number, starting at 0, for which to return the results. For example, if the total number of results is 85 and pageSize is 10:

  • Specifying 0 for page gets the results from 1 through 10.
  • Specifying 2 for page gets the results from 21 through 30.

pageSize: the number of records to display per page per call. This value must be greater than 0.

Output

return: an object of type Return that indicates the success or failure of the call.

campaign: an array of all Campaign objects whose status matches the input.

Returns

This method returns the codes listed in Standard Return Codes.

Example

$camp = new Campaign();

$response = $camp->fetchAllCampaigns();

// check $response

$fetchedCampaigns = $response['campaign'];
foreach ($fetchedCampaigns as $campaign) {

print "got campaign "

. $campaign->campaignId() . " "
. $campaign->name() . "\n";

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top