Events module
:: services/events2 module

TODO

Methods

distribution_channel Get information about distribution channel
event_channel get information about assignment channel to event type
event_type Get information about event type
event_types_index Get all events types
generate_one_time_code Generate and send one time code to user
notification_channels_index List of all notifiaction channels
update_event_channel Update event channel for selected event type
update_event_type Get information about event type
validate_one_time_code Generate and send one time code to user

services/events2/distribution_channel

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/distribution_channel

Get information about distribution channel

id required ID of channel
fields optional

Default value: id|name|consumer_key

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:

  • id - Unique ID of distribution channel;

  • event_type - Event type that channel is assigned to.

    This field references objects returned by event_type method. See its returns section for possible subfields (only primary are allowed).

  • name - Name of event type;

  • consumer_key - Consumer key related to channel.

services/events2/event_channel

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/event_channel

get information about assignment channel to event type

event_type_id required ID of event type
channel_id required ID of channel
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 following fields and their values:

  • channel - Assigned channel.

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

  • event_type - Assigned event type.

    This field references objects returned by event_type method. See its returns section for possible subfields (only primary are allowed).

  • is_enabled - True if sending of this kind of events is enabled;

  • is_mandatory - If true, student cannot disable receiving events of this type;

  • send_by_default - If true, user that will receive this kind of events by default.

services/events2/event_type

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/event_type

Get information about event type

id required ID of an event
fields optional

Default value: id|name|description|is_enabled|is_mandatory|send_by_default

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:

  • Primary:

    • id - Unique ID of event type;

    • name - Name of event type;

    • description - Description of event type;

    • is_enabled - True if sending of this kind of events is enabled;

    • is_mandatory - If true, student cannot disable receiving events of this type;

    • send_by_default - If true, user that will receive this kind of events by default.

  • Secondary:

    • channels - List of related channels.

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

services/events2/event_types_index

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/event_types_index

Get all events types

fields optional

Default value: id|name|description|is_enabled|is_mandatory|send_by_default

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of event_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:

List of all available types

services/events2/generate_one_time_code

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/generate_one_time_code

Generate and send one time code to user

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:

Unuque token used to verification of generated code

services/events2/notification_channels_index

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/notification_channels_index

List of all notifiaction channels

fields required

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:

  • id - ID of event channel;

  • name - Langdict object;

  • description - Langdict object.

services/events2/update_event_channel

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/update_event_channel

Update event channel for selected event type

body required Object is accepted as POST body
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:

Empty dict on success

services/events2/update_event_type

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/update_event_type

Get information about event type

body required Object is accepted as POST body
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:

Empty dict on success

services/events2/validate_one_time_code

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.demo.usos.edu.pl/services/events2/validate_one_time_code

Generate and send one time code to user

id required ID of a code
code required code to be validated
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:

empty dict on success
USOS API ver. 6.5.0.0-0, e4308391, dirty (2019-07-15)