People

/people get

get

Get a paged collection of people. Note: More metadata about the collection (total number of entries etc.) will be added in v2.

Secured by oauth_2_0

Query Parameters

query: (string)
A RSQL query. See RSQL documentation for more information.
Example:
```
lastName==Flyn*;roles=in=(B-18000-ZAMESTNANEC,B-13000-ZAMESTNANEC)
```
orderBy: (string)
A comma-separated list of the fields to order by, optionally prefixed with - for a descending order (default is ascending).
Example:
```
name,-year
```
limit: (integer - default: 10 - minimum: 1)
The maximal number of entries in collection to return.
offset: (integer - default: 0 - minimum: 0)
Offset of the first entry in collection.
allOfRoles: (string)
A comma-separated list of the roles that people MUST have.
DEPRECATED: Use query parameter instead, e.g. query=roles=all=(B-18000-ZAMESTNANEC,B-18000-STUDENT).
anyOfRoles: (string)
A comma-separated list of the roles that people MAY have (i.e. at least one of the roles).
DEPRECATED: Use query parameter instead, e.g. query=roles=any=(B-18000-ZAMESTNANEC,B-18000-STUDENT).
noneOfRoles: (string)
A comma-separated list of the roles that people MUST NOT have.
DEPRECATED: Use query parameter instead, e.g. query=roles=out=(B-18000-ZAMESTNANEC,B-18000-STUDENT).
name: (string)
Search people by name, ignores case and diacritic. This feature is designed to be used for an autocomplete.
DEPRECATED: Use query parameter instead, e.g. query=name=='flyn ke'
Example:
```
flyn ke
```

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    "username": "flynn",
    "personalNumber": 123456,
    "firstName": "Kevin",
    "lastName": "Flynn",
    "fullName": "Ing. Kevin Flynn, CSc.",
    "emails": [
      "flynn@fit.cvut.cz",
      "kevin.flynn@fit.cvut.cz"
    ],
    "preferredEmail": "kevin.flynn@fit.cvut.cz",
    "departments": [
      {
        "code": 18927,
        "nameCs": "Oddělení pro rozvoj",
        "nameEn": "Office of Development"
      }
    ],
    "rooms": [
      "TH:A-1324"
    ],
    "phones": [
      "420224355555"
    ],
    "roles": [
      "B-00000-ZAMESTNANEC-HPP",
      "B-00000-ZAMESTNANEC-NEAKADEMICKY",
      "B-00000-ZAMESTNANEC",
      "B-18000-ZAMESTNANEC-HPP",
      "B-18000-ZAMESTNANEC-NEAKADEMICKY",
      "B-18000-ZAMESTNANEC",
      "B-18927-ZAMESTNANEC-HPP-NEAKADEMICKY"
    ]
  }
]

Secured by oauth_2_0

Headers

Authorization: ()
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

HTTP status code 401

Bad or expired token. This can happen if the user or OAAS revoked or expired an access token. To fix, you should request a new token.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...).

URI Parameters

username: required (string)
Username of the person.

HTTP status code 200

Body

Type: application/json

Example:

{
  "username": "flynn",
  "personalNumber": 123456,
  "firstName": "Kevin",
  "lastName": "Flynn",
  "fullName": "Ing. Kevin Flynn, CSc.",
  "emails": [
    "flynn@fit.cvut.cz",
    "kevin.flynn@fit.cvut.cz"
  ],
  "preferredEmail": "kevin.flynn@fit.cvut.cz",
  "departments": [
    {
      "code": 18927,
      "nameCs": "Oddělení pro rozvoj",
      "nameEn": "Office of Development"
    }
  ],
  "rooms": [
    "TH:A-1324"
  ],
  "phones": [
    "420224355555"
  ],
  "roles": [
    "B-00000-ZAMESTNANEC-HPP",
    "B-00000-ZAMESTNANEC-NEAKADEMICKY",
    "B-00000-ZAMESTNANEC",
    "B-18000-ZAMESTNANEC-HPP",
    "B-18000-ZAMESTNANEC-NEAKADEMICKY",
    "B-18000-ZAMESTNANEC",
    "B-18927-ZAMESTNANEC-HPP-NEAKADEMICKY"
  ]
}

