|
Clearance slips
|
add_question | Add a new question to a template |
create_template | Create a new slip template |
delete_question | Delete a question from the template |
delete_slip | Delete an issued slip |
delete_template | Delete a template |
issue_slip | Issue a new slip instance |
question | Get information on a single question |
questions | Get information on multiple questions |
search_slips | Search among the issued slips |
search_templates | Search the list of templates |
slip | Get information on a single issued slip |
slipquestion | Get information on a single slipquestion |
slipquestions | Get information on multiple slipquestions |
slips | Get information on multiple issued slips |
template | Get information on a given template |
templates | Get information on multiple templates |
to_be_answered | Browse slipquestions to be answered |
trigger | Get information on a single "question trigger". |
trigger_index | Get the full list of triggers. |
triggers | Get information on multiple triggers. |
update_question | Edit an existing question |
update_slip | Edit an existing issued slip |
update_slipquestion | Edit an existing slipquestion object |
update_template | Edit an existing slip template |
user_roles | Return the description of user's roles |
services/slips/add_question ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/add_question | ||||||
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. Add a new question to a template. Note, that your user has to hold proper privileges in order for you to use this method. However, if he does not, you will still receive a HTTP 200 response (see "returns" section). | ||||||
tpl_id | required |
ID of the template to which you want to add the question. |
||||
question | required |
The question. This should be short, but unambiguous, preferably 20-50 characters. The current limit is 100. It also must end with a question mark. Note, that there are no multiple fields for multiple languages here. Language is left for the user to choose. In other words, if the user ever needs to create a multilingual template, he will need to create two separate templates and describe when to use which. Note, that if your question is too long or otherwise "incorrect", you will still receive a HTTP 200 response (see "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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/create_template ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/create_template | ||||||
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 new slip template. You have to have some active slip templates before you can create actual slips. Note, that your user has to hold proper privileges in order for you to use this method. However, if he does not, you will still receive a HTTP 200 response (see "returns" section). | ||||||
fac_id | required |
ID of the faculty. Each template has to be bound to a single faculty. |
||||
name | required |
Name for your template. This should be short, but unambiguous, preferably 20-30 characters. The current limit is 75. The template editors can freely choose the language in which they want to create their templates. Most clearance slips need to be defined in one language only. Note, that if it's too long or otherwise "incorrect", you will still receive a HTTP 200 response (see "returns" section). |
||||
lang | optional |
Default value: pl Language which will be used within the template. All the questions and answers should also be given in the language given here. Currently, only two values are allowed: pl or en. |
||||
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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/delete_question ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/delete_question | ||||||
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 a question from within a template. Important: Only some question can be directly deleted (currently, only the ones contained within draft templates). Other should be marked as obsolete and wait to be garbage-collected. You can use the can_i_delete field of the question method to check if the question can be deleted. | ||||||
question_id | required | ID of the question to be deleted. | ||||
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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/delete_slip ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/delete_slip | ||||||
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 an existing issued slip. | ||||||
slip_id | required | ID of the slip to be deleted. | ||||
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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/delete_template ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/delete_template | ||||||
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 an existing template. Important: Only some templates can be directly deleted (drafts and possibly some more specific cases). Others should be marked as obsolete and wait to be garbage-collected. | ||||||
tpl_id | required | ID of the template to be deleted. | ||||
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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/issue_slip ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/issue_slip | ||||||
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. Issue a new slip instance. The issued slip will initially be closed, so that it can be edited before its questions begin to be answered. | ||||||
tpl_id | required |
ID of the slip template to be used for the slip. |
||||
client_user_id | required |
ID of the user to whom the slip is to be issued. |
||||
student_programme_id | optional | Optional ID of the student's programme which is said to be "bound" to the issued slip instance. | ||||
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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/question ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/question | ||||||
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 question. | ||||||
question_id | required | ID of the question. | ||||
fields | optional |
Default value: question Pipe-separated list of fields 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:
|
services/slips/questions ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/questions | ||||||
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 questions. They don't have to belong to one template. If your looking for an ordered list of questions for a given template, see questions field of the template method. | ||||||
question_ids | required |
Pipe-separated list of question IDs. |
||||
fields | optional |
Default value: question Pipe-separated list of fields you're interested in. This must be any subset of keys, which are described in the returns section of the question 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. Question IDs will be mapped to keys of this dictionary. Each value will be a dictionary of the same structure as described in the question method. For all invalid references, the value will be null (instead of a dictionary). |
services/slips/search_slips ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/search_slips | ||||||
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. This method allows you to search among the list of all issued slips which your user has access to. You can use various filters in your search - they should allow you to use this method in many contexts. Note: Slips visibility may depends on the scopes the user has provided access to you. | ||||||
langpref | required | A code of the preferred language ("pl" or "en"). It may influence the order and other display properties of the returned matches. | ||||
fields | optional |
Default value: id Pipe-separated list of slip fields you'd like to receive along the results. See the slip method for the list of valid values. |
||||
tpl_fields | deprecated |
Default value: id Deprecated. Use a subfield selector instead (e.g.
Pipe-separated list of template fields you'd like to receive in the template field. See the template method for the valid values. |
||||
my_role | optional |
Default value: (all possible roles) Pipe-separated list of user roles, as defined in the slip method. If given, the results will contain only these slips in which the current user "has" at least one of the referenced roles. Note: Some roles (i.e. "template_admin") require access to higher scopes ("slips_admin") in order for the slips to become visible. |
||||
issued_by | optional | Pipe-separated list of user IDs. If given, the results will contain only these slips which were issued by one of the referenced users (the possible issuers of the slip). | ||||
issued_for | optional | Pipe-separated list of user IDs. If given, the results will contain only these slips which were issued for one of the referenced users (the possible clients of the slip). | ||||
state | optional | Pipe-separated list of slip states. If given, the results will contain only these slips which are in any of these states. | ||||
tpl_ids | optional | Pipe-separated list of template IDs. If given, the results will contain only these slips which were issued using any of the given templates. | ||||
fac_ids | optional | Pipe-separated list of faculty IDs. If given, the results will contain only these slips which were issued using a template bound to any of the given faculties. | ||||
programme_ids | optional | Pipe-separated list of study programme IDs. If given, the results will contain only these slips which were bound to any of the given study programmes. | ||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value is 100. |
||||
start | optional |
Default value: 0 The index of the first matching search result that is to be included in the response (zero-based). |
||||
order_by | optional |
Default value: -date_created Pipe-separated list of fields to order by. This must be a subset of what you have given in your fields parameter. Each field reference might be preceded with a dash to indicate descending order. Currently allowed fields to order by:
|
||||
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/slips/search_templates ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/search_templates | ||||||
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. This method allows you to search through the list of all templates using some basic filters. The results will vary on your user's internal permissions and the scopes he had given you access to. | ||||||
langpref | required | A code of the preferred language ("pl" or "en"). It may influence the order and other display properties of the returned matches. | ||||
query | optional | The query to search with. Part of template's name or its ID, etc. | ||||
fields | optional |
Default value: id|match Pipe-separated list of slip fields you'd like to receive along the results. Allowed values:
|
||||
issuable_only | optional |
Default value: false If set to true, then the results will contain only these templates which can be issued by the user making the query. Access Token and the 'slips' scope is required in order to use this. |
||||
editable_only | optional |
Default value: false If set to true, then the results will contain only these templates which can be edited by the user making the query. Access Token and the 'slips_admin' scope is required in order to use this. |
||||
fac_ids | optional | Pipe-separated list of faculty IDs. If given, then the results will contain only such templates which are bound (directly) to any of the given faculties. | ||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value is 100. |
||||
start | optional |
Default value: 0 The index of the first matching search result that is to be included in the response (zero-based). |
||||
order_by | optional |
Pipe-separated list of fields to order by. This must be a subset of what you have given in your fields parameter. Each field reference might be preceded with a dash to indicate descending order. Currently allowed fields to order by:
|
||||
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 the following structure:
|
services/slips/slip ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/slip | ||||||
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 issued slip. | ||||||
slip_id | required | ID of the slip. | ||||
fields | optional |
Default value: template Pipe-separated list of fields described in the returns section. |
||||
tpl_fields | deprecated |
Default value: id|name Deprecated. Use a subfield selector instead (e.g.
Pipe-separated list of fields to be included in the template field. See the template method for the list of allowed values. |
||||
ctpl_fields | deprecated |
Default value: id|name Deprecated. Use a subfield selector instead. Pipe-separated list of fields to be included in the connected_tpls field. See the template method for the list of allowed values. |
||||
ctpl_q_fields | deprecated |
Default value: id|question Deprecated. Use a subfield selector instead. Pipe-separated list of fields to be included in the connected_tpls.questions. See the question method for the list of allowed values. |
||||
sq_fields | deprecated |
Default value: id Deprecated. Use a subfield selector instead. Pipe-separated list of fields to be included in each of the slipquestion objects in the questions field. See the slipquestion method for the list of allowed values. |
||||
sq_q_fields | deprecated |
Default value: question Deprecated. Use a subfield selector instead. Pipe-separated list of fields to be included in each of the slipquestion.question objects in the questions.question field. See the question method for the list of allowed 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 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/slips/slipquestion ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/slipquestion | ||||||
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 slipquestion. Clarification: A "slipquestion" is an entity that binds slips and questions. In other words, all questions included in the slip are represented as "slipquestion" entities (some of these questions are answered, some are not). | ||||||
sq_id | required | ID of the slipquestion. | ||||
fields | optional |
Default value: id|question_id Pipe-separated list of fields described in the returns section. |
||||
slip_fields | deprecated |
Default value: id Deprecated. Use a subfield selector instead (e.g.
Pipe-separated list of fields to be returned in the slip field. See the slip method for the list of available fields. |
||||
question_fields | deprecated |
Default value: id|question Deprecated. Use a subfield selector instead. Pipe-separated list of fields to be returned in the question field. See the question method for the list of available fields. |
||||
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/slips/slipquestions ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/slipquestions | ||||||
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 slipquestions. | ||||||
sq_ids | required |
Pipe-separated list of slipquestion IDs. |
||||
fields | optional |
Default value: id|question_id As in the slipquestion method. |
||||
question_fields | deprecated |
Default value: id|question Deprecated. As in the slipquestion method. |
||||
slip_fields | deprecated |
Default value: id Deprecated/ As in the slipquestion 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. Slipquestion IDs will be mapped to keys of this dictionary. Each value will be a dictionary of the same structure as described in the slipquestion method. For all invalid references, the value will be null (instead of a dictionary). |
services/slips/slips ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/slips | ||||||
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 issued slips. | ||||||
slip_ids | required |
Pipe-separated list of slip IDs. |
||||
fields | optional |
Default value: template As in the slip method. |
||||
tpl_fields | deprecated |
Default value: id|name|fac Deprecated. As in the slip method. |
||||
ctpl_fields | deprecated |
Default value: id|name Deprecated. As in the slip method. |
||||
ctpl_q_fields | deprecated |
Default value: id|question Deprecated. As in the slip method. |
||||
sq_fields | deprecated |
Default value: id Deprecated. As in the slip method. |
||||
sq_q_fields | deprecated |
Default value: question Deprecated. As in the slip 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. Slip IDs will be mapped to keys of this dictionary. Each value will be a dictionary of the same structure as described in the slip method. For all invalid references, the value will be null (instead of a dictionary). |
services/slips/template ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/template | ||||||
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 template. | ||||||
tpl_id | required | ID of the template. | ||||
fields | optional |
Default value: name Pipe-separated list of fields described in the returns section. |
||||
question_fields | deprecated |
Default value: id|question Deprecated. Use a subfield selector instead (e.g.
Which fields should be included in the each of the question objects listed in the questions field? You have to include 'questions' in your fields in order for this parameter to work. |
||||
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:
|
services/slips/templates ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/templates | ||||||
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 templates. | ||||||
tpl_ids | required |
Pipe-separated list of template IDs. |
||||
fields | optional |
Default value: id|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, which are described in the returns section of the template method. |
||||
question_fields | deprecated |
Default value: id|question Deprecated. Same as in the question 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. Template IDs will be mapped to keys of this dictionary. Each value will be a dictionary of the same structure as described in the template method. For all invalid references, the value will be null (instead of a dictionary). |
services/slips/to_be_answered ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/to_be_answered | ||||||
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. This method allows you to browse through the list of all questions which are waiting to be answered by the user. | ||||||
langpref | required | A code of the preferred language ("pl" or "en"). It may influence the order and other display properties of the returned objects. | ||||
unanswered_before | optional | Datetime string. By default, the list will contain only unanswered questions. With this parameter you may include some recently answered questions (answered after the specified date). This might be helpful for review. | ||||
answer_filter | optional | If unanswered_before is given you can restrict answered questions to answers starting with the given filter. | ||||
fields | optional |
Default value: id|slip|question As in the slipquestion method. |
||||
question_fields | deprecated |
Default value: id|question Deprecated. As in the slipquestion method. |
||||
slip_fields | deprecated |
Default value: id|client Deprecated. As in the slipquestion method. |
||||
num | optional |
Default value: 6 The number of search results to return on a single page. The maximum allowed value is 100. |
||||
start | optional |
Default value: 0 The index of the first matching search result that is to be included in the response (zero-based). |
||||
order_by | optional |
Default value: slip.date_created|question.question Pipe-separated list of fields to order by. Each field reference might be preceded with a dash to indicate descending order. Currently allowed fields to order by:
|
||||
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/slips/trigger ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/trigger | ||||||
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 "question trigger". "Question triggers" are provided by the system itself; users are not allowed to create new triggers, nor change the existing ones. Slip admins can apply these triggers to their questions - this will cause the question to have some additional "magical" properties (which are described in the description field of the trigger). | ||||||
trigger_id | required |
ID of the trigger. Many of the IDs are not backward-compatible. They may either disappear or change their meaning at any time. You should avoid hardcoding IDs in your code. Use the trigger_index method instead. |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
|
services/slips/trigger_index ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/trigger_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 full list of triggers. | ||||||
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 trigger 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: Ordered list of trigger objects (currently there are no categories to group them by, just this list). |
services/slips/triggers ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/triggers | ||||||
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 triggers. | ||||||
trigger_ids | required | Pipe-separated list of trigger 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 trigger 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 trigger_ids will be mapped to dictionary's keys, and each value will contain the description of one permission class, as defined in the trigger method. |
services/slips/update_question ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/update_question | ||||||
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. Edit an existing question of a template. Note, that your user has to hold proper privileges in order for you to use this method. However, if he does not, you will still receive a HTTP 200 response (see "returns" section). Also note, that this method may return errors regarding fields not explicitly provided in the request. In particular, if you change value of one field which puts it in conflict with some other field, then this method may report an error in the other field (not the one you have just changed). | ||||||
question_id | required |
ID of the question. |
||||
question | optional |
New question content. For more information see add_question method. If not given, question content will not change. Important: If the template is no longer in a draft state, then it is crucial that you ask your user if the new content of the question changed the meaning of the question. See is_meaning_changed. |
||||
desc_for_answerers | optional |
New content of the additional description for the answerers. For more information see question method. If not given, the description will not change. |
||||
is_meaning_changed | optional |
Default value: true Boolean. This should be supplied by user, whenever he edits the question content of a non-draft template. One of the two values:
Important: If the meaning is changed, we may decide that the question should be forked into two questions, instead of being changed. In such case:
|
||||
answerers | optional |
Pipe-separated list of user IDs. This is the default set of people allowed to answer this question. Only template editors are allowed to change this set. However, slip issuers may be allowed to define extra answerers for some questions. See can_issuers_assign_answerers parameter for more information. |
||||
is_included_by_default | optional | Boolean. If given, changes the value of the is_included_by_default field described in the question method. | ||||
can_client_answer | optional | Boolean. As above. See the question method for more information on these fields. | ||||
can_issuers_answer | optional | Boolean. As above. | ||||
can_issuers_assign_answerers | optional | Boolean. As above. | ||||
is_obsolete | optional | Boolean. As above. | ||||
regexp_cleared | optional | String. As above. | ||||
regexp_rejected | optional | String. As above. | ||||
quick_answers | optional | String. As above. | ||||
trigger_ids | optional | Pipe-separated list of trigger IDs. If given, it will cause the of triggers field (described in the question method) to change appropriately. | ||||
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 your request was successful AND the edit caused a new question to be "forked", then the question_id of this new (forked) question will be included in the returned dictionary. In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/update_slip ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/update_slip | ||||||
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 attributes of an existing issued slip. Note, that your user has to hold proper privileges in order for you to use this method. However, if he does not, you will still receive a HTTP 200 response (see "returns" section). Important: Please note the difference between:
| ||||||
slip_id | required | ID of the template been edited. | ||||
state | optional |
New slip state. For more information see slip method. |
||||
student_programme_id | optional | ID of the student's programme which is said to be "bound" to the issued slip instance or an empty string to remove the existing reference. | ||||
issuers_comment | optional |
New value of the issuers' comment. |
||||
question_ids | optional |
Pipe-separated list of question IDs which are to be included in this slip. If you want to edit other properties of the questions, use the update_slipquestion method. Important: There are strict rules regarding as to which questions are allowed on which slip. Short extract:
|
||||
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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/update_slipquestion ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/update_slipquestion | ||||||
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 attributes of an existing slipquestion object. The set of attributes which you can change depends on the roles of your user within the slip. Note, that your user has to hold proper privileges in order for you to use this method. However, if he does not, you will still receive a HTTP 200 response (see "returns" section). Important: Please note the difference between:
| ||||||
sq_id | required | ID of the slipquestion been edited. | ||||
answer | optional |
New answer to the question. Setting this to empty string will remove the previous answer. Please note, that when you're allowing your user to answer, you should present him with quick_answers too (see the question method. |
||||
extra_answerers | optional | New value of extra_answerers field. Pipe-separated list of user 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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/update_template ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/update_template | ||||||
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 attributes of an existing slip template. To edit template's questions, use add_question and update_question methods. Note, that your user has to hold proper privileges in order for you to use this method. However, if he does not, you will still receive a HTTP 200 response (see "returns" section). Important: Please note the difference between:
| ||||||
tpl_id | required | ID of the template been edited. | ||||
fac_id | optional |
New faculty ID. For more information see create_template method. If not given, faculty ID will not change. |
||||
name | optional |
New template name. For more information see create_template method. |
||||
lang | optional |
New template language. For more information see create_template method. |
||||
state | optional |
Code of the new state for this template. One of the values described state field in the template method. |
||||
desc_for_issuers | optional | Additional description for the issuers. This should be filled in case of templates which require some extra action while being issued. E.g. if the issuer needs to include some questions which are not included by default, or to define extra answerers, etc. | ||||
questions_order | optional | If given, it must be a pipe-separated list of question IDs. All of these questions must belong to this template. Questions will be reordered according to the order in which they appeared in your list. If the template contains more questions than you supplied, they will be moved to the end of the list. | ||||
connected_tpl_ids | optional |
If given, it must be a pipe-separated list of template IDs. If given, it will replace the current values of connected_tpl_ids field. If you provide an empty string, all the connections will be removed! |
||||
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:
In case of failure, use the user_messages field to display a proper message for the user. |
services/slips/user_roles ¶
|
||||||
https://usosapi.awf.krakow.pl/services/slips/user_roles | ||||||
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. Return the description of user's roles within the slips system. Important: The result of this method depends on the scopes used. I.e. you must have access to slips_admin scope to retrieve information if the user is a slip template editor. | ||||||
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:
|