Page Comparison

...

Endpoint ID:

6002

Method:

Status

colour	Green
title	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

Code Block
{ "tags": [ 5, 6, 9 ] }

Span

style	white-space:pre

Response body:

JSON data with information about the evaluation result

Code Block

title	Example

{
	"points": 58.5,
	"noFiltersMatched": false,
	"campaignFilterMatched": true,
    "campaignResult": {
        "pointType": "MultiplicationFactor",
        "pointModifier": 2,
        "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
            }
        }
    ]
}

Possible CampaignResult.PointType options
StandardPoints
MultiplicationFactor
AdditionalPoints

Status codes:

200

Evaluation completed successfully

404

The account or loyalty scheme were not found

The following sub codes may be returned:

404.1	User not found
404.2	External user could not be found
404.4	Loyalty scheme not found

Versions Compared

Old Version 2

New Version 3

Key