Missions and Rewards | Elements Manual

Deletes the Mission identified by id or by name

Deletes a mission by the passed in identifier

DELETEhttp://localhost:8080/api/rest/mission/{missionNameOrId}

Path parameters

missionNameOrId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/mission/{missionNameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

PUThttp://localhost:8080/api/rest/mission/{missionNameOrId}

Path parameters

missionNameOrId*any

Body

id*any

The unique ID of the mission

name*any

The name of the mission

displayName*any

The display name for the mission

description*any

The description of the mission

tagsany

The tags used to categorize this mission

stepsany

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

finalRepeatStepStep (object)

metadataany

The metadata for this mission

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/mission/{missionNameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Retrieves a single Mission by id or by name

Looks up a mission by the passed in identifier

GEThttp://localhost:8080/api/rest/mission/{missionNameOrId}

Path parameters

missionNameOrId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/mission/{missionNameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

POSThttp://localhost:8080/api/rest/mission

Body

id*any

The unique ID of the mission

name*any

The name of the mission

displayName*any

The display name for the mission

description*any

The description of the mission

tagsany

The tags used to categorize this mission

stepsany

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

finalRepeatStepStep (object)

metadataany

The metadata for this mission

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/mission', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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.

GEThttp://localhost:8080/api/rest/mission

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/mission', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Gets Rank Among all Players

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

GEThttp://localhost:8080/api/rest/progress

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/progress', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

POSThttp://localhost:8080/api/rest/progress

Body

id*any

The unique ID of the progress instance

profile*Profile (object)

currentStepStep (object)

remainingany

The remaining actions

mission*ProgressMissionInfo (object)

rewardIssuancesany

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

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.

schedulesany

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

scheduleEventsany

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

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/progress', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "mission": {},
      "profile": {
        "application": {},
        "user": {
          "level": "UNPRIVILEGED"
        }
      }
    }),
});
const data = await response.json();

Response

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

Deletes the Progress identified by id

Deletes a progress by the passed in identifier

DELETEhttp://localhost:8080/api/rest/progress/progress/{progressId}

Path parameters

progressId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/progress/progress/{progressId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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

Retrieves a single Progress by id

Looks up a progress by the passed in identifier

GEThttp://localhost:8080/api/rest/progress/{progressId}

Path parameters

progressId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/progress/{progressId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

PUThttp://localhost:8080/api/rest/progress/{progressId}

Path parameters

progressId*any

Body

id*any

The unique ID of the progress instance

profile*Profile (object)

currentStepStep (object)

remainingany

The remaining actions

mission*ProgressMissionInfo (object)

rewardIssuancesany

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

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.

schedulesany

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

scheduleEventsany

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

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/progress/{progressId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "mission": {},
      "profile": {
        "application": {},
        "user": {
          "level": "UNPRIVILEGED"
        }
      }
    }),
});
const data = await response.json();

Response

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

Retrieves a single RewardIssuance by id.

GEThttp://localhost:8080/api/rest/reward_issuance/{rewardIssuanceId}

Path parameters

rewardIssuanceId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/reward_issuance/{rewardIssuanceId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

GEThttp://localhost:8080/api/rest/reward_issuance

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/reward_issuance', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Redeems the RewardIssuance.

PUThttp://localhost:8080/api/rest/reward_issuance/{rewardIssuanceId}/redeem

Path parameters

rewardIssuanceId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/reward_issuance/{rewardIssuanceId}/redeem', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

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

Redeems the given list of RewardIssuances.

PUThttp://localhost:8080/api/rest/reward_issuance/redeem

Body

any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/reward_issuance/redeem', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
});
const data = await response.json();

Response

{
  "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.

GEThttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event

Path parameters

scheduleNameOrId*any

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

POSThttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event

Path parameters

scheduleNameOrId*any

Body

beginany

endany

missionNamesOrIds*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Retrieves a single ScheduleEvent by id or by name

Looks up a schedule by the passed in identifier

GEThttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Path parameters

scheduleNameOrId*any

scheduleEventId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

PUThttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Path parameters

scheduleNameOrId*any

scheduleEventId*any

Body

beginany

endany

missionNamesOrIds*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Deletes the ScheduleEvent identified by id or by name

Deletes a schedule by the passed in identifier

DELETEhttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Path parameters

scheduleNameOrId*any

scheduleEventId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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

Gets all Progresses assigned via this schedule

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

GEThttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}/progress

Path parameters

scheduleNameOrId*any

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/progress', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

GEThttp://localhost:8080/api/rest/schedule

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

POSThttp://localhost:8080/api/rest/schedule

Body

name*any

Pattern: [^_]\w+

displayName*any

description*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Retrieves a single Schedule by id or by name

Looks up a schedule by the passed in identifier

GEThttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}

Path parameters

scheduleNameOrId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

PUThttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}

Path parameters

scheduleNameOrId*any

Body

name*any

Pattern: [^_]\w+

displayName*any

description*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Deletes the Schedule identified by id or by name

Deletes a schedule by the passed in identifier

DELETEhttp://localhost:8080/api/rest/schedule/{scheduleNameOrId}

Path parameters

scheduleNameOrId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/schedule/{scheduleNameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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