PfP keywords used in requests
PfP is a system for
- displaying assessments,
- creating “sessions” that permit your end users to be assigned the assessments as “respondents”,
- complete the assigned assessments, which are delivered in the form of a survey,
- retrieving reports, which deliver the results computed by PfP based on respondent inputs
To avoid confusing these three phases of interaction, PfP uses three different keywords to effectively namespace the available functionalities.
assessment keyword, and its plural,
assessments, are used to retrieve information about one assessment, or all assessments. A typical use case would be when an API-consuming organisation wants to display a list of available assessments on its own website, or, create a single view where one assessment, its 12 factors and their associated descriptions are shown.
See Listing Assessments.
assignment keyword is used to assign previously-reserved assessments from an API consumer’s cache of blank/empty surveys. Assessments can be assigned to respondents (individuals or groups of individuals). Assignments can be designed to pertain to the respondent, to another individual, to a group that the respondent belongs to or to another group.
This keyword is used to request blank, or empty surveys in batches of 1-n. An API consumer, depending on the parameters on their individual PfP terms of business, will use the
surveys keywords to place orders, and select assessments to assign to their end-users.
Generated results can be retrieved in the form of a report or reports. The “report” keyword is used in the
reports namespace to define and retrieve these reports in various formats.