GetPrograms

This method is a combination of GetAllPrograms, GetNewPrograms, GetMyPrograms, SearchAllPrograms and SearchMyPrograms. It contains the functionality of all these 5 methods and is intended to replace them in a later release.

To access live data, please use this WSDL file:
https://api.affili.net/V2.0/PublisherProgram.svc?wsdl
To access demo data, please use this WSDL file:
https://developer-api.affili.net/V2.0/PublisherProgram.svc?wsdl

Web service description

Test data document

Operation test

With this form, you can try out this web service. We already filled it out with a sample request which will return data. Feel free to fill in different parameter values - our test data reference gives you an overview of our sample data.

Field	Type	Values
PublisherId *	int
DisplaySettings *	DisplaySettings
CurrentPage *	int
PageSize *	int
SortByEnum	enum
SortOrderEnum	enum
GetProgramsQuery *	GetProgramsQuery
ProgramIds	int array
SearchString	string
PartnershipStatus *	ProgramPartnership- StatusEnum array
ProgramClassificationEnum	enum
ProgramCategoryIds	int array
TrackingMethods	TrackingMethod array
SEMPolicyTypes	SEMPolicyEnum array
MinimumCookieLifetime	int
MaximumProgramLifetime	int
AutoAccept	bool
HasProductData	bool
HasVoucherCodes	bool
ProductDataUpdateInterval	int
IsNew	bool
CommissionTypes	CommissionTypeEnum array

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
CurrentPage (int):: The number of the page to view.
PageSize (int):: The number of results which shall be contained per result page.
SortByEnum (enum):: The criteria along which the results shall be sorted. Possible values are: ProgramId, ProgramTitle, ProgramLifetime. Default value is ProgramId.
SortOrderEnum (enum):: The order in which the results shall be sorted. Possible values are: Ascending, Descending. Default value is Ascending.
ProgramIds (array of int):: The results will be restricted to programs out of this array.
SearchString (string):: A keyword that must be contained in the program (searches within program title, keywords, description and others).
PartnershipStatus (array of ProgramPartnershipStatusEnum): Restricts the results to programs with which you have any of these partnership status values.
PartnershipStatusEnum (enum):: The status of the partnership you have with this program. Possible values are: Active, Paused, Waiting, Refused, NoPartnership, Cancelled
ProgramClassificationEnum (enum):: Lets you select what kind of program results shall be returned. Possible values are: All, Program, Campaign
ProgramCategoryIds (array of int):: Restricts the programs to those who belong to any of these program categories (-> GetProgramCategories).
TrackingMethods (array of TrackingMethod):: Lets you restrict on the tracking method used in the desired programs.
TrackingMethod (enum):: The tracking technology which shall be used in the returned programs. Possible values are: Cookie, Session, SessionCookie
SEMPolicyTypes (array of SEMPolicyEnum):: Lets you restrict on the SEM policy which the desired programs shall have.
SEMPolicyEnum (enum):: Lets you restrict on the SEM policy which the desired programs shall have. Possible values are: NotSet (the program has not set any SEM policy yet), Allowed (SEM generally allowed), Restricted (SEM allowed only with certain restrictions), NotAllowed (no SEM allowed)
MinimumCookieLifetime (int):: Only those programs will be returned whose cookies are valid at least this many days.
MaximumProgramLifetime (int):: Only those programs will be returned which were launched at least this many months ago.
AutoAccept (bool):: Lets you restrict to those programs that automatically accept partnership applications.
HasProductData (int):: Set this to ‘true’ if you want to receive only programs which provide product data.
HasVoucherCodes (bool):: Set this to ‘true’ if you want to receive only programs which provide at least one voucher.
ProductDataUpdateInterval (int):: The amount of days which lie between each product data update of the programs.
IsNew (bool):: Restricts the programs to those, which are featured as new in the affilinet platform.
CommissionTypeEnum (enum):: Lets you restrict on the commission mode of the programs. Possible values are: Click, ClickOut, Sale, Lead

Complete code examples

package wsapi_publisherprogram;