Secured by oauth_2_0

Headers

Authorization: ()
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

HTTP status code 401

Bad or expired token. This can happen if the user or OAAS revoked or expired an access token. To fix, you should request a new token.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...).

/people/{username}/roles head

head

This resource is intended for a quick check whether the person has or has not certain roles. When the specified condition (see query parameters) is true, then it returns status 200, otherwise 404.

/people/{username}/photo get

get

Get an official photo of the person. API currently provides only public photos of employees (i.e. person explicitly set his photo in Usermap as public).

Roles

Get a paged collection of business and technical roles. For more information about role see this page (in Czech). Note: More metadata about the collection (total number of entries etc.) will be added in v2.

Secured by oauth_2_0

Query Parameters

limit: (integer - default: 10 - minimum: 1)
The maximal number of entries in collection to return.
offset: (integer - default: 0 - minimum: 0)
Offset of the first entry in collection.

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    "code": "B-00000-ZAMESTNANEC",
    "descriptionCs": "zaměstnanec",
    "descriptionEn": "employee",
    "orgUnit": 0,
    "type": "BUSINESS"
  }, {
    "code": "B-18927-ZAMESTNANEC-HPP-NEAKADEMICKY",
    "descriptionCs": "neakademický zaměstnanec HPP / Oddělení pro rozvoj / FIT",
    "descriptionEn": "Non-academic employee with employment contract / Office of Development / FIT",
    "orgUnit": 18927,
    "type": "BUSINESS"
  }
]

Secured by oauth_2_0

Headers

Authorization: ()
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

HTTP status code 401

Bad or expired token. This can happen if the user or OAAS revoked or expired an access token. To fix, you should request a new token.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...).

/roles/{code} get

get

Secured by oauth_2_0

URI Parameters

code: required (string)
Code of the role.
Example:
```
B-18000-ZAMESTNANEC
```

HTTP status code 200

Body

Type: application/json

Example:

{
   "code": "B-18927-ZAMESTNANEC-HPP-NEAKADEMICKY",
   "descriptionCs": "neakademický zaměstnanec HPP / Oddělení pro rozvoj / FIT",
   "descriptionEn": "Non-academic employee with employment contract / Office of Development / FIT",
   "orgUnit": 18927,
   "type": "BUSINESS"
}

Secured by oauth_2_0

Headers

Authorization: ()
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

HTTP status code 401

Bad or expired token. This can happen if the user or OAAS revoked or expired an access token. To fix, you should request a new token.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...).

/roles/{code}/members get

get

List all members of the role (their usernames).

Secured by oauth_2_0

URI Parameters

code: required (string)
Code of the role.
Example:
```
B-18000-ZAMESTNANEC
```

HTTP status code 200

Body

Type: application/json

Example:

{
  members: [
    "flynn",
    "jirutjak",
    "kordikp"
  ]
}

Secured by oauth_2_0

Headers

Authorization: ()
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

HTTP status code 401

Bad or expired token. This can happen if the user or OAAS revoked or expired an access token. To fix, you should request a new token.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...).

Umapi API documentation version v1

People

/people get

/people/{username} get

/people/{username}/roles head

/people/{username}/photo get

Roles

/roles get

/roles/{code} get

/roles/{code}/members get

Umapi API documentation version v1

People

/people get

get /people

Query Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

/people/{username} get

get /people/{username}

URI Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

/people/{username}/roles head

head /people/{username}/roles

URI Parameters

Query Parameters

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

/people/{username}/photo get

get /people/{username}/photo

URI Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

Roles

/roles get

get /roles

Query Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

/roles/{code} get

get /roles/{code}

URI Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403

/roles/{code}/members get

get /roles/{code}/members

URI Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

HTTP status code 401

HTTP status code 403