api/progress

The progress of a category (or actually, challenges in a category) can be requested by a user.

Source:
See:

Members

(inner, constant) url :string

Source:

The URL for the category handler(s) to query for progress.

Type:
  • string

Methods

(static) getById(id, groupsopt, roleopt) → {Promise}

Source:

Get progress by its category id. The progress is returned for the current user if only the id is passed. If groups and or a role is passed it will return progress for all users from that group.

Parameters:
Name Type Attributes Default Description
id string

The category id.

groups Array | string <optional>
[]

The id's or id of the groups to get progress on.

role string <optional>
''

The id of the role that a user should be in.

Returns:
  • The promise for the organisation.
Type
Promise