import com.microsoft.schemas._2003._10.serialization.arrays.ArrayOfKeyValueOfstringstring.KeyValueOfstringstring;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.xml.bind.JAXBElement;
import webservices.framework.affilinet.svc.GetProgramsRequest;
import webservices.framework.affilinet.svc.GetProgramsResponse;
import webservices.framework.affilinet.svc.PublisherProgramContract;
import webservices.framework.affilinet.svc.PublisherProgramContractGetProgramsPublisherProgramFaultFaultFaultMessage;
import webservices.framework.affilinet.types.publisherprogram.ArrayOfProgramPartnershipStatusEnum;
import webservices.framework.affilinet.types.publisherprogram.DisplaySettings;
import webservices.framework.affilinet.types.publisherprogram.GetProgramsQuery;
import webservices.framework.affilinet.types.publisherprogram.Program;
import webservices.framework.affilinet.types.publisherprogram.ProgramPartnershipStatusEnum;
import webservices.framework.affilinet.types.publisherprogram.SortByEnum;
import webservices.framework.affilinet.types.publisherprogram.SortOrderEnum;

/**
 *
 * @author affilinet
 */
public class PublisherProgramWrapper {

    public Program GetPrograms(String credentialToken,
            Integer currentPage, Integer pageSize, SortByEnum sortBy, SortOrderEnum sortOrder) {
        try {
            /*
            ObjectFactory to create types that are used in the service
             */
            webservices.framework.affilinet.svc.ObjectFactory svcObjectFactory = new webservices.framework.affilinet.svc.ObjectFactory();
            webservices.framework.affilinet.types.publisherprogram.ObjectFactory typesObjectFactory = new webservices.framework.affilinet.types.publisherprogram.ObjectFactory();
            /*
            Create the service endpoint interface
             */
            webservices.framework.affilinet.svc.PublisherProgram service = new webservices.framework.affilinet.svc.PublisherProgram();
            /*
            Create a proxy out of the service endpoint interface
             */
            PublisherProgramContract proxy = service.getPort(PublisherProgramContract.class);
            
            /*
            Create typed parameters which will be used in the service call
             */
            JAXBElement<String> credentialTokenJE = svcObjectFactory.createCredentialToken(credentialToken);
            /*
            Create the request message and DisplaySettings, after that set their properties
             */
            ArrayOfProgramPartnershipStatusEnum psStatusList =
                typesObjectFactory.createArrayOfProgramPartnershipStatusEnum();
            psStatusList.getProgramPartnershipStatusEnum().add(ProgramPartnershipStatusEnum.ACTIVE);
            JAXBElement<ArrayOfProgramPartnershipStatusEnum> psStatusListJE =
                    typesObjectFactory.createGetProgramsQueryPartnershipStatus(psStatusList);

            GetProgramsQuery getProgramsQuery = new GetProgramsQuery();
            getProgramsQuery.setPartnershipStatus(psStatusListJE);

            DisplaySettings displaySettings = new DisplaySettings();
            displaySettings.setCurrentPage(currentPage);
            displaySettings.setPageSize(pageSize);
            displaySettings.setSortByEnum(sortBy);
            displaySettings.setSortOrderEnum(sortOrder);
            /*
            Create typed request message which will be used in the service call
             */
            JAXBElement<GetProgramsQuery> getProgramsQueryJE =
                    svcObjectFactory.createGetProgramsRequestGetProgramsQuery(getProgramsQuery);
            JAXBElement<DisplaySettings> displaySettingsJE =
                    svcObjectFactory.createGetProgramsRequestDisplaySettings(displaySettings);
            GetProgramsRequest request = svcObjectFactory.createGetProgramsRequest();
            request.setCredentialToken(credentialTokenJE);
            request.setDisplaySettings(displaySettingsJE);
            request.setGetProgramsQuery(getProgramsQueryJE);

            /*
            call the service method and process the result
             */
            GetProgramsResponse response = proxy.getPrograms(request);

            return response.getProgramCollection().getValue();
        } catch (PublisherProgramContractGetProgramsPublisherProgramFaultFaultFaultMessage ex) {
            Logger.getLogger(PublisherProgramWrapper.class.getName()).log(Level.SEVERE, null, ex);
            List<KeyValueOfstringstring> errors =
                    ex.getFaultInfo().getErrorMessages().getValue().getKeyValueOfstringstring();
            for(KeyValueOfstringstring error : errors) {
                System.out.println("ERROR: " + error.getKey() + " - " + error.getValue());
            }
        }
        return null;
    }

}

