Missions and Rewards

PreviousLeaderboards NextUser and Profiles

Deletes the Mission identified by id or by name

Deletes a mission by the passed in identifier

delete

/mission/{missionNameOrId}

Authorizations

Path parameters

missionNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/mission/{missionNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates an entire single Mission

Supplying a mission, this will update the Mission identified by the name or ID in the path with contents from the passed in request body.

put

/mission/{missionNameOrId}

Authorizations

Path parameters

missionNameOrIdanyrequired

Body

idanyrequired

The unique ID of the mission

nameanyrequired

The name of the mission

displayNameanyrequired

The display name for the mission

descriptionanyrequired

The description of the mission

finalRepeatStepobject

tagsany

metadataany

The metadata for this mission

stepsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/mission/{missionNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "metadata": null,
      "rewards": [
        "[Circular Reference]"
      ]
    },
    "tags": [],
    "metadata": null,
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "metadata": null,
        "rewards": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single Mission by id or by name

Looks up a mission by the passed in identifier

get

/mission/{missionNameOrId}

Authorizations

Path parameters

missionNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/mission/{missionNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new mission

Supplying a mission object, this will create a new mission with a newly assigned unique id. The Mission representation returned in the response body is a representation of the Mission as persisted with a unique identifier assigned and with its fields properly normalized. The supplied mission object submitted with the request must have a name property that is unique across all items.

post

/mission

Authorizations

Body

idanyrequired

The unique ID of the mission

nameanyrequired

The name of the mission

displayNameanyrequired

The display name for the mission

descriptionanyrequired

The description of the mission

finalRepeatStepobject

tagsany

metadataany

The metadata for this mission

stepsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/mission' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "metadata": null,
      "rewards": [
        "[Circular Reference]"
      ]
    },
    "tags": [],
    "metadata": null,
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "metadata": null,
        "rewards": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Search Missions

Searches all missions in the system and returning a number of matches against the given search filter, delimited by the offset and count.

get

/mission

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/mission' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Gets Rank Among all Players

Gets the current Profile's rank among all players for the particular leaderboard.

get

/progress

Authorizations

Responses

application/json

text/csv

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/progress' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new progress

Supplying a progress object, this will create a new progress with a newly assigned unique id. The Progress representation returned in the response body is a representation of the Progress as persisted with a unique identifier assigned and with its fields properly normalized.

post

/progress

Authorizations

Body

idanyrequired

The unique ID of the progress instance

profileobjectrequired

currentStepobject

remainingany

The remaining actions

missionobjectrequired

sequenceany

The current number of completed steps. Note that this may exceed the total number of steps, i.e. the final step may be repeated infinitely.

managedByScheduleany

Indicates that this progress is managed by a Schedule. If true, the Progress will be deleted when no schedules have the progress active. This will be true if the Progress was created as part of a Schedule.

rewardIssuancesany

Represents a Reward that has been issued but has not yet been claimed by the user. The reward is assigned a unique ID to ensure that it may not have been applied more than once.

schedulesany

scheduleEventsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/progress' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "profile": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "active": null,
        "facebookId": null,
        "firebaseId": null,
        "appleSignInId": null,
        "googleSignInId": null,
        "externalUserId": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "description": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "name": null,
        "applicationConfiguration": "[Circular Reference]",
        "attributes": null
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "lastModified": null,
        "state": "EMPTY"
      },
      "displayName": null,
      "lastLogin": null,
      "metadata": null
    },
    "currentStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "metadata": null,
      "rewards": [
        "[Circular Reference]"
      ]
    },
    "remaining": null,
    "mission": {
      "id": null,
      "name": null,
      "displayName": null,
      "description": null,
      "finalRepeatStep": {
        "displayName": null,
        "description": null,
        "count": null,
        "metadata": null,
        "rewards": "[Circular Reference]"
      },
      "tags": [],
      "metadata": null,
      "steps": [
        "[Circular Reference]"
      ]
    },
    "sequence": null,
    "managedBySchedule": null,
    "rewardIssuances": [
      {
        "id": null,
        "user": {
          "id": null,
          "name": null,
          "firstName": null,
          "lastName": null,
          "email": null,
          "primaryPhoneNb": null,
          "active": null,
          "facebookId": null,
          "firebaseId": null,
          "appleSignInId": null,
          "googleSignInId": null,
          "externalUserId": null,
          "level": "UNPRIVILEGED"
        },
        "item": "[Circular Reference]",
        "itemQuantity": null,
        "context": null,
        "source": null,
        "expirationTimestamp": null,
        "uuid": null,
        "state": "ISSUED",
        "type": "PERSISTENT",
        "metadata": null,
        "tags": []
      }
    ],
    "schedules": [
      {
        "displayName": null,
        "id": null,
        "name": null,
        "description": null
      }
    ],
    "scheduleEvents": [
      {
        "id": null,
        "begin": null,
        "end": null,
        "schedule": {
          "displayName": null,
          "id": null,
          "name": null,
          "description": null
        },
        "missions": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Deletes the Progress identified by id

Deletes a progress by the passed in identifier

delete

/progress/progress/{progressId}

Authorizations

Path parameters

progressIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/progress/progress/{progressId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Retrieves a single Progress by id

Looks up a progress by the passed in identifier

get

/progress/{progressId}

Authorizations

Path parameters

progressIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/progress/{progressId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates a single Progress

Supplying a progress, this will update the Progress identified by the ID in the path with contents from the passed in request body.

put

/progress/{progressId}

Authorizations

Path parameters

progressIdanyrequired

Body

idanyrequired

The unique ID of the progress instance

profileobjectrequired

currentStepobject

remainingany

The remaining actions

missionobjectrequired

sequenceany

The current number of completed steps. Note that this may exceed the total number of steps, i.e. the final step may be repeated infinitely.

managedByScheduleany

rewardIssuancesany

Represents a Reward that has been issued but has not yet been claimed by the user. The reward is assigned a unique ID to ensure that it may not have been applied more than once.

schedulesany

scheduleEventsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/progress/{progressId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "profile": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "active": null,
        "facebookId": null,
        "firebaseId": null,
        "appleSignInId": null,
        "googleSignInId": null,
        "externalUserId": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "description": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "name": null,
        "applicationConfiguration": "[Circular Reference]",
        "attributes": null
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "lastModified": null,
        "state": "EMPTY"
      },
      "displayName": null,
      "lastLogin": null,
      "metadata": null
    },
    "currentStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "metadata": null,
      "rewards": [
        "[Circular Reference]"
      ]
    },
    "remaining": null,
    "mission": {
      "id": null,
      "name": null,
      "displayName": null,
      "description": null,
      "finalRepeatStep": {
        "displayName": null,
        "description": null,
        "count": null,
        "metadata": null,
        "rewards": "[Circular Reference]"
      },
      "tags": [],
      "metadata": null,
      "steps": [
        "[Circular Reference]"
      ]
    },
    "sequence": null,
    "managedBySchedule": null,
    "rewardIssuances": [
      {
        "id": null,
        "user": {
          "id": null,
          "name": null,
          "firstName": null,
          "lastName": null,
          "email": null,
          "primaryPhoneNb": null,
          "active": null,
          "facebookId": null,
          "firebaseId": null,
          "appleSignInId": null,
          "googleSignInId": null,
          "externalUserId": null,
          "level": "UNPRIVILEGED"
        },
        "item": "[Circular Reference]",
        "itemQuantity": null,
        "context": null,
        "source": null,
        "expirationTimestamp": null,
        "uuid": null,
        "state": "ISSUED",
        "type": "PERSISTENT",
        "metadata": null,
        "tags": []
      }
    ],
    "schedules": [
      {
        "displayName": null,
        "id": null,
        "name": null,
        "description": null
      }
    ],
    "scheduleEvents": [
      {
        "id": null,
        "begin": null,
        "end": null,
        "schedule": {
          "displayName": null,
          "id": null,
          "name": null,
          "description": null
        },
        "missions": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single RewardIssuance by id.

get

/reward_issuance/{rewardIssuanceId}

Authorizations

Path parameters

rewardIssuanceIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/reward_issuance/{rewardIssuanceId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Retrieves the current user's reward issuances, optionally filtered by the given state.

get

/reward_issuance

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

statesany

tagsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/reward_issuance' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Redeems the RewardIssuance.

put

/reward_issuance/{rewardIssuanceId}/redeem

Authorizations

Path parameters

rewardIssuanceIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/reward_issuance/{rewardIssuanceId}/redeem' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Redeems the given list of RewardIssuances.

put

/reward_issuance/redeem

Authorizations

Body

any

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/reward_issuance/redeem' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '[]'

400

401

403

404

409

500

501

503

default

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

Search ScheduleEvents

Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.

get

/schedule/{scheduleNameOrId}/event

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new schedule

Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The ScheduleEvent representation returned in the response body is a representation of the ScheduleEvent as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

post

/schedule/{scheduleNameOrId}/event

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Body

beginany

endany

missionNamesOrIdsanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "begin": null,
    "end": null,
    "missionNamesOrIds": []
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single ScheduleEvent by id or by name

Looks up a schedule by the passed in identifier

get

/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

scheduleEventIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates an entire single ScheduleEvent

Supplying a schedule, this will update the ScheduleEvent identified by the name or ID in the path with contents from the passed in request body.

put

/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

scheduleEventIdanyrequired

Body

beginany

endany

missionNamesOrIdsanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "begin": null,
    "end": null,
    "missionNamesOrIds": []
  }'

400

401

403

404

409

500

501

503

default

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

Deletes the ScheduleEvent identified by id or by name

Deletes a schedule by the passed in identifier

delete

/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

scheduleEventIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Gets all Progresses assigned via this schedule

Fetches all current assignments to the currently logged-in profile.

get

/schedule/{scheduleNameOrId}/progress

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/progress' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Search Schedules

Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.

get

/schedule

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new schedule

Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The Schedule representation returned in the response body is a representation of the Schedule as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

post

/schedule

Authorizations

Body

displayNameanyrequired

descriptionanyrequired

nameanyrequired

Pattern: [^_]\w+

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/schedule' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "displayName": null,
    "description": null,
    "name": null
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single Schedule by id or by name

Looks up a schedule by the passed in identifier

get

/schedule/{scheduleNameOrId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates an entire single Schedule

Supplying a schedule, this will update the Schedule identified by the name or ID in the path with contents from the passed in request body.

put

/schedule/{scheduleNameOrId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Body

displayNameanyrequired

descriptionanyrequired

nameanyrequired

Pattern: [^_]\w+

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "displayName": null,
    "description": null,
    "name": null
  }'

400

401

403

404

409

500

501

503

default

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

Deletes the Schedule identified by id or by name

Deletes a schedule by the passed in identifier

delete

/schedule/{scheduleNameOrId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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