GetVoucherCodes

Advertisers upload their voucher codes or information on special deals to the affilinet platform. This method lets you find vouchers, which match your specified criteria.

To access live data, please use this WSDL file:
https://api.affili.net/V2.0/PublisherInbox.svc?wsdl
To access demo data, please use this WSDL file:
https://developer-api.affili.net/V2.0/PublisherInbox.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

ProgramId *

int

VoucherCode

string

Query

string

StartDate *

datetime

Open the calendar popup.

EndDate *

datetime

Open the calendar popup.

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
ProgramId (int):: Only voucher from this program are returned.
VoucherCode (string):: Only vouchers are returned, which contain this string in the voucher code itself.
Query (string):: Only vouchers are returned, which contain this string in the voucher code itself, the description, the deeplink or the advertiser name.
StartDate (datetime):: Only vouchers with this start date (or earlier) are returned. Cannot be a date in the past.
EndDate (datetime):: vouchers with this end date (or later) are returned. Cannot be earlier than StartDate.

Complete code examples

package wsapi_publisherinbox;

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 javax.xml.datatype.XMLGregorianCalendar;
import org.datacontract.schemas._2004._07.microsoft_practices_enterpriselibrary_validation_integration.ValidationDetail;
import webservices.framework.affilinet.svc.PublisherInboxContract;
import webservices.framework.affilinet.svc.PublisherInboxContractGetVoucherCodesPublisherInboxFaultFaultFaultMessage;
import webservices.framework.affilinet.svc.PublisherInboxContractGetVoucherCodesValidationFaultFaultFaultMessage;
import webservices.framework.affilinet.types.publisherinbox.GetVoucherCodesRequestMessage;
import webservices.framework.affilinet.types.publisherinbox.VoucherCodeCollection;

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

    public VoucherCodeCollection GetVoucherCodes(String credentialToken, XMLGregorianCalendar startDate,
            XMLGregorianCalendar endDate,
            String query, String voucherCode, Integer programId) {
        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.publisherinbox.ObjectFactory typesObjectFactory =
                    new webservices.framework.affilinet.types.publisherinbox.ObjectFactory();
            /*
            Create the service endpoint interface
             */
            webservices.framework.affilinet.svc.PublisherInbox service =
                    new webservices.framework.affilinet.svc.PublisherInbox();
            /*
            Create a proxy out of the service endpoint interface
             */
            PublisherInboxContract proxy = service.getPort(PublisherInboxContract.class);

            /*
            Create typed parameters which will be used in the service call
             */
            JAXBElement<String> credentialTokenJE =
                    svcObjectFactory.createGetVoucherCodesRequestCredentialToken(credentialToken);
            JAXBElement<String> queryJE =
                    typesObjectFactory.createGetVoucherCodesRequestMessageQuery(query);
            JAXBElement<String> voucherCodeJE =
                    typesObjectFactory.createGetVoucherCodesRequestMessageVoucherCode(voucherCode);
            JAXBElement<Integer> programIdJE =
                    typesObjectFactory.createGetVoucherCodesRequestMessageProgramId(programId);
            /*
            Create the request message and set its properties
             */
            GetVoucherCodesRequestMessage requestMessage =
                    new GetVoucherCodesRequestMessage();
            requestMessage.setStartDate(startDate);
            requestMessage.setEndDate(endDate);
            requestMessage.setQuery(queryJE);
            requestMessage.setProgramId(programIdJE);
            requestMessage.setVoucherCode(voucherCodeJE);
            /*
            Create typed request message which will be used in the service call
             */
            JAXBElement<GetVoucherCodesRequestMessage> requestMessageJE =
                    svcObjectFactory.createGetVoucherCodesRequestGetVoucherCodesRequestMessage(requestMessage);
            webservices.framework.affilinet.svc.GetVoucherCodesRequest request =
                    svcObjectFactory.createGetVoucherCodesRequest();
            request.setCredentialToken(credentialTokenJE);
            request.setGetVoucherCodesRequestMessage(requestMessageJE);

            /*
            call the service method and process the result
             */
            webservices.framework.affilinet.svc.GetVoucherCodesResponse response =
                    proxy.getVoucherCodes(request);

            return response.getVoucherCodeCollection().getValue();
        } catch (PublisherInboxContractGetVoucherCodesPublisherInboxFaultFaultFaultMessage ex) {
            Logger.getLogger(PublisherInboxWrapper.class.getName()).log(Level.SEVERE, null, ex);
            List<KeyValueOfstringstring> errors =
                    ex.getFaultInfo().getErrors().getValue().getKeyValueOfstringstring();
            for(KeyValueOfstringstring error : errors) {
                System.out.println("ERROR: " + error.getKey() + " - " + error.getValue());
            }
        } catch (PublisherInboxContractGetVoucherCodesValidationFaultFaultFaultMessage ex) {
            Logger.getLogger(PublisherInboxWrapper.class.getName()).log(Level.SEVERE, null, ex);
            List<ValidationDetail> errors =
                    ex.getFaultInfo().getDetails().getValue().getValidationDetail();
            for(ValidationDetail error : errors) {
                System.out.println("ERROR: " + error.getKey() + " - " + error.getMessage());
            }
        }
        return null;
     }
}

