/score

Creates a New Score

Posts a single score for the currently logged-in profile. Conceptually, this is creationg a new resource, however the server may opt to overwrite the existing identifier if it sees fit.

post

/score/{leaderboardNameOrId}

Authorizations

auth_bearersession_secret

Path parameters

leaderboardNameOrIdanyrequired

The name or id of the leaderboard.

Body

idanyrequired

The ID of the Score

profileobjectrequired

pointValueany

The point value of the score.

scoreUnitsany

The the units of measure for the points. For example, if the points in the game were called "coins" instead of "points" this would be used to designate as such in the UI.

creationTimestampanyrequired

The time at which the score was created on the server.

leaderboardEpochanyrequired

The epoch to which the score belongs for the associated leaderboard. By convention, if the leaderboard is all-time, this value will be set to zero.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/score/{leaderboardNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": null,
    "profile": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "name": null,
        "description": null,
        "gitBranch": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": "[Circular Reference]"
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "state": "EMPTY",
        "lastModified": null
      },
      "displayName": null,
      "metadata": null,
      "lastLogin": null
    },
    "pointValue": null,
    "scoreUnits": null,
    "creationTimestamp": null,
    "leaderboardEpoch": null
  }'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}