Stat.getEvaluations
From FreePokerAlliance wiki
Contents |
Description
Returns list of your evaluations.
Parameters
| Required | Name | Type | Default value | Description |
|---|---|---|---|---|
| required | Command | string | getEvaluations | API method name |
| required | Affiliate_ID | int | Your numeric affiliate ID (provided by our support team). |
Example Requests
Replace XXXXXXXXXX with actual data.
| Evaluations of affiliate_id 34: http://api.freepokeralliance.com/statservices.php?command=getevaluations&affiliate_id=34 |
Response
In the response XML, each <item> node has an attribute described here.
| Attribute name | Type | Description |
|---|---|---|
| id | int | Numeric evaluation ID. |
| type | string | The type of the evaluation (described on the bottom of this page). Can be any of the following: fixed, toprank, mosthands, mostwons, toprank_deltas, mosthands_deltas, mostwons_deltas. |
| frequency | string | Evaluation is done using this frequency. Can be any of the following: daily, weekly, monthly, yearly. |
| prize | string | The prize the winner will get. |
Response example
<?xml version="1.0" encoding="UTF-8"?>
<root> <evaluations> <item id="50" type="toprank_deltas" frequency="weekly" prize="$10"/> <item id="51" type="toprank_deltas" frequency="monthly" prize="$50"/> </evaluations> </root>
Error Codes
| Code | Description |
|---|---|
| <errormessage> | Node contains error message. Only set when an error occurs. |
Notes
Evaluation types are described below:
| Type | Description |
|---|---|
| fixed | Fixed prize winnings. If you want to give out prizes to your players when they reach certain levels of their balance, this is the type you will use. |
| toprank | All-time top ranking players are matched here. |
| mosthands | Players of all-time most played hands are matched here. |
| mostwons | Players of all-time most winning hands are matched here. |
| toprank_deltas | Top ranking players are matched here. (on a daily/weekly/etc basis) |
| mosthands_deltas | Players of most played hands are matched here. (on a daily/weekly/etc basis) |
| mostwons_deltas | Players of most winning hands are matched here. (on a daily/weekly/etc basis) |
Each winner is accepted once per evaluation.
