get https://api.accelevents.com/rest/event//leaderboard/challenges
This API is used to get a list of challenge names with the specified event.
It will return data like users, description, endDate, startDate, name, goal, event challenge Id, etc.
To call this API, a user has to pass eventUrl as a query param with an authentication key to authenticate the user.
Response
Here is the description of response attributes, which returns to the form of JSON.
| Attribute | Description |
|---|---|
| description | Contains a description of the challenge. |
| endDate | This will return the end date for the challenge. e.g. 2021-12-29T04:36:15.616Z |
| users | This will return the list of users details like: firstName: Contains the first name of the user. Only 50 characters are allowed in the first name. lastName: Contains the last name of user. Only 50 characters are allowed in the last name. photo : Contains the photo of the user. point: Contains the number of points of the user. userId :The ID returns a unique value associated with the user. title: Contains the title of the user. |
| eventChallengeId | This represents the unique ID of each challenge. |
| goal | This will return the goal of the challenge. |
| name | Contains the name of the challenge. |
| rewards | This will return the rewards for completing the challenge. |
| startDate | This will return the start date for challenge. e.g. 2021-12-29T04:36:15.616Z |
Error Code
Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.
| Error Code | Error Description |
|---|---|
| 400 | The request could not be understood by the server due to malformed syntax. |
| 401 | You are not authorized to view the resource. |
| 403 | Accessing the resource you were trying to reach is forbidden. |
| 404 | The resource you were trying to reach is not found. |
| 40600013 | Cannot create url |
| 4040200 | No event could be found |