|
Custom groups
|
create | Create a custom group. |
custom_group | Get information on a given custom group. |
custom_groups | Get information on multiple custom groups. |
delete | Delete custom groups. |
update | Update a custom group. |
user | Get user's custom groups. |
services/csgroups/create ¶
|
||||||
https://usosapps.us.edu.pl/services/csgroups/create | ||||||
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. Create a custom group. | ||||||
name | required |
Name of the group. No more than 100 characters. |
||||
primary_group_ids | optional |
Default value: (empty string) List of primary group IDs that are part of this group. |
||||
custom_group_ids | optional |
Default value: (empty string) List of custom group IDs that are part of this group. |
||||
user_ids | optional |
Default value: (empty string) List of user IDs that are part of this group. |
||||
emails | optional |
Default value: (empty string) List of email addresses that are part of this group. |
||||
strict | optional |
Default value: true Should a nonexistent object referenced by primary_group_ids, custom_group_ids or user_ids argument cause an error? If set to false, all invalid references will be silently discarded. |
||||
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 the following structure:
| ||||||
Thrown errors:
|
services/csgroups/custom_group ¶
|
||||||
https://usosapps.us.edu.pl/services/csgroups/custom_group | ||||||
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 a given custom group. | ||||||
custom_group_id | required |
Custom group ID. |
||||
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. |
||||
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:
| ||||||
Thrown errors:
|
services/csgroups/custom_groups ¶
|
||||||
https://usosapps.us.edu.pl/services/csgroups/custom_groups | ||||||
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 multiple custom groups. | ||||||
custom_group_ids | required |
List of custom group IDs. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of custom_group 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: A dictionary mapping custom group IDs to dictionaries describing the groups (as returned by custom_group method). If specified group could not be found, null is returned instead of a dictionary. |
services/csgroups/delete ¶
|
||||||
https://usosapps.us.edu.pl/services/csgroups/delete | ||||||
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. Delete custom groups. | ||||||
custom_group_ids | required |
List of custom group IDs. |
||||
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 the following structure:
|
services/csgroups/update ¶
|
||||||
https://usosapps.us.edu.pl/services/csgroups/update | ||||||
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 a custom group. | ||||||
custom_group_id | required |
Custom group ID. |
||||
name | optional |
Default value: (unchanged) Name of the group. No more than 100 characters. |
||||
primary_group_ids | optional |
Default value: (unchanged) List of primary group IDs that are part of this group. |
||||
custom_group_ids | optional |
Default value: (unchanged) List of custom group IDs that are part of this group. |
||||
user_ids | optional |
Default value: (unchanged) List of user IDs that are part of this group. |
||||
emails | optional |
Default value: (unchanged) List of email addresses that are part of this group. |
||||
strict | optional |
Default value: true Should a nonexistent object referenced by primary_group_ids, custom_group_ids or user_ids argument cause an error? If set to false, all invalid references will be silently discarded. |
||||
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: An empty dictionary returned if the method has been executed successfully. Some keys may be added in the future. | ||||||
Thrown errors:
|
services/csgroups/user ¶
|
||||||
https://usosapps.us.edu.pl/services/csgroups/user | ||||||
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 user's custom groups. | ||||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of custom_group 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: A list of dictionaries describing custom groups (as returned by custom_group method). |