Organizations

API for retrieving and manipulating organizations.

get

Returns the root level organizations the client has access rights to. Typically, only one root organization is returned, but if, for example, the client has access to two Sports Federations, both federeations are returned.

API for retrieving and manipulating a single organization by id

get

Retrieve single organization by id

API for retrieving suborganizations of an organization

get

Retrieve the list of suborganizations of an organization. The list contains all active organizations directly under the parent organization.

post

Create new suborganization under the organization.

Retrieves the full list of organizations under a Sports Federation. The list contains all active organizations in the hierarchy below the Sports Federation.

get

Retrieves the full list of organizations under a Sports Federation. The list contains all active organizations in the hierarchy below the Sports Federation.

Grants a user read/write access right to the organization.

put

Query whether the currently logged in user has read/write access rights for the specified organization.

get

Licence Period Data

API for retrieving Licence Period data.

API for retrieving Licence Periods for a Sports Federation

get

Returns the Licence Periods for a Sports Federation. The periods are ordered by the validity period, newest first.

Merit Group Data

API for retrieving merit group data.

API for retrieving the merit groups of an organization.

get

API for retrieving merit groups of an organization. The merit groups are sorted in ascending order by using the name of the merit group.

Merit data

API for retrieving merit data.

API for retrieving the merits of a merit group.

get

API for retrieving the merits of a merit group.

Granted merits

API for retrieving merits granted to the users.

API for retrieving the granted merits of a merit.

get

API for retrieving the granted merits of a merit.

Merit Granting API

API for managing merit grants

API for granting merits

post

Grant merit to users of the organization.

Sport Data

API for retrieving Sport data.

API for retrieving Sports for a Sports Federation.

get

API for retrieving Sports by Sports Federation. The Sports are ordered by name.

Insurance Data

API for retrieving Insurance data.

API for retrieving Insurances for all licence periods for a Sports Federation.

get

API for retrieving Insurances by Sports Federation. The Insurances are ordered by licence period (newest first) and Insurance name

API for retrieving Insurances for a Sports Federation's Licence Period

get

Returns the Insurances for a Sports Federation. The Insurances are ordered by licence period (newest first) and Insurance name.

Licence Data

API for retrieving Licence data.

API for retrieving licences for all licence periods for a Sports Federation.

get

API for retrieving Licences by Sports Federation. The Licences are ordered by licence usage period (newest first) and licence name

API for retrieving Licences for a Sports Federation's Licence Period

get

Returns the Licences for a Sports Federation. The Licences are ordered by licence usage period (newest first) and licence name.

API for retrieving Licences for a Sports Federation's Licence Period related to specific sport

get

Returns the Licences for a Sports Federation. The Licences are ordered by licence usage period (newest first) and licence name.

User Insurance Data

API for retrieving data of User Insurances bought to the user.

API for retrieving User Insurances for all licence periods for a Sports Federation.

get

API for retrieving User Insurances by Sports Federation. The Insurances are ordered by purchase time (newest first) and product id.

API for retrieving User Insurances for a Sports Federation's Licence Period

get

Returns the User Insurances for a Sports Federation's Licence Period. The Insurances are ordered by purchase time (newest first) and product id.

API for retrieving User Insurances for a Sports Federation's Licence Period by user Id

get

Returns the User Insurances for a Sports Federation's Licence Period. The Insurances are ordered by purchase time (newest first) and product id. Returns an empty response if licencePeriodId or userId is invalid

Event Data

API for retrieving event data.

Find events organized under the given federation.

get

Find events organized under the given federation within the given time limit and location bounding box. The federation does not need to be the actual organizer, but the event can be organized by any child entity of the federation. The time limit is interpreted in such a way that either the event starting time or the event ending time lie within the given limits.

Find the event whose UUID is the specified one.

get

API for accessing both public and private events of a sports federation and its suborganizations. The API can optionally return the basic information of event instructors, but only for a specific event organizer or a sports federation.

