Electronic ID cards
:: services/cards module

These methods allow you to access information on ID cards of any type: student's, PhD and staff's. It is also possible to get user info using cards numbers.

Please note that only valid cards are listed.

Methods

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.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: not required
https://usosapps.uwb.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:

  • user - dictionaries describing the owner of selected card; each dictionary contains fields from primary section in {method_link 'services/users/user'} method,
  • id - ID of a card
  • contact_chip_uid - unique ID of integrated circuit card,
  • contactless_chip_uid - unique ID of contacless smart card,
  • barcode_number - barcode printed on a card,
  • type - type of card, one of: 'student', 'phd', 'staff', 'graduate', 'academic_teacher'
  • expiration_date - ID card expiration date,
  • date_of_issue - card's date of issue.
  • student_number - Student number printed on a card

services/cards/check_orders_status

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: required
https://usosapps.uwb.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

Consumer: required Token: required Scopes: cards SSL: required
https://usosapps.uwb.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:

  • success - True if order was registered successfully.

services/cards/mark_student_card_prolonged

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: required
https://usosapps.uwb.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

Consumer: required Token: required Scopes: cards SSL: required
https://usosapps.uwb.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:

  • why_cannot_order - If an order is not allowed, langdict with message;

  • why_cannot_revoke - Langdict with message.;

  • orders - If order is already made details will be returned.

    This field references objects returned by mcard_order method. See its returns section for possible subfields.

services/cards/mcard_order

Consumer: required Token: required Scopes: cards SSL: required
https://usosapps.uwb.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:

  • id - Id of an order;

  • order_date - Datetime string with time of order;

  • status - one of following values: pending, in_progress, ready_to_receive, error, received, revoked;

  • token - If order has status 'ready' token for mObywatel app will be returned;

  • distribution_pass - If order has status 'ready' distribution password will be returned;

  • student_number - Student number related to mcard;

  • expiration_date - Expiration date of mcard.

services/cards/revoke_mcard

Consumer: required Token: required Scopes: cards SSL: required
https://usosapps.uwb.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:

  • success - True if order was registered successfully.

services/cards/student_card_data

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: required
https://usosapps.uwb.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:

  • certificate - Certificate in structure's signature;

  • system_key - Key used in structure's signature;

  • card_key - Key that allows write data on a card;

  • structure - Structure that is written or has to be written on a card;

  • expiration_date - Expiration date of a structure;

  • date_of_write - Date of write of a structure;

  • student_number - Student number printed on a card;

  • can_be_written - True if new structure may be written on a card;

  • card - Card object related.

    This field references objects returned by card method. See its returns section for possible subfields.

Thrown errors:

  • object_not_found - some of the referenced objects do not exist.

services/cards/user

Consumer: required Token: required Scopes: cards SSL: not required
https://usosapps.uwb.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:

Array of dictionaries describing cards of access token issuer. Note that will be returned only:
  • student and phd cards that are not cancelled
  • staff cards that are not cancelled and not expired
each dictionary contains fields from card method

services/cards/user_cards

Consumer: required Token: required Scopes: cards SSL: required
https://usosapps.uwb.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.
USOS API ver. 7.1.0.0-7, d04098c0, dirty (2024-11-07)