Top

Invites

Post Invites
POST /app/api/account/invite/
Generates an invite URL on behalf of API caller account or one of its subaccounts. The customer that wants to invite new user to take specific assessment test on PK3 site, sends the request and passes the parameters as specified in the doc (the user identity, the assessment ID and so on). The PK3 Web service executes the request, generates the invite URL and returns it to the caller as the 'link' parameter of the response. Next, the user can copy the URL in the address field of his/her Internet browser and press 'Enter'. Alternatively, a client Web application can automatically open the invite URL in the new browser window or in the iFrame of the existing browser window. If the ‘participant’ flag is set, the user will be automatically logged into PK site and redirected to the beginning of the assessment test. If the same invite URL for the ‘participant’ user is used more than once, the user is redirected to the page of the assessment test where the test was dropped (or to the final page of the assessment, if the test was completed).

Post Invite

POST  /app/api/account/invite/

Generates an invite URL on behalf of API caller account or one of its subaccounts. The customer that wants to invite new user to take specific assessment test on PK3 site, sends the request and passes the parameters as specified in the doc (the user identity, the assessment ID and so on). The PK3 Web service executes the request, generates the invite URL and returns it to the caller as the 'link' parameter of the response. Next, the user can copy the URL in the address field of his/her Internet browser and press 'Enter'. Alternatively, a client Web application can automatically open the invite URL in the new browser window or in the iFrame of the existing browser window. If the ‘participant’ flag is set, the user will be automatically logged into PK site and redirected to the beginning of the assessment test. If the same invite URL for the ‘participant’ user is used more than once, the user is redirected to the page of the assessment test where the test was dropped (or to the final page of the assessment, if the test was completed).

HTTP Form Parameters

account_id int (12)
ID of the account.
email string (255)
user email (login).
expire_date Data type and Length
[optional] the date invite URL expires on. Invite URL never expires, if not specified.What Format???
category string (255)
[optional] account membership category.
role int (11)
user role in the account. [owner | manager | member]. User is assigned a ‘member’ role, if not specified.
name string (255)
new user name (nick).
allow_view Boolean
[optional] the flag indicates the user can see the assessment results [0 | 1]. Flag is not set by default.
exit_url String (Length)
[optional] custom URL the user is redirected to after completion of the assessment.
allow_email Boolean
the flag indicates the system sends email notification to account managers on completion of the assessment [0 | 1]. Flag is not set by default.
participant Boolean
[optional] the flag indicates the new user is automatically signed on into the system when it enters the site via this invite URL [0 | 1 ]. Flag is not set by default.
assessment_id Data type and Length
ID of the assessment the new user is granted rights to pass.
tags JSON array
[optional]
{
    tag_list = [...]
}
tag_list String (??)
list of tags to be associated with the user record. If the user already exists, the list of tags will be merged with the list of existing tags for this user. New account tags are created if needed.

Response - JSON Array

link Data type and Length
invite URL

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
      "link": "link example" 
    }