|
Housing
|
allocation_period | Get information on a single allocation period |
allocation_period_index | Get the index of all allocation periods. |
allocation_periods | Get information on multiple allocation periods |
assignment | Get data on a given assignment. |
assignment_extend | Extend assignment's expiry date. |
assignments | Get information on multiple assignments. |
check_in | Check an user into dormitory |
check_out | Check out a user from a dormitory. |
dormitories | Get information on multiple dormitories. |
dormitory | Get information on a single dormitory. |
dormitory_index | Get the index of all dormitories. |
dormitory_user | Get information on a given user. |
dormitory_users | Get information on multiple users. |
dormroom | Get information on a single dormitory room. |
dormroom_type | Get information on a single dormroom type |
dormroom_type_index | Get a list of all dormroom types. |
dormroom_types | Get information on multiple dormroom types |
dormrooms | Get information on multiple dormitory rooms. |
residence | Get information on a single residence |
residences | Get information on multiple residences. |
resident_type | Get information on a single resident type |
resident_type_index | Get a list of all resident types. |
resident_types | Get information on multiple resident types |
unused_assignment_ids | Get a list of assignments which were not checked-in yet. |
services/housing/allocation_period ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/allocation_period | ||||||
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 single allocation period | ||||||
allocation_period_id | required | ID of the allocation period | ||||
fields | optional |
Default value: id 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/housing/allocation_period_index ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/allocation_period_index | ||||||
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 the index of all allocation periods defined in this USOS installation. | ||||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of allocation_period method. |
||||
as_object | optional |
Default value: false if true an object is returned instead of a list. The object will be of the same structure as the one returned by the dormroom_types 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: A list of allocation_period objects, ordered by the start field. |
services/housing/allocation_periods ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/allocation_periods | ||||||
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 allocation periods | ||||||
allocation_period_ids | required | Pipe-separated list of allocation period IDs | ||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of allocation_period 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: A dictionary: your allocation_period_ids will be mapped to dictionary's keys, and each value will contain an allocation_period object, or null, if no allocation period by given ID was found. |
services/housing/assignment ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/assignment | ||||||
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 data on a given assignment. Currently, only dormitory administrators can access assignment data. If your user doesn't have proper permissions, then assignments will appear as nonexistent. Please note, that assignments are a subset of dorm applications. (Dorm applications are currently not exposed via USOS API, but they're role is explained in the module header.) | ||||||
assignment_id | required | ID of the assignment/application | ||||
fields | optional |
Default value: id 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:
|
services/housing/assignment_extend ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/assignment_extend | ||||||
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. Extend assignment's expiry date. Dormitory administrators are allowed to extend expiry dates of assignments which have an expiry date. If you don't know what expiry date is, please see the expiry_date field in the assignment method. | ||||||
assignment_id | required | ID of an unused assignment | ||||
new_expiry_date | required |
Datetime string. New expiry date. |
||||
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: Returns |
services/housing/assignments ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/assignments | ||||||
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 assignments. | ||||||
assignment_ids | required | Pipe-separated list of assignment IDs. | ||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of assignment 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. Your assignment_ids will be its keys. Values will be assignment objects, or nulls, if no assignment by such ID was found (or your user does not have proper permissions to access it). |
services/housing/check_in ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/check_in | ||||||
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. Check an user into dormitory. Only dormitory administrators can perform this action. | ||||||
assignment_id | required |
The ID of the user's assignment. The user may have multiple assignments (e.g. for different academic terms), that's why we need a specific assignment ID here (instead of just user_id). |
||||
dormroom_id | required | ID of the room person will be checked into | ||||
check_in_date | optional |
Default value: (empty string) Check-in date, if not given it defaults to now. The residence registration period (check-in and planned check-out dates) must be contained within the period defined by the user's assignment. |
||||
check_out_date | optional |
Default value: (empty string) Planned check-out date - if not given it defaults to a final day of the assignment period. The residence registration period (check-in and planned check-out dates) must be contained within the period defined by the user's assignment. |
||||
resident_type_id | optional |
Default value: (empty string) ID of the resident type - if not given it defaults to the value stored in the assignment (if there is no such value stored in the assignment, an error is raised). |
||||
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: If a check in is successful, a following dictionary will be returned:
|
services/housing/check_out ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/check_out | ||||||
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. Check out a user from a dormitory. Only dormitory administrators can perform this action. | ||||||
residence_id | required |
ID of the residence. This ID can be obtained from the residences field of the assignment method. |
||||
check_out_date | optional |
Default value: (empty string) Check-out date. If not given it defaults to now. The residence period (check-in and planned check-out dates) must fit within period defined in the user's assignment. |
||||
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: On successful checkout |
services/housing/dormitories ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormitories | ||||||
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 dormitories. | ||||||
dormitory_ids | required | Pipe-separated list of dormitory IDs. | ||||
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 of dormitory 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 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. Your dormitory_ids will be its keys. Values will be dormitory objects, or nulls, if no dormitory by such ID was found. |
services/housing/dormitory ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormitory | ||||||
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 single dormitory. | ||||||
dormitory_id | required | ID of a dormitory. | ||||
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 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:
|
services/housing/dormitory_index ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormitory_index | ||||||
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 the index of all dormitories in this USOS installation. | ||||||
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 of dormitory method. |
||||
as_object | optional |
Default value: false if true an object is returned instead of a list. The object will be of the same structure as the one returned by the dormroom_types 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 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: An unordered list of dormitory objects. |
services/housing/dormitory_user ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormitory_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 information on a given user. This is a clone of the services/users/user method, but some selected users can access broader selection of user- related data here, than they would be able via the original services/users/user method. For example: Let's say that the user X is a dormitory admin. He wants to know more on the user Y who has been awarded a place in his dormitory. If X tries to access user Y's data via the services/users/user method, he will fail to see some fields, like student_number or pesel. This is because the original user method is (currently) not designed to check if user X is a dormitory admin, therefore it won't provide any additional details for him. This method however IS designed to do so. If X tries to access user Y's data here, he will see much more. | ||||||
user_id | required |
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 of services/users/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 required oauth_token for Token authorization. | ||||||
Returned value: The services/users/user object. If the referenced user does not exist, an error is raised. |
services/housing/dormitory_users ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormitory_users | ||||||
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 users. See dormitory_user method for more info. | ||||||
user_ids | required | Pipe-separated 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 services/users/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 required oauth_token for Token authorization. | ||||||
Returned value: A dictionary. Your dormitory_ids will be its keys. Values will be dormitory objects, or nulls, if no dormitory by such ID was found. |
services/housing/dormroom ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormroom | ||||||
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 single dormitory room. Note, that you'll get an error if your user doesn't have proper permissions to view this room. | ||||||
dormroom_id | required | ID of a dormitory room. | ||||
fields | optional |
Default value: id 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:
|
services/housing/dormroom_type ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormroom_type | ||||||
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 single dormroom type. Dormitory rooms come in various standards and sizes. USOS defines a couple of room types, which roughly describe their size and standard. | ||||||
dormroom_type_id | required | ID of the type of room | ||||
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/housing/dormroom_type_index ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormroom_type_index | ||||||
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 a list of all possible dormroom types currently defined in this USOS installation. | ||||||
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 of dormroom_type method. |
||||
as_object | optional |
Default value: false if true an object is returned instead of a list. The object will be of the same structure as the one returned by the dormroom_types 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: A list of dormroom_type objects. |
services/housing/dormroom_types ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormroom_types | ||||||
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 dormroom types | ||||||
dormroom_type_ids | required | Pipe-separated list of dormroom type IDs | ||||
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 of dormroom_type 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: A dictionary: your dormroom_type_ids will be mapped to dictionary's keys, and each value will contain a dormroom_type object, or null, if no dormroom_type by given ID was found. |
services/housing/dormrooms ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/dormrooms | ||||||
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 dormitory rooms. | ||||||
dormroom_ids | required | Pipe-separated list of dormitory room IDs. | ||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of dormroom 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. Your dormroom_ids will be its keys. Values will be dormroom objects, or nulls, if no dormroom by such ID was found OR your user doesn't have proper permissions to see it. |
services/housing/residence ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/residence | ||||||
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 single residence. A residence object represents a single check-in and check-out of a user to a dormitory dormroom. | ||||||
residence_id | required | ID of a residence | ||||
fields | optional |
Default value: id 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:
|
services/housing/residences ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/residences | ||||||
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 residences. | ||||||
residence_ids | required | Pipe-separated list of residence IDs. | ||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of residence 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. Your residence_ids will be its keys. Values will be residence objects, or nulls, if no residence by such ID was found (or you don't have access to see it). |
services/housing/resident_type ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/resident_type | ||||||
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 single resident type. Dormitory residents can be divided into several types, such as students, employees, or guests. A complete list of all valid resident types currently defined in this USOS installation can be retrieved with the resident_type_index method. | ||||||
resident_type_id | required | ID of the type of resident | ||||
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/housing/resident_type_index ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/resident_type_index | ||||||
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 a list of all possible resident types currently defined in this USOS installation. | ||||||
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 of resident_type method. |
||||
as_object | optional |
Default value: false if true an object is returned instead of a list. The object will be of the same structure as the one returned by the dormroom_types 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: A list of resident_type objects. |
services/housing/resident_types ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/resident_types | ||||||
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 resident types | ||||||
resident_type_ids | required | Pipe-separated list of resident type IDs | ||||
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 of resident_type 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: A dictionary: your resident_type_ids will be mapped to dictionary's keys, and each value will contain a resident_type object, or null, if no resident type by given ID was found. |
services/housing/unused_assignment_ids ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/housing/unused_assignment_ids | ||||||
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 a list of assignment IDs which were not checked-in yet. The list if filtered by dormitory and allocation period. This method can be used by dormitory administrators to find the users who didn't check in into the dormitory. Only dormitory admins may access this list. | ||||||
allocation_period_id | required |
ID of an allocation period. |
||||
dormitory_id | required |
ID of a dormitory. |
||||
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: Unordered list of assignment IDs. |