<?php

/* LIVE 
define ("WSDL_LOGON", "https://api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_WS",  "https://api.affili.net/V2.0/PublisherInbox.svc?wsdl");

$Username   = ''; // the publisher ID
$Password   = ''; // the publisher web service password

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
             'Username'  => $Username,
             'Password'  => $Password,
             'WebServiceType' => 'Publisher'
             ));
 /LIVE */			 
			 
/* DEMO */
define ("WSDL_LOGON", "https://developer-api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_WS",  "https://developer-api.affili.net/V2.0/PublisherInbox.svc?wsdl");

$Username   = '';     // your developer ID
$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 */

$params = array(
			'StartDate' => strtotime("now"),
			'EndDate' => strtotime("now")
			);

$SOAP_REQUEST = new SoapClient(WSDL_WS);
$req = $SOAP_REQUEST->GetVoucherCodes(array(
            'CredentialToken' => $Token,
            'GetVoucherCodesRequestMessage' => $params
            ));

// if only one element was found, PHP doesn't return it as an array. This enforces it:	
if(!is_array($req->VoucherCodeCollection->VoucherCodeCollection)) {
  $req->VoucherCodeCollection->VoucherCodeCollection = array($req->VoucherCodeCollection->VoucherCodeCollection);
}

print_r($req);

?>

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

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

        /// <summary>
        /// Receive vouchercodes that match the provided parameters.
        /// </summary>
        /// <param name="credentialToken">The token used to authenticate the webservice caller</param>
        /// <param name="startDate">The date from when the voucher should be valid</param>
        /// <param name="endDate">The date until when the voucher should be valid</param>
        /// <param name="query">The search string with keywords that should be contained in the vouchercode</param>
        /// <param name="voucherCode">A string that contains the concreate vouchercode you are looking for</param>
        /// <param name="programId">The identifier of the program you are searching vouchercodes for</param>
        public void GetVoucherCodes(String credentialToken, DateTime startDate, DateTime endDate, 
            String query, String voucherCode, Int32? programId)
        { 
            /* 
             * The service proxy generated through the service reference, 
             * allowing service calls to any PublisherInbox service method
             */
            PublisherInboxContractClient client = null;
            try
            {
                /*
                 * Request message containing the input parameters:
                 * StartDate, EndDate, Query, VoucherCode and ProgramId
                 */
                GetVoucherCodesRequestMessage requestMessage = new GetVoucherCodesRequestMessage();
                requestMessage.StartDate = startDate;
                requestMessage.EndDate = endDate;
                requestMessage.Query = query;
                requestMessage.VoucherCode = voucherCode;
                requestMessage.ProgramId = programId;

                /* 
                 * Request containing the request message and the credential token, 
                 * which authorizes the users request.
                 */
                GetVoucherCodesRequest request = new GetVoucherCodesRequest();
                request.CredentialToken = credentialToken;
                request.GetVoucherCodesRequestMessage = requestMessage;

                /* 
                 * Spoiler code for the GUI, which has to be IGNORED in this sample.
                 */
                Frame.SetRequest(request);

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

                /* 
                 * Calling the service proxy to receive the response, 
                 * which can be parsed to get the needed information.
                 */
                GetVoucherCodesResponse response = client.GetVoucherCodes(request);

                /* 
                 * Spoiler code for the GUI, which has to be IGNORED in this sample.
                 */
                Frame.SetResponse(response);

            }
            catch (FaultException<SvcPublisherInbox.PublisherInboxFault> fe)
            {
                /* 
                 * Handling exceptions of type PublisherInboxFault, 
                 * 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.Errors);
            }
            finally
            {
                /* 
                 * Finally close the open connection to the service through the proxy.
                 */
                if (client != null)
                {
                    client.Close();
                }
            }
        }

    }
}

GetVoucherCodes

GetVoucherCodes

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

JAVA

PHP

.NET