GetPpl
Updated on
Delivers the PPL datasets of the stated program that correspond with the consigned
filter criteria, as well as the ID of the newly-created export history entry.
Input
<GetPpl xmlns="http://services.zanox.com/erp">
<programid>10</programid>
<pplfilter xmlns="http://services.zanox.com/erp/Export">
<period from="2004-12-01T00:00:00+02:00"
to="2004-12-31T23:00:00+02:00"/>
<reviewstate negate="1">0</reviewstate>
<categoryid negate="1">TestKat</categoryid>
</pplfilter>
</GetPpl>
| Object | Data type | Description | Mandatory? |
|---|---|---|---|
<programid> |
int |
ID of the program whose data will be retrieved | x |
<pplfilter> | Filter criteria, which will be applied during the export | x | |
<period> | Export period | x | |
| from | datetime | Most recent time stamp of the dataset | x |
| to | datetime | Oldest time stamp of the dataset | x |
<reviewstate> | datetime | Review status of the dataset | |
| negate | boolean | Criterion <reviewstate> should • 0 = not be negated • 1 = be negated | |
<categoryid> | normalizedstring | Order ID of the dataset | |
| negate | boolean | Criterion <orderid> should • 0 = not be negated • 1 = be negated |
|
If the value of the "negate" attribute of the <reviewstate> or <categoryid> element is 1, all datasets that do not correspond with the condition will be exported.
Output
If the lock wait time has not yet expired and the user wishes to carry out a new data export,
the request will be terminated with an error (refer to <locktime> element in GetUserPrograms).
| Object | Data type | Description |
|---|---|---|
| <historyid> | int | History ID that was created for the export process |
Otherwise, zanox ERP Web Services delivers the following data:
<GetPplResponse xmlns="http://services.zanox.com/erp">
<historyid>1</historyid>
<ppldata>
<ppl id="1a913cde-1b27-40cd-a9fe-99dfb7351882" trackingtype="4" cookie_id="0" xmlns="http://services.zanox.com/erp/Export">
<click timestamp="2004-06-18 12:20:58"/>
<request timestamp="2004-06-18 12:16:28"/>
<program id="10"/>
<order id="1396525"/>
<customer id="285796"/>
<category id="Ihre-Kategorie"/>
<session id="Sess01"/>
<expiration date="2005-02-12 12:00:12"/>
<affiliate code="829057C1355136413S66656">
<commission currency="EUR">0.66</commission>
<username>Affiliate</username>
<website>http://www.affiliate.de</website>
</affiliate>
<subaffiliate id="21">
<commission currency="EUR">0.20</commission>
</subaffiliate>
<review state="0" date="2005-01-02 21:22:00">ReviewText</review>
<commission fix="0.20"/>
</ppl>
...
</ppldata>
</GetPplResponse>
| Object | Data type | Description |
|---|---|---|
<ppldata> | ||
<ppl> | ||
| id | normalizedstring | Unique ID of the PPL dataset (GUID) |
| trackingtype | unsignedbyte | Tracking type for which the dataset was tracked |
<click> | ||
| timestamp | datetime | Time stamp of the click |
<request> | ||
| timestamp | datetime | Time stamp of the request |
<program> | ||
| id | int | ID of the program to which the dataset pertains |
<order> | ||
| id | normalizedstring | Order ID |
<customer> | ||
| id | normalizedstring | Customer ID |
<category> | ||
| id | normalizedstring | Category ID |
<session> | ||
| id | normalizedstring | Session ID |
<expiration> | ||
| date | datetime | Expiration date |
<affiliate> | ||
| code | normalizedstring | Complete partner ID in xxxCxxxSxxx format ("Sxxx" is optional) |
<commission> | decimal | Publisher commission |
| currency | normalizedstring | Currency of the publisher commission |
<username> | normalizedstring | User's login name |
<website> | normalizedstring | User's homepage |
<subaffiliate> | ||
| id | normalizedstring | Sub-affiliate ID |
<commission> | decimal | Sub-affiliate commission |
| currency | normalizedstring | Currency of the sub-affiliate commission |
<review> | string | Review text |
| state | int | Review status • 0 = open • 1 = approved • 2 = rejected |
| date | datetime | Review date |
<commission> | ||
| fix | decimal | Fixed commission in the program currency |
Resource Information
| Rate Limited? | No |
| Requests per rate limit window | N/A |
| Authentication | Requires Authentication |
| Response Formats | xml |
| Resource family | ppldata |
| Response Object | ppl |
| API Version | 3.0.1.1 |
If the value for <historyid>