Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use /entity routing instead of /user


Excerpt

Register a participant in instant winThere are 2 tables  where we define a instant win competition.

  1. INSTANTWIN - defines an competition. Field PUBLICID (guid) is a public reference to a competition. Field MAXNOOFTRYPERENTITY define how meny times same person can perticipate in the same competition. Field MAXNOOFGAINSPERENTITY define how many gains same person can win in a competition.
  2. Table INSTANTWINGAIN define gains for a competition. There can be more then 1 gain per competition. Field INSTANTWINID connect gain table to instanwin table. Fields MAXNOOFGAINS defines maximal number of gains to win. Field DRAWFREQUENCY defines how offen there is a winner. 



Endpoint ID:2200
Method:

Status
colourGreen
titleGET

URL:

loyalty/

instantwin

entity/

{apiID}/

id/{entityID}

loyalty

/instantwin/{apiID}

loyalty/entity/

iext

ext-key/{ext-key}/{ext-type}

apiIDA GUID string identifier for the instant win

/instantwin/{apiID}


entityIDdialogportal™ master key that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

apiID

A GUID string identifier for the instant win

Request body:None


Span
stylewhite-space: nowrap
Response body:


JSON data with information about winner status

Code Block
titleloyalty/instantwin –
participient
participant won
{
    "winner": 
ture
true,
    
"details": {

        "id": 
"
1
"
,

        "name": "Some 
gain
prize",

        "description": "
This
An explanation 
explains
of 
these
the 
gain
prize",
        
"
noofparticipients
numParticipants": 34,
        
"
noofwinners
numWinners": 3
    
}

]
}


Code Block
titleloyalty/instantwin –
participient
participant lost
{
    "winner": false
,

"details": "" ]
}


Status codes:200OK

404

Not found

The following sub-codes may be returned:

404.1User not found
404.2External user could not be found
404.4Instant win gain not found
404.
2
5Instant win
gain
not found
500



400.
3
1
Server erreor
Invalid data