<?php

/* <LIVE DATA> 
define ("WSDL_LOGON", "https://api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_PROGRAM",  "https://api.affili.net/V2.0/PublisherProgram.svc?wsdl");

$Username   = ''; // the publisher ID
$Password   = ''; // the publisher web services password
$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
             'Username'  => $Username,
             'Password'  => $Password,
             'WebServiceType' => 'Publisher'
             ));
 </LIVE DATA> */

/* <DEMO DATA> */
define ("WSDL_LOGON",   "https://developer-api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_PROGRAM", "https://developer-api.affili.net/V2.0/PublisherProgram.svc?wsdl");

$Username   = '';     // your developer ID, as seen in the developer portal under "My Account", normally something like "Users.X.XXX"
$Password   = '';     // your developer portal password
$DemoPublisherId   = 403233;  // one of the publisher IDs of our demo database
$DeveloperSettings = array('SandboxPublisherID' => $DemoPublisherId);

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
                     'Username'  => $Username,
                     'Password'  => $Password,
                     'WebServiceType' => 'Publisher',
                     'DeveloperSettings' => $DeveloperSettings
                     ));
 /*</DEMO DATA> */
 
$DisplaySettings = array (
			'PageSize' => 5,
			'CurrentPage' => 1
			);
$GetProgramsQuery = array(
		    'PartnershipStatus' => array('Active','Waiting')
		    );

$SOAP_REQUEST = new SoapClient(WSDL_PROGRAM);
$req = $SOAP_REQUEST->GetPrograms(array(
            'CredentialToken' => $Token,
			'DisplaySettings' => $DisplaySettings,
            'GetProgramsQuery' => $GetProgramsQuery
            ));

print '<pre>RESULTS:<br>'.htmlspecialchars(print_r($req, true)).'</pre>';

?>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using WSAPI_CodeSamples.SvcPublisherProgram;
using System.ServiceModel;

namespace WSAPI_CodeSamples.Services.PublisherProgram
{
    /// <summary>
    /// Encapsulates all service calls for the PublisherInbox service
    /// </summary>
    public class PublisherProgramWrapper
    {
        /// <summary>
        /// The name of the client endpoint configured in the configuration file
        /// </summary>
        private const String publisherProgramEndpoint = "PublisherProgramEndpoint";

