1.

GetPrograms
This method returns programs that match given search criteria.
SOAP URL: https://api.affili.net/V2.0/PublisherProgram.svc?wsdl

1.1. Parameters
Parameter

Type

Description

CredentialToken *

String

The authentification token you receive from the

method Logon.

DisplaySettings *

DisplaySettings

Defines the paging and sorting of the found

programs.

GetProgramsQuery *

GetProgramsQuery

The search parameters to which the desired

programs shall match.

1.1.1. DisplaySettings
Property

Type

Description

CurrentPage *

Integer

The number of the page to view.

PageSize *

Integer

The number of results which shall be contained

per result page. Must be between 1 and 100.

SortByEnum

Enumeration

The criteria along which the results shall be sorted.

Possible values are:
ProgramId
ProgramTitle
ProgramLifetime
Default value is ProgramId

SortOrderEnum

Enumeration

The order in which the results shall be sorted.

Possible values are:
Ascending
Descending
Default value is Ascending.

1.1.2. GetProgramsQuery
Property

Type

Description

ProgramIds

Array of integer

The results will be restricted to

programs out of this array.

SearchString

String

A keyword that must be contained in

the program (searches within

Publisher Webservices

Page 1

program title, keywords, description

and others).
PartnershipStatus *

Array of
ProgramPartnershipSt
atusEnum

Restricts the results to programs with

which you have any of these
partnership status values.

ProgramClassificationEnum

Enumeration

Lets you select what kind of program

results shall be returned. Possible
values are:
All
Program
Campaign

ProgramCategoryIds

Array of integer

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.

SEMPolicyTypes

Array of
SEMPolicyEnum

Lets you restrict on the SEM policy

which the desired programs shall
have.

MinimumCookieLifetime

Integer

Only those programs will be returned

whose cookies are valid at least this
many days.

MaximumProgramLifetime

Integer

Only those programs will be returned

which were launched at least this
many months ago.

AutoAccept

Boolean

Lets you restrict to those programs

that automatically accept partnership
applications.

HasProductData

Boolean

Set this to true if you want to receive

only programs which provide product
data.

HasVoucherCodes

Boolean

Set this to true if you want to receive

only programs which provide at least
one voucher.

ProductDataUpdateInterval

Integer

The max amount of days which lie

between each product data update of
the programs. If you e.g. specify 7,
then the method returns all programs,
which update their product data at
least every 7th day or more often.

Publisher Webservices

Page 2

IsNew

Boolean

Restricts the programs to those,

which are featured as new in the
affilinet platform.

CommissionTypes

Array of
CommissionTypeEnum

Lets you restrict on the commission

mode of the programs.

1.1.3. CommissionTypeEnum
Property

Type

Description

CommissionTypeEnum

Enumeration

Lets you restrict on the commission mode of

the programs. Possible values are:
Click
ClickOut
Sale
Lead

1.1.4. SEMPolicyEnum
Property

Type

Description

SEMPolicyEnum

Enumeration

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)

Property

Type

Description

TrackingMethod

Enumeration

The tracking technology which shall be used in

the returned programs. Possible values are:
Cookie
Session
SessionCookie

1.1.5. TrackingMethod

Publisher Webservices

Page 3

1.1.6. ProgramPartnershipStatusEnum
Property

Type

Description

ProgramPartnership
StatusEnum

Enumeration

The status of the partnership you have with this

program. Possible values are:
Active
Paused
Waiting
Refused
NoPartnership
Cancelled

1.2. Return Types

1.2.1. GetProgramsResponse
Property

Type

Description

ProgramCollection

Array of Program

List of found programs.

TotalResults

Integer

The total amount of programs matching the given

search criteria.

1.2.2. Program
Property

Type

Description

ProgramId

Integer

The Id of the advertiser program

ProgramTitle

String

Title of the program

ProgramDescription

String

The program description

PartnershipStatus

String

The status of the partnership with this

program. Possible values are:
Active
Paused
Waiting
Refused
NoPartnership
Cancelled

ProgramClassificationEnum

String

The business type of the advertiser. Possible

values are:
Program
Campaign
All

LimitationsComment

String

A free text field where the advertiser lists

limitations on the partnership.

Publisher Webservices

Page 4

LaunchDate

DateTime

The day when the program has launched.

ProgramURL

String

A link to the home page of the program.

LogoURL

String

A link to the logo of the program, 120 by 40 px

in size.

TrackingMethod

String

The tracking technology used by the program.

Possible values are:
Cookie
Session
Sessioncookie

CookieLifetime

Integer

The number of days a cookie is valid for this

program.

ProgramCategoryIds

Array of integer

The program category Ids to which this

program is mapped. (
GetProgramCategories)

SEMPolicyEnum

String

The kind of restriction which the advertiser has

for SEM business. 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)

ProgramStatusEnum

String

The status in which this program currently is.

Possible values are:
Active
Paused

CommissionTypes

Array of
CommissionType
Detail

Information on the commissions paid by this

program.

ScreenshotURL

String

A URL under which a screenshot of the

program homepage can be reached.

Publisher Webservices

Page 5

1.2.3. CommissionTypeDetail
Property

Type

Description

CommissionTypeEnum

String

The commission mode this program has. Possible

values are:
Click
ClickOut
Sale
Lead

VolumeMin

Decimal

The minimum commission paid in this rate mode by

this program per transaction.

VolumeMax

Decimal

The maximum commission paid in this rate mode by

this program per transaction.

Unit

String

The unit of the values given in VolumeMax and

VolumeMin. Can be %, EUR or GBP.

Publisher Webservices

Page 6