Versions Compared

Old Version 5

changes.mady.by.user Nick Jensen

Saved on

compared with

New Version Current

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

Evaluates a loyalty scheme for a user an entity


 
Endpoint ID:60021050
Method:
Status
colourGreen
titlePOST
URL:

/servicesloyalty/scheme/evaluate/dp-keyentity/id/{dpentity-keyid}/scheme/{scheme-id}/evaluate

/servicesloyalty/scheme/evaluateentity/ext-key/{ext-key}/{ext-type}/scheme/{scheme-id}/evaluate


 dpentity-keydialogportal™ master key id

Rubiq entity ID that uniquely identifies an account to evaluate the scheme for


ext-key

External key that uniquely identifies an account to evaluate the scheme for

 


ext-typeType of external key 

scheme-idNumeric 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
stylewhite-space:pre

Response body:


JSON data with information about the evaluation result

Code Block
titleExample
{
	"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
            }
        }
    ]
}


Possible CampaignResult.PointType options
StandardPoints
MultiplicationFactor
AdditionalPoints


Status codes:200

Evaluation completed successfully

 


404

The account entity or loyalty scheme were not found

The following sub codes may be returned:

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


...