post

Lists events of an organization by search terms.

post

Creates a new "activity program" ("kerho") type event. This function is somewhat limited in its powers, compared to the activity program form in the Suomisport UI. This API function can only create event "drafts", which are meant to be defined more fully with the event form. For example, individual child events of the program cannot be defined with this API path.

Club Transfers of the User Licences

API for managing the club transfers of the User Licences

API for managing the club transfers of the User Licences of the Sports Federation

post

API for performing a club transfer of the User Licence

Sport Parameter Data

API for retrieving Sport Parameter data.

API for retrieving Sport Parameters for a Sports Federation.

get

API for retrieving Sport Parameters by Sports Federation. The Sport Parameters are ordered by name by default.

Event Registrations

post
get
delete
get

Event Registered Users

Manage registered users for events.

Manage registered users for an event

get

List users registered to the event. The listing contains confirmed registrants (registrations for free events and registrations that are confirmed to be paid), as well as registrations that may have been paid but the payment status is uncertain due to missing information from the payment system.

Payment Statuses (paid events only)

  • The listing may contain same registered user multiple times. It is less likely but possible that there is more than one PAID registration for a single user -- in that case the user has managed to purchase two event registrations for herself/himself.
  • If the listing contains one PAID registration and one or more WAITING_PAYMENT_CONFIRMATION for the same user, the PAID one should be considered as the valid registration and the rest will likely disappear once their payment status is confirmed to be not paid.
  • Even if the user has more than one registration to the same event the registrations should reserve only one place or slot (if the registered user count is limited). This is left to the client implementation.

ClientData

API for storing and retrieving a small amount of client-specific data

get

API for retrieving Client-specific data. The data is returned as it was stored for the client. An empty value is returned if there is no data stored for the client.

put

API for setting the Client-specific data.

delete

API for deleting the Client-specific data.

Account Data

API for accessing account data.

Provides access to the account of the currently logged-in user.

get

Retrieves the account data of the currently logged-in user.

put

Updates the profile data of the currently logged-in user. Currently, only updating the user's locale is supported.

get

Retrieves the lists of organizations to which the currently logged-in user has authorization.

get

Retrieves all user's master clubs and their clubs with permission info.

get

Retrieves all user's organizations with info.

get

Retrieves list of ids of users to which the current user has guardianship.

Provides access to the account of the user specified by the id.

get

Retrieves the account data of the specified user.

Manage product orders.

post
post
get
get
post

Manage multiple product orders at once.

get

User Licence Data

API for retrieving data of User Licences bought to users.

API for retrieving User Licences for all licence periods for a Sports Federation.

get

API for retrieving User Licences by Sports Federation. The Licences are ordered by purchase time (newest first) and product id.

API for retrieving User Licences for a Sports Federation's Licence Period

get

Returns the User Licences for a Sports Federation's Licence Period. The Licences are ordered by purchase time (newest first) and product id.

API for retrieving the user licences of the specified licence.

get

Returns the user licences of the specified licence. The licences are ordered by purchase time (newest first) and product id.

API for retrieving the user licences of the specified sport.

get

Returns the user licences of the specified sport. The licences are ordered by purchase time (newest first) and product id. Returns an empty response if licencePeriodId or sportId is invalid

API for retrieving the user licences for specific user.

get

Returns the user licences of the specified user. The licences are ordered by purchase time (newest first) and product id. Returns an empty response if licencePeriodId or userId is invalid

User Info

API for retrieving basic info of a user.

get

API for retrieving basic information of all users. Regular REST API users are not authorized to use this endpoint.

API for retrieving basic user information

get

API for retrieving basic information of a user

User Sport Parameter Data

API for creating sport parameter values for user

post
put

Value mapping

Value mappings from values used by Suomisport to those used in external systems.

get

Retrieve a list of all of the supported mappings. Each system has at least one mapping type available, but not necessarily all of them.

API for handling nationality value mappings for the given external code system.

get