Evaluates a loyalty scheme for a user
| Endpoint ID: | 6002 | |||||||
| Method: | POST | |||||||
| URL: | /services/scheme/evaluate/dp-key/{dp-key}/{scheme-id} /services/scheme/evaluate/ext-key/{ext-key}/{ext-type}/{scheme-id} | |||||||
| dp-key | dialogportal™ master key that uniquely identifies account to evaluate the scheme for | |||||||
| ext-key | External key that uniquely identifies account to evaluate the scheme for | |||||||
| ext-type | Type of external key | |||||||
| scheme-id | Numeric value identifying the loyalty scheme that should be evaluated | |||||||
| Request body: | JSON data containing the tags that should be evaluated {
"tags": [ 5, 6, 9 ]
}
| |||||||
Response body: | JSON data with information about the evaluation result Example {
"points": 58.5,
"noFiltersMatched": false,
"campaignFilterMatched": true,
"campaignResult": {
"pointType": "MultiplicationFactor",
"pointModifier": 1.5,
"filterID": 87,
"name": "Standard filter",
"points": 58.5,
"comment": "Earned honestly",
"returnTag": {
"schemeID": 22,
"label": "label1",
"resultTagID": 11
}
},
"standardResults": [
{
"filterID": 87,
"name": "Standard filter",
"points": 58.5,
"comment": "Earned honestly",
"returnTag": {
"schemeID": 22,
"label": "label1",
"resultTagID": 11
}
}
]
}
| |||||||
| Status codes: | 200 | Evaluation completed successfully | ||||||
| 404 | The account or loyalty scheme were not found The following sub codes may be returned:
| |||||||