NATS4 API Affiliate Get Campaigns

From TMMwiki
Jump to: navigation, search
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
API Overview
GET /adtools/types
GET /adtools/categories
GET /adtools/admin
POST /adtools/importdump
GET /affiliate/hitdata
GET /affiliate/campaigns
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setcustoms
PATCH /affiliate/setinformation
PATCH /affiliate/setadminsettings
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setdefaults
PATCH /affiliate/setsettings
GET /decodenatscode
GET /member/upsellstring
GET /member/tokenrebuystring
GET /member/instantupgradestring
GET /member/packageupgradestring
GET /member/details
GET /member/cancelstring
GET /member/signupplusstring
GET /member/searchinfo
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/setdetails
PATCH /member/setexpiration
GET /option/getrule
POST /option/addrule
PUT /option/edittext
PATCH /option/editrule
GET /payments/getpayments
PATCH /payments/setstatus
GET /payviarule
PATCH /payviarule
GET /ping
GET /profitlossreport
POST /sendemail
GET /suggestedcanceloffers

This API function allows you to get a list of affiliate campaigns by using the aff_getcampaigns function. The following parameters are accepted for this function:

  • start - (optional) The number of campaigns to skip from the beginning. Useful when returning a lot of campaigns. Default: 0 meaning start at the beginning of the campaign list.
  • count - (optional) The number of campaigns to return. Default: 0 meaning all campaigns are returned.
  • orderby - (optional) How to order the return of campaigns. Default: name. Available options are campaignid or name. You can sort ascending or descending by adding ASC or DESC to the orderby parameter.

NuSOAP Example

This example continues from the main article NuSOAP Example:

$values = Array(
	'start' => 1,
	'count' => 3,
	'orderby' => 'campaignid DESC',
$result = $client->call('aff_getcampaigns', $values, 'natsapiadmin_wsdl');

Sample Output

    [0] => Array
            [campaignid] => 1
            [name] => top,header,banner

    [1] => Array
            [campaignid] => 2
            [name] => banner,side,ad