PUT test/…/accesses/…/…

Links a test definition to an organization, group or user, or modifies the properties of an existing link.

Optionally, an objective can be configured for the linked test. The objective is the (review) date that all testees of the test are required to have completed the test. If PER_USER is used as review date, a review date can be configured per individual testee. This is done through a separate API call.

If an objective is specified, it is possible to specify a reminder date. If the testee has not completed the test by this date, he will receive a reminder of the upcoming review date.

If an objective is specified, it is possible to initiate an announcement message, informing all testees that they are expected to complete the test before the review date.

An objective can be configured on an existing test definition link, if it does not have an objective yet. If an existing test definition link is specified without configuring an objective, an error will be returned, indicating that the link already exists.

When linking to a group, it is possible to configure a maximum number of test renditions per user.

Resource URL

https://www.drillster.com/api/2.1.1/test/{test_id}/accesses/{type}/{id}

Parameters

Field Type Description
test_id
required		 String The ID of the test definition.
type
required		 String constant Represents the entity type that the test definition is being linked to. Possible values are GROUP, ORGANIZATION and USER.
id
required		 String Represents the entity ID that the test definition is being linked to. In the case of type GROUP it is the group ID, in case of type ORGANIZATION it is the organization ID and for type USER this represents the user ID.

For types USER and ORGANIZATION the value self is also permitted.
reminderDays
optional		 Integer
sendAnnouncement
optional		 Boolean
reviewDate
optional		 Timestamp
maxRenditions
optional		 Integer The maximum number of tests that a user can take. This only applies if the test is linked to a GROUP. When updating an existing link, use UNLIMITED to indicate that users can take the test unlimited, or omit it when setting up a new link.

If no user is specified, this is the default number of tests. Otherwise, it applies to the specified user only. If a maximum has been set for a specific user and it should be removed (to use the default maximum), use DEFAULT as value.
name
optional		 String The custom name of the test objective. If no name is given, a standard name is constructed.

This parameter only applies if the test is linked to a GROUP.
user
optional		 String The ID of the user to set the maxRenditions for. This value will override the maxRenditions value that might have been set for all users.
messageChannelTypes
optional		 String array

If a PUT request has no body (i.e. the body is empty), it is still mandatory to include a Content-Length header (i.e. Content-Length: 0). Not all HTTP clients do this automatically. For more information, please see RFC 2616.

Response

A 2.1.1 TestAccess object that represents the created or modified link.

 

Last updated on