A-Z of methods

Building something? The A to Z of methods is your one-page reference cheat sheet. This is the fine grained list. For method grouping see Major Keyword Groups

Assessments

The assessment and assessments keywords provide the API consumer with GET request capability for retrieving information about one or more Promana assessments.

Assessment

Returns meta information and factors assessed by an assessment.

Assessments

Returns an object containing an iterable array Assessment of objects

Groups

When creating assessments for users it is often useful to be able to associate a user with some sort of group entity. Promana supports the creation of an ad-hoc hierarchy of groups of a specified type.

Creating groups

Create a group with or without a parent group.

Get group info

This method retrieves information about a group or a tree of groups. Use this method to obtain the members of a given group, its group type, group name, parent or children.

List groups (all)

Returns a nested representation of the groups attached to your organisation.

Occupations

Methods for working with Promana's list of ISCO-08 occupation types.

Occupations

Returns the full list of over 600 occupations.

Occupations: to depth

Returns a partial list of occupations to the depth specified.

Occupations: by group

Returns a partial list of occupations according to the group code identifier specified.

Surveys

Keywords for use in methods where an assessment is being, or has been, assigned to a user.

Survey: next

Provides three distinct phases of idempotent survey functionality

Surveys: Available

This request is designed to tell you how many “blank” surveys your organisation has

Surveys: reserve

Permits an organisation to increase its stock of assignable surveys.

Users

Methods for working with users individually and in bluk, including operations assigning assessments and for joining and leaving groups.

Listing Users

List users. Returns a collection of objects, each object representing a user, where the user is attached to your org.

Creating users

Promana provides a number of ways to create users, with optional automatic group assignment and other downstream effects.

User - get by UUID

This GET request expects a URL slug (represented by {UUID}). The UUID must belong to a user attached to your organisation.

User: Assign

A user can be assigned assessments with POST user/assign.

User: Join group

Joins a user to a group. Idempotent.

User: leave group

Causes a user to leave a group. Idempotent.