Save Game play

post

https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/games/{gameLookupId}/plays

If playId is null it gets saved as a new Play, otherwise it overwrites the existing play

Path Params

space

string

required

The name of the space (database) assigned to you.

gameLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

dim

string

The Dimensions under which the calling application operates. Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

includeUnpublished

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

response

boolean

Defaults to false

If true, returns the saved content/resource. If false, the response content tag is not populated. Only set to true when the response payload is needed.

Body Params

memberId

string

required

When querying, returns Member Id. When saving also accepts member Lookup Id (email etc).

state

string

enum

required

Marks that a Game has started, finished or been saved for later.

Allowed:

score

int64

required

The final score. This is used to determine if the play should go on the highscore list, once the play is marked as FINISHED.

level

string

Optional, freetext. The current / final level

secondsPlayed

int32

Optional. For reporting only. The length of time the Member has been playing the Game for.

data

json

Optional Json data relating to this Game play

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK