|
Electronic ID cards
|
card | Get information on a given card. (administrative) |
check_orders_status | Get information about student card and related mcard (mLegitymacje) (administrative) |
make_mcard_order | Create new mStudentCard order |
mark_student_card_prolonged | Uprade student card status as to be prolonged (administrative) |
mcard | Get information about student card and related mcard (mLegitymacje) |
mcard_order | Get details of mStudentCard order |
revoke_mcard | Revoke existing mStudentCard or mStudentCard order |
student_card_data | Get data required to write new structure on ELS card (administrative) |
user | Get information on a user's ID cards. |
user_cards | Get all student's cards data |
services/cards/card ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://usosapps.us.edu.pl/services/cards/card | ||||||
Get information on a given card - specified by exactly one parameter of the following:
contact_chip_uid, contactless_chip_uid, barcode_number.
| ||||||
contact_chip_uid | optional | Unique ID of integrated circuit card | ||||
contactless_chip_uid | optional | Unique ID of contacless smart card | ||||
fields | optional | Pipe separated list of requested fields | ||||
barcode_number | optional | Barcode printed on a card | ||||
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 of selected result fields and their values. Available fields:
|
services/cards/check_orders_status ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://usosapps.us.edu.pl/services/cards/check_orders_status | ||||||
Get information about student card and related mcard (mLegitymacje) | ||||||
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: Empty dict on success |
services/cards/make_mcard_order ¶
|
||||||
https://usosapps.us.edu.pl/services/cards/make_mcard_order | ||||||
Create new mStudentCard order | ||||||
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 following fields and their values:
|
services/cards/mark_student_card_prolonged ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://usosapps.us.edu.pl/services/cards/mark_student_card_prolonged | ||||||
Uprade student card status as to be prolonged | ||||||
date_prolonged | required | Date that will be saved | ||||
id | optional |
Default value: (empty string) ID of a card |
||||
contact_chip_uid | optional |
Default value: (empty string) Unique ID of integrated circuit card |
||||
contactless_chip_uid | optional |
Default value: (empty string) Unique ID of contacless smart card |
||||
barcode_number | optional |
Default value: (empty string) Barcode printed on a card |
||||
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: Empty dict on success |
services/cards/mcard ¶
|
||||||
https://usosapps.us.edu.pl/services/cards/mcard | ||||||
Get information about student card and related mcard (mLegitymacje) | ||||||
fields | optional |
Default value: why_cannot_order|why_cannot_revoke|orders 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/cards/mcard_order ¶
|
||||||
https://usosapps.us.edu.pl/services/cards/mcard_order | ||||||
Get details of mStudentCard order | ||||||
order_id | required | Identifier of an order | ||||
fields | optional |
Default value: id|order_date|status|token|distribution_pass|student_number|expiration_date 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/cards/revoke_mcard ¶
|
||||||
https://usosapps.us.edu.pl/services/cards/revoke_mcard | ||||||
Revoke existing mStudentCard or mStudentCard order | ||||||
order_id | required | Identifier of an order | ||||
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 following fields and their values:
|
services/cards/student_card_data ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://usosapps.us.edu.pl/services/cards/student_card_data | ||||||
Get data required to write new structure on ELS card | ||||||
fields | optional |
Default value: certificate|system_key|card_key|structure|expiration_date|date_of_write|student_number|can_be_written|card Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
id | optional |
Default value: (empty string) ID of a card |
||||
contact_chip_uid | optional |
Default value: (empty string) Unique ID of integrated circuit card |
||||
contactless_chip_uid | optional |
Default value: (empty string) Unique ID of contacless smart card |
||||
barcode_number | optional |
Default value: (empty string) Barcode printed on a card |
||||
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 of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/cards/user ¶
|
||||||
https://usosapps.us.edu.pl/services/cards/user | ||||||
Get information on a user's ID cards.
| ||||||
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:
|
services/cards/user_cards ¶
|
||||||
https://usosapps.us.edu.pl/services/cards/user_cards | ||||||
Get all student's cards data | ||||||
fields | optional |
Default value: certificate|system_key|card_key|structure|expiration_date|date_of_write|student_number|can_be_written|card Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of student_card_data 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: Return all student's cards data, also inactive. |