|
Accessing user information
|
change | Change user data. |
employment_functions | Get information on employment functions of a given user. |
employment_group | Get information on employment group |
employment_groups_index | Get information on employment group |
employment_positions | Get information on employment positions of a given user. |
pesel | Get information on a user given by PESEL number. (administrative) |
photo | (deprecated) Get user's photo. |
position | Description of employee position |
search | (deprecated) Search among all users. |
search2 | Search for users. |
search_by_email | Search for users with a given email address. (administrative) |
search_current_students | (deprecated) Search among current students. |
search_current_teachers | (deprecated) Search among current teachers. |
search_history_affect | Add a user to search history. |
search_staff | (deprecated) Search among all staff members. |
search_students | (deprecated) Search among all students. |
staff_index | Retrieve lists of faculty staff members. |
student_index | Retrieve lists of students. |
student_programmes | (deprecated) Get information on user's studies. |
user | Get information on a given user. |
user2 | Get information on a given user. |
users | Get information on multiple users. |
services/users/change ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/change | ||||||
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. Change user data, such as his email address, or phone number. The number of fields which you can change with this method is very limited, but it will grow depending on users' needs (contact us if you want more fields supported). All the changes made by this method are atomic. That is, if any of the changes fail to be saved, then none of them will be saved. Please note that it may take time for some changes to propagate to all USOS-related applications. | ||||||
user_id | optional |
Default value: (empty string) The ID of the user whose data is to be updated. Required if you don't use an Access Token. |
||||
optional |
Default value: (unchanged) If given, then user's email address will be replaced with the given value. Administrative Consumer Key required. |
|||||
alt_email | optional |
Default value: (unchanged) If given, then user's alternative email address will be replaced with the given value. Scope required: edit_user_attrs. |
||||
homepage_url | optional |
Default value: (unchanged) If given, then user's homepage URL will be replaced with the given value. Administrative Consumer Key required. |
||||
phone_numbers | optional |
Default value: (unchanged) Pipe-separated list of strings. If given, then user's official phone numbers will be replaced with the given values. Note, that currently only staff members are allowed to have phone numbers, and no more than two of them. This may change in future. Administrative Consumer Key required. |
||||
mobile_numbers | optional |
Default value: (unchanged) Pipe-separated list of strings. If given, then user's mobile phone numbers will be replaced with the given values. This may change in future. Administrative Consumer Key required. |
||||
room_id | optional |
Default value: (unchanged) ID of a room. If given, then the user's current office room will be replaced with the given one. Note, that only staff members are allowed to have an office room. Administrative Consumer Key required. |
||||
revenue_office_id | optional |
Default value: (unchanged) ID of revenue office. If given, then user's revenue office ID will be replaced with the given one. Administrative Consumer Key required. |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: If all changes succeed, If any of the changes fail, then none of them will be saved, and you will receive HTTP 400 error with detailed error message. This error message is given in plaintext string - readable to humans, but not to machines. Contact us if you need enhanced error handling in your application (e.g. error codes, or list of invalid fields). The error response may (but doesn't have to) contain the user_messages field (especially if you're changing the fields editable by non-administrative consumers). |
services/users/employment_functions ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/employment_functions | ||||||
This method returns similar results as the employment_functions field of the user method, but it may return past employments too (provided you have proper access). | ||||||
user_id | optional |
Default value: (access token issuer) ID of a user. |
||||
fields | optional |
Default value: function|faculty Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
include_past | optional |
Default value: auto One of the following values:
|
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A list of dictionaries. Each dictionary contains following fields:
| ||||||
Thrown errors:
|
services/users/employment_group ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/employment_group | ||||||
Get information on employment group | ||||||
id | required | ID of a group | ||||
fields | optional |
Default value: id|name|university_teachers 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:
|
services/users/employment_groups_index ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/employment_groups_index | ||||||
Get information on employment group | ||||||
fields | optional |
Default value: id|name|university_teachers Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of employment_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. |
||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: List of all existing employment groups, as defined in employment_group. |
services/users/employment_positions ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/employment_positions | ||||||
Get information on employment positions of a given user. Only the current positions will be returned. | ||||||
user_id | optional |
Default value: (access token issuer) ID of a user. |
||||
include_past | optional |
Default value: false By default past employments are omnited. To disable this behaviout setset parameter to true. Note that only administrative consumersare allowed to do this. |
||||
fields | optional |
Default value: position|faculty 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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/users/pesel ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://usosapi.awf.krakow.pl/services/users/pesel | ||||||
Get information on a user given by PESEL number. | ||||||
pesel | required |
Pesel number. Must be an exact match. |
||||
fields | optional |
Default value: id|first_name|last_name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of user 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. Token is not required. | ||||||
Returned value: A dictionary that contains a user description, as defined in the user method. | ||||||
Thrown errors:
|
services/users/photo ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/photo | ||||||
This method is deprecated, please avoid using it - read more Get user's photo. This method is deprecated. Please use the photo_urls field of the user method. | ||||||
(this method takes no parameters) | ||||||
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: Photo of the user who authorized the Access Token.
| ||||||
Thrown errors:
|
services/users/position ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/position | ||||||
Description of employee position | ||||||
id | required | ID of a position | ||||
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:
|
services/users/search ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/search | ||||||
This method is deprecated, please avoid using it - read more Suggested replacement: services/users/search2 Why deprecated? Because you can get more features and - in some cases - achieve better performance by using the search2 method. Search for users matching given query. All users are taken into consideration (students, ex-students, staff, etc.). If you'd like to limit your search - use one of the other methods. | ||||||
name | optional |
Default value: (empty string) The search query. The most obvious value for this field is the user's name, but we'll try to be smart about it (for example, it allows you to find a student by his/her student number, etc.). |
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Indicates the first matching search result that should be included in the response. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. Note, that no more than 100 search result will ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of following fields and their values:
|
services/users/search2 ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/search2 | ||||||
Search for users matching the given query and/or filters. By default, this method will search among all users (ex- students, past staff members, etc.). If you'd like to search only in a limited subset of users, then try using some of the optional parameters. Please note, that other USOS API modules may expose their own, specialized user-searching methods. For example, if you want to search only among such users which are related to a given exam, then you should first try looking for an appropriate method in the exams module, not here. (However, such specialized methods are sparse, and probably you'll end up using this one anyway.) USOS API supports personalized search results. For example, it may display certain items higher in the results, based on personal user preferences and connections. You should include Access Tokens in your requests in order to make use of these features. For best results, you should also use the search_history_affect method. | ||||||
lang | required |
A code of the preferred language ("pl" or "en"). It may influence the order and other properties of the returned matches (in particular, the language used in the match field). |
||||
fields | optional |
Default value: items|next_page Or, more precisely: items[user[id]|match]|next_page A selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
query | optional |
Default value: (empty string) The search query. The most obvious value for this field is the user's name, but we'll try to be smart about it. For example, we may choose to find a student by his/her student number, or email address etc. Also, even more similar features may be added in time. However, these extra searching features are currently not documented and are not guaranteed to work in the future. |
||||
among | optional |
Default value: all Pipe-separated list of "primary user classes" among which to search. If you provide more than one then the results will include users which fall into at least one of the given classes. (So, this method allows you to "OR" these conditions, but not "AND" them.) Allowed class codes include:
|
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Zero-based offset of the first item that should be included in the response. (Or, in other words, the number of items to strip from the beginning of the items-list.) Note, that no more than 100 items can ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
next_page - boolean, indicates if there is a next page of results for this query. |
services/users/search_by_email ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://usosapi.awf.krakow.pl/services/users/search_by_email | ||||||
Search for users with a given email address.
| ||||||
required |
Email address. Must be an exact match (case insensitive). |
|||||
fields | optional |
Default value: id|first_name|last_name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of user 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. Token is not required. | ||||||
Returned value: List of dictionaries. Each dictionary contains a user description, as defined in the user method. |
services/users/search_current_students ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/search_current_students | ||||||
This method is deprecated, please avoid using it - read more Why deprecated? Because you can get more features and - in some cases - achieve better performance by using the search2 method. Search for current students matching given query. A "current student" is one that is currently studying at at least one study programme. | ||||||
name | optional |
Default value: (empty string) The search query. The most obvious value for this field is the user's name, but we'll try to be smart about it (for example, it allows you to find a student by his/her student number, etc.). |
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Indicates the first matching search result that should be included in the response. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. Note, that no more than 100 search result will ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: Same format as in the search method. |
services/users/search_current_teachers ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/search_current_teachers | ||||||
This method is deprecated, please avoid using it - read more Why deprecated? Because you can get more features and - in some cases - achieve better performance by using the search2 method. Same as search_staff method, but includes only these staff members which are currently teaching. | ||||||
name | optional |
Default value: (empty string) The search query. The most obvious value for this field is the user's name, but we'll try to be smart about it (for example, it allows you to find a student by his/her student number, etc.). |
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Indicates the first matching search result that should be included in the response. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. Note, that no more than 100 search result will ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: Same format as in the search method. |
services/users/search_history_affect ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/search_history_affect | ||||||
Add a user to search history. This method aims on improving user experience while searching. Call this method once your user visits another user's page, or when he/she selects a given user while searching for users, etc. The selected user will be added to search history (currently stored separately for each consumer key and each user). Items saved in search history may appear more frequently in future search results, etc. | ||||||
user_id | required |
The ID of the user to be saved into the search history. |
||||
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: Currently, it always returns |
services/users/search_staff ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/search_staff | ||||||
This method is deprecated, please avoid using it - read more Why deprecated? Because you can get more features and - in some cases - achieve better performance by using the search2 method. Search for staff members matching given query. This is very similar to the search method, but searches among staff members only. This includes all staff members in the USOS database, employed presently and in the past. This is usually less interesting than, for example, the search_current_teachers method. | ||||||
name | optional |
Default value: (empty string) The search query. The most obvious value for this field is the user's name, but we'll try to be smart about it (for example, it allows you to find a student by his/her student number, etc.). |
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Indicates the first matching search result that should be included in the response. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. Note, that no more than 100 search result will ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: Same format as in the search method. |
services/users/search_students ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/search_students | ||||||
This method is deprecated, please avoid using it - read more Why deprecated? Because you can get more features and - in some cases - achieve better performance by using the search2 method. Search for students matching given query. This includes also ex-students/graduates. If you want to search among current students, use the search_current_students method. | ||||||
name | optional |
Default value: (empty string) The search query. The most obvious value for this field is the user's name, but we'll try to be smart about it (for example, it allows you to find a student by his/her student number, etc.). |
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Indicates the first matching search result that should be included in the response. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. Note, that no more than 100 search result will ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: Same format as in the search method. |
services/users/staff_index ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/staff_index | ||||||
Retrieve lists of staff members of the given faculty. This is different than searching. The search2 method aims at simplifing the task of finding one particular user, whereas the *_index methods are designed to return ordered lists of users matching the given, simple criteria. In this case, it returns all the staff members of the given faculty. You might say, that search methods are for humans, and index methods are for automated robots (e.g. for pages to by crawled by Google), but that's not always the case. Note that there is no limit on the number of items returned via the index method. Still, you cannot retrieve all items in a single request - you need to paginate your results. The results of this method may vary on the permissions of your user. | ||||||
fac_ids | required |
Pipe-separated list of faculty IDs (usually a single faculty). Staff members of these faculties will be returned. |
||||
teachers_only | optional |
Default value: false If set to true then the results will be additionally filtered and will contain active academic teachers only. |
||||
fields | optional |
Default value: users|next_page|total Or, more precisely: users[id|first_name|last_name]|next_page|total A selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
num | optional |
Default value: 20 The maximum number of items to return on one "page". The maximum allowed value of num is 100. |
||||
start | optional |
Default value: 0 Zero-based offset of the first item that should be included in the response. (Or, in other words, the number of items to strip from the beginning of the items-list.) |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
next_page - boolean, indicates if there is a next page of results for this query; total - integer, total number of matched items. |
services/users/student_index ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/student_index | ||||||
Retrieve lists of students, grouped by various criteria. The results of this method may vary on the permissions and roles of your user. If you don't have proper permissions, then empty list of results will be returned (no error will be raised). Currently, all requests with any valid Access Token have access to everything, but this is likely to change in the near future. Note that you can use programme_ids or country_id, but not both (they're mutually exclusive)! | ||||||
programme_ids | optional |
Default value: (empty string) Pipe-separated list of programme IDs (usually a single programme). Students of these programmes will be returned. |
||||
country_id | optional |
Default value: (empty string) If you are an Administrative Consumer, then you can use this method to retrieve all the students which have the nationality of the given country. Supply a single ISO 3166-1 alpha-2 code in this parameter. If you have an Access Token, then you can also use the special "mine" value, which will return the students of the same nationality as your user has. This will also work with non-administrative consumers, however the results can be very limited, depending on your scopes and the preferences of your user and other users of the same nationality (some students may agree to share more data than others). Important: This parameter is designed for mobility applications and it won't work for the Polish nationality. You will receive an empty response if you supply 'PL', or when your user is Polish. |
||||
fields | optional |
Default value: users|next_page|total Or, more precisely: users[id|first_name|last_name]|next_page|total A selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
num | optional |
Default value: 20 The maximum number of items to return on one "page". The maximum allowed value of num is 100. |
||||
start | optional |
Default value: 0 Zero-based offset of the first item that should be included in the response. (Or, in other words, the number of items to strip from the beginning of the items-list.) |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
next_page - boolean, indicates if there is a next page of results for this query; total - integer, total number of matched items. |
services/users/student_programmes ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/student_programmes | ||||||
This method is deprecated, please avoid using it - read more Suggested replacement: services/progs/student Get information on user's studies. | ||||||
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. Each dictionary contains following fields:
|
services/users/user ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/user | ||||||
Get information on a given user. | ||||||
user_id | optional |
Default value: (access token issuer) ID of a user. |
||||
fields | optional |
Default value: id|first_name|last_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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values or null if user with given ID does not exist. Each dictionary contains following fields:
| ||||||
Thrown errors:
|
services/users/user2 ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/user2 | ||||||
Get information on a given user. | ||||||
user_id | optional |
Default value: (access token issuer) ID of a user. |
||||
fields | optional |
Default value: id|first_name|last_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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/users/users ¶
|
||||||
https://usosapi.awf.krakow.pl/services/users/users | ||||||
Get information on multiple users. This method is similar to the user method, but it works with multiple users. | ||||||
user_ids | required |
List of user IDs. |
||||
fields | optional |
Default value: id|first_name|last_name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of user 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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary: your user_ids will be mapped to dictionary's keys, and each value will contain the description of a user, as defined in the user method. For example: fields=first_name&user_ids=1|2 might return something like: {"1": null, "2": {"first_name": "Wojciech"}} |