Missions and Rewards

PreviousLeaderboards NextUser and Profiles

Last updated 7 months ago

Retrieves a single Mission by id or by name

get

Looks up a mission by the passed in identifier

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"
}

Search Missions

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

tagsanyoptional

searchanyoptional

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

get

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

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"
}

Deletes the Progress identified by id

delete

Deletes a progress by the passed in identifier

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

get

Looks up a progress by the passed in identifier

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"
}

Retrieves a single RewardIssuance by id.

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

statesanyoptional

tagsanyoptional

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

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"
}

Search ScheduleEvents

get

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

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Query parameters

offsetany · default: 0optional

countany · default: 20optional

tagsanyoptional

searchanyoptional

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"
}

Retrieves a single ScheduleEvent by id or by name

get

Looks up a schedule by the passed in identifier

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"
}

Deletes the ScheduleEvent identified by id or by name

delete

Deletes a schedule by the passed in identifier

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

get

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

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Query parameters

offsetany · default: 0optional

countany · default: 20optional

tagsanyoptional

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

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

tagsanyoptional

searchanyoptional

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"
}

Retrieves a single Schedule by id or by name

get

Looks up a schedule by the passed in identifier

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"
}

Deletes the Schedule identified by id or by name

delete

Deletes a schedule by the passed in identifier

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"
}

Deletes the Mission identified by id or by name

delete

Deletes a mission by the passed in identifier

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

put

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.

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

tagsanyoptional

The tags used to categorize this mission

stepsanyoptional

The steps that constitute the mission (may be null if finalRepeatStep is specified)

finalRepeatStepobjectoptional

metadataanyoptional

The metadata for this mission

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,
    "tags": [],
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

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

Creates a new mission

post

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.

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

tagsanyoptional

The tags used to categorize this mission

stepsanyoptional

The steps that constitute the mission (may be null if finalRepeatStep is specified)

finalRepeatStepobjectoptional

metadataanyoptional

The metadata for this mission

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,
    "tags": [],
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

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

Creates a new progress

post

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.

Authorizations

Body

idanyrequired

The unique ID of the progress instance

profileobjectrequired

currentStepobjectoptional

remaininganyoptional

The remaining actions

missionobjectrequired

rewardIssuancesanyoptional

List of all reward issuances that are issued but not expired, or redeemed but persistent.

sequenceanyoptional

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.

managedByScheduleanyoptional

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.

schedulesanyoptional

A listing of the Schedules which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

scheduleEventsanyoptional

