Placement tests
:: services/plctests module

This is a BETA module. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this module, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Retrieving information and results in placement tests (e.g. for foreign language courses).

It's also possible (with administrative consumer key) to update test's results.

Methods

test BETA Get information on given placement test
test_result BETA Get placement test's result
tests_index BETA Get IDs of all placement tests
update_result BETA Update test result (administrative)
update_results BETA Update test result (administrative)
user BETA User's results

services/plctests/test

Consumer: ignored Token: ignored Scopes: n/a SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get information on given placement test

id required ID of placement test
fields optional

Default value: id|name

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

No additional OAuth arguments are required. If you provide any, they will be ignored.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of placement test;

  • name - LangDict object with the test's name.

Thrown errors:

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • test_not_found - referenced placement test does not exist.

services/plctests/test_result

Consumer: required Token: required Scopes: placement_tests SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get result of token issuer's placement test
test_id required ID of placement test
fields optional

Default value: user_id|test|value

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • user_id - ID of a user;

  • test - Object returned by test method for given ID;

  • value - Number of points, that is result of placement test.

Thrown errors:

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • result_not_found - referenced test result does not exist.

services/plctests/tests_index

Consumer: ignored Token: ignored Scopes: n/a SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Get IDs of all placement tests

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

No additional OAuth arguments are required. If you provide any, they will be ignored.

Returned value:

List with IDs

services/plctests/update_result

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Update result of placement test for given user to 'new_value'.

If you want to avoid concurrency problems (if two or more users are modifying same results), you may specify "old_value" parameter. Result will be updated only if given value match with currently value in database.

test_id required ID of placement test
user_id required ID of user whose grade will be updated
new_value required Number of points, that you want to set
old_value optional

Default value: (Missing)

Number of points, that you expect that is current set. If you expect that result wasn't entered yet, set this parameter to null.
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required.

Returned value:

An empty dictionary returned if the method has been executed successfully. Some keys may be added in the future.

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • test_modified - test result probably was updated concurrently.

  • object_not_found - some of the referenced objects do not exist; param_name is equal to id.

services/plctests/update_results

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Update result of placement test for given users

test_id required ID of placement test
new_values required Dictionary mapping user IDs to numbers of points, that you want to set
old_values required Dictionary mapping user IDs to numbers of points, you expect that is currently set (similarly to parameter old_value in method update_result). Note that if you use this parameter dictionary must contain the same user IDs as dictionary passed in new_values parameter.
format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required.

Returned value:

An empty dictionary returned if the method has been executed successfully. Some keys may be added in the future.

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • test_modified - test result probably was updated concurrently.

  • object_not_found - some of the referenced objects do not exist.

    Possible reasons:

    • test_not_found - referenced placement test does not exist.

services/plctests/user

Consumer: required Token: required Scopes: placement_tests SSL: not required
URLs of the methods are hidden, because this installation is the mother server.
Click here for the list of all public USOS API installations.

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

User's results

fields optional

Default value: user_id|test|value

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of test_result method.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

Dictionary mapping placement test ID to dictionaries returned by test_result method.

USOS API ver. 6.1.2.0-bc1aa53 (2016-06-07)