/progress

Previous/mission Next/reward_issuance

Last updated 1 month ago

Deletes the Progress identified by id

delete

Deletes a progress by the passed in identifier

Authorizations

Path parameters

progressIdanyrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/rest/progress/progress/{progressId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

objectoptional

application/json

get

GET /api/rest/progress/{progressId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

objectoptional

application/json

text/csv

get

GET /api/rest/progress HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

objectoptional

application/json

post

POST /api/rest/progress HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 3465

{
  "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": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": {
            "id": null,
            "category": "MATCHMAKING",
            "uniqueIdentifier": null,
            "parent": "[Circular Reference]",
            "productBundles": [
              {
                "productId": null,
                "displayName": null,
                "description": null,
                "productBundleRewards": [
                  {
                    "itemId": null,
                    "quantity": null
                  }
                ],
                "metadata": null,
                "display": null
              }
            ]
          }
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "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": [
      {
        "item": {
          "id": null,
          "name": null,
          "tags": [],
          "displayName": null,
          "description": null,
          "category": "FUNGIBLE",
          "metadataSpec": {
            "id": null,
            "name": null,
            "type": "STRING",
            "properties": "[Circular Reference]"
          },
          "metadata": null,
          "publicVisible": null
        },
        "quantity": null,
        "metadata": null
      }
    ],
    "metadata": null
  },
  "remaining": null,
  "mission": {
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": [
          {
            "item": {
              "id": null,
              "name": null,
              "tags": [],
              "displayName": null,
              "description": null,
              "category": "FUNGIBLE",
              "metadataSpec": {
                "id": null,
                "name": null,
                "type": "STRING",
                "properties": "[Circular Reference]"
              },
              "metadata": null,
              "publicVisible": null
            },
            "quantity": null,
            "metadata": null
          }
        ],
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        {
          "item": {
            "id": null,
            "name": null,
            "tags": [],
            "displayName": null,
            "description": null,
            "category": "FUNGIBLE",
            "metadataSpec": {
              "id": null,
              "name": null,
              "type": "STRING",
              "properties": "[Circular Reference]"
            },
            "metadata": null,
            "publicVisible": null
          },
          "quantity": null,
          "metadata": null
        }
      ],
      "metadata": null
    },
    "tags": [],
    "metadata": null
  },
  "rewardIssuances": [
    {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "level": "UNPRIVILEGED"
      },
      "state": "ISSUED",
      "item": {
        "id": null,
        "name": null,
        "tags": [],
        "displayName": null,
        "description": null,
        "category": "FUNGIBLE",
        "metadataSpec": {
          "id": null,
          "name": null,
          "type": "STRING",
          "properties": "[Circular Reference]"
        },
        "metadata": null,
        "publicVisible": null
      },
      "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": [
        {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null,
          "tags": [],
          "steps": [
            "[Circular Reference]"
          ],
          "finalRepeatStep": {
            "displayName": null,
            "description": null,
            "count": null,
            "rewards": "[Circular Reference]",
            "metadata": null
          },
          "metadata": null
        }
      ]
    }
  ]
}

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

objectoptional

application/json

put

PUT /api/rest/progress/{progressId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 3465

{
  "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": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": {
            "id": null,
            "category": "MATCHMAKING",
            "uniqueIdentifier": null,
            "parent": "[Circular Reference]",
            "productBundles": [
              {
                "productId": null,
                "displayName": null,
                "description": null,
                "productBundleRewards": [
                  {
                    "itemId": null,
                    "quantity": null
                  }
                ],
                "metadata": null,
                "display": null
              }
            ]
          }
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "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": [
      {
        "item": {
          "id": null,
          "name": null,
          "tags": [],
          "displayName": null,
          "description": null,
          "category": "FUNGIBLE",
          "metadataSpec": {
            "id": null,
            "name": null,
            "type": "STRING",
            "properties": "[Circular Reference]"
          },
          "metadata": null,
          "publicVisible": null
        },
        "quantity": null,
        "metadata": null
      }
    ],
    "metadata": null
  },
  "remaining": null,
  "mission": {
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": [
          {
            "item": {
              "id": null,
              "name": null,
              "tags": [],
              "displayName": null,
              "description": null,
              "category": "FUNGIBLE",
              "metadataSpec": {
                "id": null,
                "name": null,
                "type": "STRING",
                "properties": "[Circular Reference]"
              },
              "metadata": null,
              "publicVisible": null
            },
            "quantity": null,
            "metadata": null
          }
        ],
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        {
          "item": {
            "id": null,
            "name": null,
            "tags": [],
            "displayName": null,
            "description": null,
            "category": "FUNGIBLE",
            "metadataSpec": {
              "id": null,
              "name": null,
              "type": "STRING",
              "properties": "[Circular Reference]"
            },
            "metadata": null,
            "publicVisible": null
          },
          "quantity": null,
          "metadata": null
        }
      ],
      "metadata": null
    },
    "tags": [],
    "metadata": null
  },
  "rewardIssuances": [
    {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "level": "UNPRIVILEGED"
      },
      "state": "ISSUED",
      "item": {
        "id": null,
        "name": null,
        "tags": [],
        "displayName": null,
        "description": null,
        "category": "FUNGIBLE",
        "metadataSpec": {
          "id": null,
          "name": null,
          "type": "STRING",
          "properties": "[Circular Reference]"
        },
        "metadata": null,
        "publicVisible": null
      },
      "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": [
        {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null,
          "tags": [],
          "steps": [
            "[Circular Reference]"
          ],
          "finalRepeatStep": {
            "displayName": null,
            "description": null,
            "count": null,
            "rewards": "[Circular Reference]",
            "metadata": null
          },
          "metadata": null
        }
      ]
    }
  ]
}

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