A listing of ScheduleEvents which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

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,
        "level": "UNPRIVILEGED",
        "active": null,
        "facebookId": null,
        "firebaseId": null,
        "appleSignInId": null,
        "googleSignInId": null,
        "externalUserId": null
      },
      "application": {
        "id": null,
        "name": null,
        "description": 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
    },
    "currentStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "remaining": null,
    "mission": {
      "id": null,
      "name": null,
      "displayName": null,
      "description": null,
      "steps": [
        "[Circular Reference]"
      ],
      "finalRepeatStep": {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      },
      "tags": [],
      "metadata": null
    },
    "rewardIssuances": [
      {
        "id": null,
        "user": {
          "id": null,
          "name": null,
          "firstName": null,
          "lastName": null,
          "email": null,
          "primaryPhoneNb": null,
          "level": "UNPRIVILEGED",
          "active": null,
          "facebookId": null,
          "firebaseId": null,
          "appleSignInId": null,
          "googleSignInId": null,
          "externalUserId": null
        },
        "state": "ISSUED",
        "item": "[Circular Reference]",
        "itemQuantity": null,
        "context": null,
        "type": "PERSISTENT",
        "source": null,
        "metadata": null,
        "tags": [],
        "expirationTimestamp": null,
        "uuid": null
      }
    ],
    "sequence": null,
    "managedBySchedule": null,
    "schedules": [
      {
        "id": null,
        "name": null,
        "displayName": null,
        "description": null
      }
    ],
    "scheduleEvents": [
      {
        "id": null,
        "begin": null,
        "end": null,
        "schedule": {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null
        },
        "missions": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Updates a single Progress

put

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

Authorizations

Path parameters

progressIdanyrequired

Body

idanyrequired

The unique ID of the progress instance

profileobjectrequired

currentStepobjectoptional

remaininganyoptional

The remaining actions

missionobjectrequired

rewardIssuancesanyoptional

List of all reward issuances that are issued but not expired, or redeemed but persistent.

sequenceanyoptional

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.

managedByScheduleanyoptional

schedulesanyoptional

A listing of the Schedules which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

scheduleEventsanyoptional

A listing of ScheduleEvents which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

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,
        "level": "UNPRIVILEGED",
        "active": null,
        "facebookId": null,
        "firebaseId": null,
        "appleSignInId": null,
        "googleSignInId": null,
        "externalUserId": null
      },
      "application": {
        "id": null,
        "name": null,
        "description": 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
    },
    "currentStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "remaining": null,
    "mission": {
      "id": null,
      "name": null,
      "displayName": null,
      "description": null,
      "steps": [
        "[Circular Reference]"
      ],
      "finalRepeatStep": {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      },
      "tags": [],
      "metadata": null
    },
    "rewardIssuances": [
      {
        "id": null,
        "user": {
          "id": null,
          "name": null,
          "firstName": null,
          "lastName": null,
          "email": null,
          "primaryPhoneNb": null,
          "level": "UNPRIVILEGED",
          "active": null,
          "facebookId": null,
          "firebaseId": null,
          "appleSignInId": null,
          "googleSignInId": null,
          "externalUserId": null
        },
        "state": "ISSUED",
        "item": "[Circular Reference]",
        "itemQuantity": null,
        "context": null,
        "type": "PERSISTENT",
        "source": null,
        "metadata": null,
        "tags": [],
        "expirationTimestamp": null,
        "uuid": null
      }
    ],
    "sequence": null,
    "managedBySchedule": null,
    "schedules": [
      {
        "id": null,
        "name": null,
        "displayName": null,
        "description": null
      }
    ],
    "scheduleEvents": [
      {
        "id": null,
        "begin": null,
        "end": null,
        "schedule": {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null
        },
        "missions": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Redeems the given list of RewardIssuances.

put

Authorizations

Body

anyoptional

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"
}

Creates a new schedule

post

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.

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Body

beginanyoptional

endanyoptional

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"
}

Updates an entire single ScheduleEvent

put

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.

Authorizations

Path parameters

scheduleNameOrIdanyrequired

scheduleEventIdanyrequired

Body

beginanyoptional

endanyoptional

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"
}

Creates a new schedule

post

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.

Authorizations

Body

nameanyrequired

Pattern: [^_]\w+

displayNameanyrequired

descriptionanyrequired

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 '{
    "name": null,
    "displayName": null,
    "description": null
  }'

400

401

403

404

409

500

501

503

default

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

Updates an entire single Schedule

put

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.

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Body

nameanyrequired

Pattern: [^_]\w+

displayNameanyrequired

descriptionanyrequired

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 '{
    "name": null,
    "displayName": null,
    "description": null
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single Mission by id or by name

Search Missions

Gets Rank Among all Players

Deletes the Progress identified by id

Retrieves a single Progress by id

Retrieves a single RewardIssuance by id.

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

Redeems the RewardIssuance.

Search ScheduleEvents

Retrieves a single ScheduleEvent by id or by name

Deletes the ScheduleEvent identified by id or by name

Gets all Progresses assigned via this schedule

Search Schedules

Retrieves a single Schedule by id or by name

Deletes the Schedule identified by id or by name

Deletes the Mission identified by id or by name

Updates an entire single Mission

Show child attributes

Creates a new mission

Show child attributes

Creates a new progress

Show child attributes

Show child attributes

Show child attributes

Updates a single Progress

Show child attributes

Show child attributes

Show child attributes

Redeems the given list of RewardIssuances.

Creates a new schedule

Updates an entire single ScheduleEvent

Creates a new schedule

Updates an entire single Schedule