SearchAllPrograms

This method returns a list of programs matching given search criteria.

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
Query	string
CategoryIds	int array
ProgramType	enum
HtmlCreativeType	enum
TextCreativeType	enum
BannerWidthComparisonOperator	enum
BannerWidth	int
BannerHeightComparisonOperator	enum
BannerHeight	int
CustomBannerRotationAvailable	bool
PartnershipStatus	enum
SubIdGrantFilter	enum

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
Query (string):: This parameter defines the search query for which records ought to be returned.
CategoryIds (array of int):: This parameter defines in what categories the desired programs shall lie.
ProgramTypes (enum):: This parameter defines the commission type of the requested statistics. Possible values are: None, PayPerClick, PayPerSaleLead, CombinedProgram
HtmlCreativeType (enum):: This parameter specifies what kind of HTML creative the desired programs must offer. Possible values are: All, HTMLBanner, FlashBanner, Microsite, PopUp, PopUnder, Iframe, HTMLForm, FlashForm, ProductLink, BannerRotation
TextCreativeType (enum);: This parameter specifies what kind of text creative the desired programs must offer. Possible values are: All, Textlink, Linkgenerator, Microsite
BannerWidthComparisonOperator (enum):: This parameter defines how the requested width of the creative ought to be handled. This parameter refers to BannerWidth. Possible values are: Equals, GreaterThan, LessThan
BannerWidth (int):: In combination with the BannerWidthComparisonOperator parameter it defines the requested width of the creative.
BannerHeightComparisonOperator (enum):: This parameter defines how the requested height of the creative ought to be handled. This parameter refers to BannerHeight. Possible values are: Equals, GreaterThan, LessThan
BannerHeight (int):: In combination with the BannerHeightComparisonOperator parameter it defines the requested height of the creative.
PartnershipStatus (enum):: This parameter defines the partnership status of the programs that ought to be returned. Possible values are: NotApplied, Paused, Active, Cancelled, Declined, Waiting
SubIdGrantFilter (enum):: This parameter defines the SubId permission of the programs that ought to be returned. Possible values are: All, SubIdPermissionGranted, NoSubIdPermissionGranted
CustomBannerRotationAvailable (bool):: If this parameter is set to ‘true’, only programs providing banner rotations are listed.

Complete code examples

protected void LoadWebService()
{            
    // first create the Web References
    // LIVE DATA
    // using Affilinet.LogonWebservice; ("https://api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.PublisherProgramWebservice; ("https://api.affili.net/V2.0/PublisherProgram.svc?wsdl")

    // or DEMO DATA
    // using Affilinet.LogonWebservice; ("https://developer-api.affili.net/V2.0/Logon.svc?wsdl")
    // using Affilinet.PublisherProgramWebservice; ("https://developer-api.affili.net/V2.0/PublisherProgram.svc?wsdl")


    #region Parameters for the authentification token
    // Insert the publisher ID for access the live data or insert your DeveloperId for access the demo data 
    string Username   = "";
    // Insert the publisher web services password for access the live data or insert your developer portal password for access the demo data 
    string Password   = "";
    // only required for access the demo data. Insert one of the publisher IDs of our demo database. e.g.: 403233
    int SandboxPublisherID = 0;
    #endregion

    string myToken = GetAuthentificationToken(Username, Password, SandboxPublisherID, WebServiceTypes.Publisher);

    // insert the parameters to get the result
    int[] categoryIds = {};
    string query = "";
    ProgramList myResult = SearchAllPrograms(myToken, 0, BannerComparisonOperator.Equals, true, 0, BannerComparisonOperator.Equals, true, categoryIds, false, true, HtmlCreativeType.All, true, PartnershipState.Active, true, ProgramType.PayPerLead, true, query, SubIdGrantFilter.All, true, TextCreativeType.All, true);
}

public static string GetAuthentificationToken(string username, string password, int sandboxPublisherID, WebServiceTypes WSType)
{
    Logon logonRequest = new Logon();
    logonRequest.Username = username;
    logonRequest.Password = password;
    logonRequest.WebServiceType = WSType;
    
    // *** only required for sandbox requests *** 
    // logonRequest.DeveloperSettings = new TokenDeveloperDetails();
    // logonRequest.DeveloperSettings.SandboxPublisherID = sandboxPublisherID;
    // logonRequest.DeveloperSettings.SandboxPublisherIDSpecified = true;             

    Authentication logonService = new Authentication();
    return logonService.Logon(logonRequest);
}
		
public static ProgramList SearchAllPrograms(string token, int bannerheight, BannerComparisonOperator bannerHeightComparaionOp, bool BannerHeightComparisonOperatorSpecified,
                                                    int bannerwidth, BannerComparisonOperator bannerWidthComparaisonOp, bool BannerWidthComparisonOperatorSpecified, int[] categoryids, 
                                                    bool CustomBannerRotationAvailable, bool CustomBannerRotationAvailableSpecified, HtmlCreativeType htmlcreativetype, 
                                                    bool HtmlCreativeTypeSpecified, PartnershipState PartnershipStatus, bool PartnershipStatusSpecified, ProgramType programtype,
                                                    bool ProgramTypeSpecified, string query, SubIdGrantFilter SubIdGrantFilter, bool SubIdGrantFilterSpecified, TextCreativeType TextCreativeType,
                                                    bool TextCreativeTypeSpecified)
        {
            PublisherProgram pubProgramService = new PublisherProgram();
            SearchAllProgramsRequestMessage sapRqMess = new SearchAllProgramsRequestMessage();
            sapRqMess.BannerHeight = bannerheight;
            sapRqMess.BannerHeightComparisonOperator = bannerHeightComparaionOp;
            sapRqMess.BannerHeightComparisonOperatorSpecified = BannerHeightComparisonOperatorSpecified;
            sapRqMess.BannerWidth = bannerheight;
            sapRqMess.BannerWidthComparisonOperator = bannerWidthComparaisonOp;
            sapRqMess.BannerWidthComparisonOperatorSpecified = BannerWidthComparisonOperatorSpecified;
            sapRqMess.CategoryIds = categoryids;
            sapRqMess.CustomBannerRotationAvailable = CustomBannerRotationAvailable;
            sapRqMess.CustomBannerRotationAvailableSpecified = CustomBannerRotationAvailableSpecified;
            sapRqMess.HtmlCreativeType = htmlcreativetype;
            sapRqMess.HtmlCreativeTypeSpecified = HtmlCreativeTypeSpecified;
            sapRqMess.PartnershipStatus = PartnershipStatus;
            sapRqMess.PartnershipStatusSpecified = PartnershipStatusSpecified;
            sapRqMess.ProgramType = programtype;
            sapRqMess.ProgramTypeSpecified = ProgramTypeSpecified;
            sapRqMess.Query = query;
            sapRqMess.SubIdGrantFilter = SubIdGrantFilter;
            sapRqMess.SubIdGrantFilterSpecified = SubIdGrantFilterSpecified;
            sapRqMess.TextCreativeType = TextCreativeType;
            sapRqMess.TextCreativeTypeSpecified = TextCreativeTypeSpecified;
            return pubProgramService.SearchAllPrograms(token, sapRqMess);
        }

SearchAllPrograms

SearchAllPrograms

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

.NET