Accessing information on administration documents
:: services/adm_documents module

These methods allow you to search for administration documents and access information on them.

Methods

document Get information on administration document by id.
generate_code Generates code and sends it by email
get_upd Get selected administration document UPD of a given user.
get_upo Get selected administration document UPO of a given user.
receive Receive document using authorization code
user_documents Get information on administration documents of a given user.

services/adm_documents/document

Consumer: required Token: optional Scopes: adm_documents SSL: required
https://apps.asp.katowice.pl/services/adm_documents/document

Get information on administration document by id.

id required ID of document
fields optional

Default value: id|published_date|delivered_date|id_blobbox|actions|name|status|type|type_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:

  • id - An administration document id;

  • published_date - Document publish date;

  • delivered_date - Document delivery date;

  • id_blobbox - An Blob id;

  • actions - Allowed actions;

  • name - LangDict;

  • status - LangDict;

  • type - Document type;

  • type_name - langdict: document type name.

Thrown errors:

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

services/adm_documents/generate_code

Consumer: required Token: optional Scopes: adm_documents SSL: required
https://apps.asp.katowice.pl/services/adm_documents/generate_code

Generates code and sends it by email

id required Document id
lang optional

Default value: pl

Language
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:

Date and used email address

services/adm_documents/get_upd

Consumer: required Token: required Scopes: adm_documents SSL: required
https://apps.asp.katowice.pl/services/adm_documents/get_upd

Get selected administration document UPD of a given user.

adm_document_id required ID of Administration document
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:

UPD as XML file will be returned.

Thrown errors:

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

services/adm_documents/get_upo

Consumer: required Token: required Scopes: adm_documents SSL: required
https://apps.asp.katowice.pl/services/adm_documents/get_upo

Get selected administration document UPO of a given user.

adm_document_id required ID of Administration document
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:

UPO as XML file will be returned.

Thrown errors:

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

services/adm_documents/receive

Consumer: required Token: optional Scopes: adm_documents SSL: required
https://apps.asp.katowice.pl/services/adm_documents/receive

Receive document using authorization code

id required Document id
code required Authorization code sent by email
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:

If OK: OK message

In case of error: number of trials left or code reset info

Thrown errors:

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

  • param_invalid - parameter has invalid value.

services/adm_documents/user_documents

Consumer: required Token: optional Scopes: adm_documents SSL: required
https://apps.asp.katowice.pl/services/adm_documents/user_documents

Get information on administration documents of a given user.

fields optional

Default value: id|published_date|delivered_date|id_blobbox|actions|name|status|type|type_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 document 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:

List of administration decisions. Selected fields and their values defined in the document.

USOS API ver. 6.6.1.0-2, bd9e1233, dirty (2021-03-10)