        /// <summary>
        /// Receive programinformation for programs that match the provided parameters.
        /// </summary>
        /// <param name="credentialToken">The token used to authenticate the webservice caller</param>
        /// <param name="autoAccept">Restrict to those programs that automatically accept partnership applications</param>
        /// <param name="commissionTypes">Restrict on the commission mode of the programs. Possible values are: Click, ClickOut, Sale, Lead</param>
        /// <param name="hasProductData">True, to receive only programs which provide product data</param>
        /// <param name="hasVoucherCodes">True, to receive only programs which provide at least one voucher</param>
        /// <param name="isNew">Restricts the programs to those, which are featured as new in the affilinet platform</param>
        /// <param name="maximumProgramLifetime">Only those programs will be returned which were launched at least this many months ago</param>
        /// <param name="minimumCookieLifetime">Only those programs will be returned whose cookies are valid at least this many days</param>
        /// <param name="partnershipStatus">Restricts the results to programs with which you have any of these partnership status values</param>
        /// <param name="productDataUpdateInterval">The amount of days which lie between each product data update of the programs</param>
        /// <param name="programCategoryIds">Restricts the programs to those who belong to any of these program categories</param>
        /// <param name="programClassificationEnum">Select what kind of program results shall be returned. Possible values are: All, Program, Campaign</param>
        /// <param name="programIds">The results will be restricted to programs contained in this parameter</param>
        /// <param name="searchString">A keyword that must be contained in the program (title, keywords, description, ...)</param>
        /// <param name="semPolicyTypes">Restrict on the SEM policy which the desired programs shall have</param>
        /// <param name="trackingMethods">Restrict on the tracking method used in the desired programs</param>
        public void GetPrograms(
            String credentialToken, 
            bool? autoAccept, 
            List<CommissionTypeEnum> commissionTypes,
            bool? hasProductData,
            bool? hasVoucherCodes,
            bool isNew, 
            int? maximumProgramLifetime, 
            int? minimumCookieLifetime,
            List<ProgramPartnershipStatusEnum> partnershipStatus, 
            int? productDataUpdateInterval, 
            List<int> programCategoryIds, 
            ProgramClassificationEnum programClassificationEnum, 
            List<int> programIds, 
            String searchString,
            List<SEMPolicyEnum> semPolicyTypes, 
            List<TrackingMethod> trackingMethods)
        {
            /* 
             * The service proxy generated through the service reference, 
             * allowing service calls to any PublisherInbox service method
             */
            PublisherProgramContractClient client = null;
            try
            {
                /*
                 * query containing the input parameters
                 */
                GetProgramsQuery programsQuery = new GetProgramsQuery();
                programsQuery.AutoAccept = autoAccept;
                programsQuery.CommissionTypes = commissionTypes;
                programsQuery.HasProductData = hasProductData;
                programsQuery.HasVoucherCodes = hasVoucherCodes;
                programsQuery.IsNew = isNew;
                programsQuery.MaximumProgramLifetime = maximumProgramLifetime;
                programsQuery.MinimumCookieLifetime = minimumCookieLifetime;
                programsQuery.PartnershipStatus = partnershipStatus;
                programsQuery.ProductDataUpdateInterval = productDataUpdateInterval;
                programsQuery.ProgramCategoryIds = programCategoryIds;
                programsQuery.ProgramClassificationEnum = programClassificationEnum;
                programsQuery.ProgramIds = programIds;
                programsQuery.SearchString = searchString;
                programsQuery.SEMPolicyTypes = semPolicyTypes;
                programsQuery.TrackingMethods = trackingMethods;

                /* 
                 * Display Settings specifying the format of the response, 
                 * please provide parameters that fit your needs (dynamically)
                 */
                DisplaySettings displaySettings = new DisplaySettings();
                displaySettings.CurrentPage = 1;
                displaySettings.PageSize = 100;
                displaySettings.SortByEnum = SortByEnum.ProgramId;
                displaySettings.SortOrderEnum = SortOrderEnum.Ascending;

                /* 
                 * Spoiler code for the GUI, which has to be IGNORED in this sample.
                 */
                GetProgramsRequest request = new GetProgramsRequest(credentialToken, displaySettings, programsQuery);
                Frame.SetRequest(request);

                /* 
                 * Initialization of the proxy with the name of the client endpoint configured in the configuration.
                 */
                client = new PublisherProgramContractClient(publisherProgramEndpoint);

                int totalResults;
                /* 
                 * Calling the service proxy to receive the response, 
                 * which can be parsed to get the needed information.
                 */
                SvcPublisherProgram.Program response = 
                    client.GetPrograms(credentialToken, displaySettings, programsQuery, out totalResults);
                
                /* 
                 * Spoiler code for the GUI, which has to be IGNORED in this sample.
                 */
                Frame.SetResponse(response);

            }
            catch (FaultException<SvcPublisherProgram.PublisherProgramFault> fe)
            {
                /* 
                 * Handling exceptions of type PublisherProgramFault, 
                 * which occurs when there was a problem during the processing of request message.
                 * This code is only spoiler code. You should handle these exceptions in a way that fits your needs.
                 */
                Frame.SetResponse(fe.Detail.ErrorMessages);
            }
            finally
            {
                /* 
                 * Finally close the open connection to the service through the proxy.
                 */
                if (client != null)
                {
                    client.Close();
                }
            }
        }
    }
}

GetPrograms

GetPrograms

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

JAVA

PHP

.NET