Suomisport API API documentation version v2

https://www.suomisport.fi/api/public/{version}

version: required(v2)

Overview

Welcome to the Suomisport API documentation. The Suomisport API lets the clients connect Suomisport service, retrieve Sports Federation organization data, retrieve Sports Federation season data (seasons, licences, insurances) and access the licenced athletes' data of a Sports Federation. Furthermore, the API allows the clients to update and amend the Sports Federations athletes' data.

Version information

Version 2.4.0, 2020-05-15

Authentication

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Generating the access token

Generate the Basic authorization key for the client id and client secret

$ echo -n '<client-id:client-secret>' | base64

results in:

<base-64-encoded-client-id-with-client-secret>

Use the token endpoint with Basic authorization to obtain the AccessToken

$ curl -X POST -H 'Authorization: Basic <base-64-encoded-client-id-with-client-secret>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
https://test.sportapi.fi/oauth2/token?grant_type=client_credentials

results in:

{
"access_token":"eyJraWQiOiJvYWk . . . mge-YG_4VqzXaUeGdcmT0",
"token_type":"bearer",
"expires_in":3600
}

Use the access token to access the resources

$ curl -H 'Authorization: Bearer <access-token-from-previous-step>' \
https://test.sportapi.fi/api/public/v1/organization

results in:

{
"content": [{
 "id":3245,
 "type":"SPORTS_FEDERATION",
 "name":"Suomen Liittoliitto ry",
 "shortName":"SLL",
 "sportId":12345678,
 "address": {
   "streetAddress":"Radiokatu 20",
   "postCode":"00240",
   "postOffice":"HELSINKI", \
   "countryCode":"FI"
 },
 "parentId":1,
 "modificationTime":"2017-04-03T12:41:56.662+0000",
 "status":"ACTIVE"
}],
"pageable": {
 "page":0,
 "size":50,
 "total":1
}
}

Generic process for synchronizing data

Suomisport provides APIs to retrieve all of the data related to the organization the client is authorized for. The generic principle for keeping in sync with the Suomisport data is descibed below.

Fetch all of the data for the API. You can use pagination to fetch the data in chunks of suitable size. Save the newest modification timestamp (typically result.content[n].modificationTime) of the base to your data store. Remember to retrieve all pages of results!

For example

$ curl -H 'Authorization: Bearer <access-token>' \
   "https://test.sportapi.fi/api/public/v1/user-licence/123/456?page=0&size=100"

$ curl -H 'Authorization: Bearer <access-token>' \
   "https://test.sportapi.fi/api/public/v1/user-licence/123/456?page=1&size=100"

$ curl -H 'Authorization: Bearer <access-token>' \
   "https://test.sportapi.fi/api/public/v1/user-licence/123/456?page=2&size=100"

   . . .

results in

{
   "content": [{
       "id": 987,
       "modificationTime": "2020-05-15T09:01:12.221Z",
       . . .
   },
   . . .
   ],
   "pageable": {
       "page": 0,
       "size": 100,
       "total": 1000
   }
}

On the next retrieval, use the newest timestamp you already have as the ts-parameter (last-modified-since) to retrieve the modifications after the timestamp. Remember to retrieve all pages of results! Update the newest modification timestamp saved in the client database.
For example:
```
$ curl -H 'Authorization: Bearer <access-token>' \
   "https://test.sportapi.fi/api/public/v1/user-licence/123/456?page=0&size=100&ts=2017-09-09T12:01:12.221Z"
```

Permissions

Permissions overview

Suomisport has two-level permission system for the API. The client access is limited by the organizations the client is granted (read or write) access to and by specific permissions for the artifacts of the organizations. The specific permissions typically limit the clients access to users' profile information - for example access to user social security number requires the PERMISSION_USER_SSN permission.

Organization permissions

The client has one or more organizations to which the client has either read or write permission. The write permission always includes read permission's capabilities.

Organization hierarchy

The organizations in Suomisport are organized in a hierarchy. On the top of the hierarchy is the Olympic Committee under which are the Sports Federations. Under the Sports Federations, there may be zero or more Areas. Clubs are under either Sports Federation or an Area of a Sports Federation.

Cascading organization permissions

The organization permissions the client has for a higher hierarchy level organization cascades to the suborganizations of the higher-level organization. If the client has read permission to a Sports Federation, the client implicitly has read permissions to the Sports Federation's Areas and Clubs.

Special permissions

There are certain special cases where the hierarchical permission model does not work. For these cases the client may need special permissions. Typical targets for special permissions is the user personal data.

User personal data

User personal data must be protected, so Suomisport has a permission system exactly for that.

PERMISSION_USER_ANONYMOUS

Allows anonymous access to user data (sport-id only). If the user permission is not defined, PERMISSION_USER_ANONYMOUS is used.

PERMISSION_USER_BASIC

Allows access to user name, sport-id, home city, language code, gender, deceased date.

PERMISSION_USER_CONTACT_INFO

In addition to above, allows access to user contact information including address, email and phone number.

PERMISSION_USER_EXTENDED

In addition to above, allows access to user date of birth, nationality , and information on whether the user has a Finnish Social Security Number or not (not the actual SSN, though).

PERMISSION_USER_SSN

In addition to above, allows access to user social security number

Organizations

API for retrieving and manipulating organizations.

/organization get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```

HTTP status code 200

The root level organizations the client has access rights to.

Body

Media type: application/json

Type: object

Properties

content: required(array of org.Organization)
The list of organization entries on the page
Items: Organization
- id: required(integer)
  The Suomisport id of the organization
- type: required(one of SPORTS_FEDERATION, AREA, CLUB, GROUP, ORGANIZATION_COLLECTION)
  The type of the organization
- collectionType: required(one of MASTER_CLUB, AREA_ASSOCIATION)
  The collection type of the organization if it represents an organization collection
- name: required(string)
  The organization name
- shortName: (string)
  The organization short name
- description: (string)
  The long description of the organization
- sportId: required(integer - minimum: 10000000 - maximum: 999999999)
  The Sport-ID of the organization
- address: (object)
  The address of the organization
  - streetAddress: required(string)
  - postCode: required(string)
  - postOffice: required(string)
  - state: (string)
  - countryCode: (string)
- parentId: (integer)
  The parent id of the organization
- federationId: (integer)
  The parent federation id of the organization
- modificationTime: required(datetime)
  Last modification time of the organization
- status: required(one of ACTIVE, PASSIVE - default: ACTIVE)
  Lifecycle status of the organization
- businessId: (string)
  Business id of organization
- emailAddress: (string)
  Email address of organization
- masterClubId: (integer)
  The id of the master club containing this organization
- areaAssociationId: (integer)
  The id of the area association containing this organization
- federationName: (string)
  The parent federation name of the organization
- masterClubName: (string)
  The name of the master club containing this organization
- areaAssociationName: (string)
  The name of the area association containing this organization
- iban: (string)
  The IBAN bank account number of this organization
- bic: (string)
  The BIC bank identifier of this organization
- municipalityId: (integer)
  The ID of the municipality of this organization
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

/organization/{id}/suborganizations get post

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.

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

id: required(integer)
The id of the organization

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.
orgtypes: (string - maxLength: 15 - pattern: ^(SPORTS_FEDERATION|AREA|CLUB|GROUP)(,(SPORTS_FEDERATION|AREA|CLUB|GROUP))*$)
Suborganization type filter. Includes only the defined organization types in the result.
Example:
```
AREA,CLUB
```
businessId: (string)
Return only suborganizations with specified business id.
Example:
```
1234567-8
```

HTTP status code 200

List of suborganizations of the organization

Body

Media type: application/json

Type: object

Properties

content: required(array of org.Organization)
The list of organization entries on the page
Items: Organization
- id: required(integer)
  The Suomisport id of the organization
- type: required(one of SPORTS_FEDERATION, AREA, CLUB, GROUP, ORGANIZATION_COLLECTION)
  The type of the organization
- collectionType: required(one of MASTER_CLUB, AREA_ASSOCIATION)
  The collection type of the organization if it represents an organization collection
- name: required(string)
  The organization name
- shortName: (string)
  The organization short name
- description: (string)
  The long description of the organization
- sportId: required(integer - minimum: 10000000 - maximum: 999999999)
  The Sport-ID of the organization
- address: (object)
  The address of the organization
  - streetAddress: required(string)
  - postCode: required(string)
  - postOffice: required(string)
  - state: (string)
  - countryCode: (string)
- parentId: (integer)
  The parent id of the organization
- federationId: (integer)
  The parent federation id of the organization
- modificationTime: required(datetime)
  Last modification time of the organization
- status: required(one of ACTIVE, PASSIVE - default: ACTIVE)
  Lifecycle status of the organization
- businessId: (string)
  Business id of organization
- emailAddress: (string)
  Email address of organization
- masterClubId: (integer)
  The id of the master club containing this organization
- areaAssociationId: (integer)
  The id of the area association containing this organization
- federationName: (string)
  The parent federation name of the organization
- masterClubName: (string)
  The name of the master club containing this organization
- areaAssociationName: (string)
  The name of the area association containing this organization
- iban: (string)
  The IBAN bank account number of this organization
- bic: (string)
  The BIC bank identifier of this organization
- municipalityId: (integer)
  The ID of the municipality of this organization
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

Create new suborganization under the organization.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

id: required(integer)
The id of the organization

Body

Media type: application/json

Type: object

Properties

id: required(integer)
The Suomisport id of the organization
type: required(one of SPORTS_FEDERATION, AREA, CLUB, GROUP, ORGANIZATION_COLLECTION)
The type of the organization
collectionType: required(one of MASTER_CLUB, AREA_ASSOCIATION)
The collection type of the organization if it represents an organization collection
name: required(string)
The organization name
shortName: (string)
The organization short name
description: (string)
The long description of the organization
sportId: required(integer - minimum: 10000000 - maximum: 999999999)
The Sport-ID of the organization
address: (object)
The address of the organization
- streetAddress: required(string)
- postCode: required(string)
- postOffice: required(string)
- state: (string)
- countryCode: (string)
parentId: (integer)
The parent id of the organization
federationId: (integer)
The parent federation id of the organization
modificationTime: required(datetime)
Last modification time of the organization
status: required(one of ACTIVE, PASSIVE - default: ACTIVE)
Lifecycle status of the organization
businessId: (string)
Business id of organization
emailAddress: (string)
Email address of organization
masterClubId: (integer)
The id of the master club containing this organization
areaAssociationId: (integer)
The id of the area association containing this organization
federationName: (string)
The parent federation name of the organization
masterClubName: (string)
The name of the master club containing this organization
areaAssociationName: (string)
The name of the area association containing this organization
iban: (string)
The IBAN bank account number of this organization
bic: (string)
The BIC bank identifier of this organization
municipalityId: (integer)
The ID of the municipality of this organization

HTTP status code 201

Organization was created successfully

Body

Media type: application/json

Type: object

Properties

id: required(integer)
The Suomisport id of the organization
type: required(one of SPORTS_FEDERATION, AREA, CLUB, GROUP, ORGANIZATION_COLLECTION)
The type of the organization
collectionType: required(one of MASTER_CLUB, AREA_ASSOCIATION)
The collection type of the organization if it represents an organization collection
name: required(string)
The organization name
shortName: (string)
The organization short name
description: (string)
The long description of the organization
sportId: required(integer - minimum: 10000000 - maximum: 999999999)
The Sport-ID of the organization
address: (object)
The address of the organization
- streetAddress: required(string)
- postCode: required(string)
- postOffice: required(string)
- state: (string)
- countryCode: (string)
parentId: (integer)
The parent id of the organization
federationId: (integer)
The parent federation id of the organization
modificationTime: required(datetime)
Last modification time of the organization
status: required(one of ACTIVE, PASSIVE - default: ACTIVE)
Lifecycle status of the organization
businessId: (string)
Business id of organization
emailAddress: (string)
Email address of organization
masterClubId: (integer)
The id of the master club containing this organization
areaAssociationId: (integer)
The id of the area association containing this organization
federationName: (string)
The parent federation name of the organization
masterClubName: (string)
The name of the master club containing this organization
areaAssociationName: (string)
The name of the area association containing this organization
iban: (string)
The IBAN bank account number of this organization
bic: (string)
The BIC bank identifier of this organization
municipalityId: (integer)
The ID of the municipality of this organization

Secured by oauth_2_0

/organization/{id}/list get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

id: required(integer)
The id of the organization

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.
orgtypes: (string - maxLength: 15 - pattern: ^(SPORTS_FEDERATION|AREA|CLUB|GROUP)(,(SPORTS_FEDERATION|AREA|CLUB|GROUP))*$)
Suborganization type filter. Includes only the defined organization types in the result.
Example:
```
AREA,CLUB
```
businessId: (string)
Return only suborganizations with specified business id.
Example:
```
1234567-8
```

HTTP status code 200

List of all organizations under a Sports Federation

Body

Media type: application/json

Type: object

Properties

content: required(array of org.Organization)
The list of organization entries on the page
Items: Organization
- id: required(integer)
  The Suomisport id of the organization
- type: required(one of SPORTS_FEDERATION, AREA, CLUB, GROUP, ORGANIZATION_COLLECTION)
  The type of the organization
- collectionType: required(one of MASTER_CLUB, AREA_ASSOCIATION)
  The collection type of the organization if it represents an organization collection
- name: required(string)
  The organization name
- shortName: (string)
  The organization short name
- description: (string)
  The long description of the organization
- sportId: required(integer - minimum: 10000000 - maximum: 999999999)
  The Sport-ID of the organization
- address: (object)
  The address of the organization
  - streetAddress: required(string)
  - postCode: required(string)
  - postOffice: required(string)
  - state: (string)
  - countryCode: (string)
- parentId: (integer)
  The parent id of the organization
- federationId: (integer)
  The parent federation id of the organization
- modificationTime: required(datetime)
  Last modification time of the organization
- status: required(one of ACTIVE, PASSIVE - default: ACTIVE)
  Lifecycle status of the organization
- businessId: (string)
  Business id of organization
- emailAddress: (string)
  Email address of organization
- masterClubId: (integer)
  The id of the master club containing this organization
- areaAssociationId: (integer)
  The id of the area association containing this organization
- federationName: (string)
  The parent federation name of the organization
- masterClubName: (string)
  The name of the master club containing this organization
- areaAssociationName: (string)
  The name of the area association containing this organization
- iban: (string)
  The IBAN bank account number of this organization
- bic: (string)
  The BIC bank identifier of this organization
- municipalityId: (integer)
  The ID of the municipality of this organization
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The parent organization is not a Sports Federation or query parameters are malformed.

Secured by oauth_2_0

Licence Period Data

API for retrieving Licence Period data.

/licenceperiod/{sportsFederationId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The id of the Sports Fededation

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Licence Periods for the Sports Federation.

Body

Media type: application/json

Type: object

Properties

content: required(array of period.LicencePeriod)
The list of Licence Period entries on the page
Items: LicencePeriod
- id: required(integer)
  The Suomisport id of the Licence Period
- modificationTime: required(datetime)
  Last modification time of the Licence Period
- federationId: required(integer)
  The Sports Federation id of the Licence Period
- name: required(string)
  The Licence Period name
- startTime: required(date-only)
  The Licence Period start date
- endTime: required(date-only)
  The Licence Period end date
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The organization is not a Sports Federation and cannot have Licence Periods

Secured by oauth_2_0

Licence Data

API for retrieving Licence data.

/licence/{sportsFederationId} get

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Licences for the Sports Federation

Body

Media type: application/json

Type: object

Properties

content: required(array of licence.Licence)
The list of Licence entries on the page
Items: Licence
- id: required(integer)
  The Suomisport id of the Licence
- modificationTime: required(datetime)
  Last modification time of the Licence
- federationId: required(integer)
  The Sports Federation id of the Licence
- licencePeriodId: required(integer)
  The Licence Period id of the Licence
- name: required(string)
  The Licence name
- description: (string)
  The Licence description
- priceInCents: required(integer - minimum: 0)
  The price of the licence in cents
- salesStartTime: required(date-only)
  The Licence sales start date
- salesEndTime: required(date-only)
  The Licence sales end date
- usageStartTime: required(date-only)
  The Licence usage period start date
- usageEndTime: required(date-only)
  The Licence usage period end date
- earliestBirthDate: (date-only)
  The earliest birth date the Licence is valid for
- latestBirthDate: (date-only)
  The latest birth date the Licence is valid for
- type: (one of Competition, Hobby, Judge, Trustee)
  Type of the licence
- validityDurationInDays: (integer)
  Licence validity duration when the licence is valid for a fixed number of days.
- insuranceRequirement: required(one of SpecificInsurance, AnyInsurance, InsuranceNotRequired)
  Insurance requirement for the licence
- requireExternalInsuranceInfo: required(boolean)
  True, if external insurance information entry is required, false otherwise.
- insuranceIds: (array of entityids.EntityId - minItems: 1 - maxItems: 10000)
  List of ids of insurances that can be bought with the licence
- sportsIds: required(array of entityids.EntityId - minItems: 1 - maxItems: 10000)
  List of sports the licence applies to
- costCenter: (string)
  Cost center for the licence
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id is invalid

Secured by oauth_2_0

/licence/{sportsFederationId}/{licencePeriodId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Licences for the Sports Federation.

Body

Media type: application/json

Type: object

Properties

content: required(array of licence.Licence)
The list of Licence entries on the page
Items: Licence
- id: required(integer)
  The Suomisport id of the Licence
- modificationTime: required(datetime)
  Last modification time of the Licence
- federationId: required(integer)
  The Sports Federation id of the Licence
- licencePeriodId: required(integer)
  The Licence Period id of the Licence
- name: required(string)
  The Licence name
- description: (string)
  The Licence description
- priceInCents: required(integer - minimum: 0)
  The price of the licence in cents
- salesStartTime: required(date-only)
  The Licence sales start date
- salesEndTime: required(date-only)
  The Licence sales end date
- usageStartTime: required(date-only)
  The Licence usage period start date
- usageEndTime: required(date-only)
  The Licence usage period end date
- earliestBirthDate: (date-only)
  The earliest birth date the Licence is valid for
- latestBirthDate: (date-only)
  The latest birth date the Licence is valid for
- type: (one of Competition, Hobby, Judge, Trustee)
  Type of the licence
- validityDurationInDays: (integer)
  Licence validity duration when the licence is valid for a fixed number of days.
- insuranceRequirement: required(one of SpecificInsurance, AnyInsurance, InsuranceNotRequired)
  Insurance requirement for the licence
- requireExternalInsuranceInfo: required(boolean)
  True, if external insurance information entry is required, false otherwise.
- insuranceIds: (array of entityids.EntityId - minItems: 1 - maxItems: 10000)
  List of ids of insurances that can be bought with the licence
- sportsIds: required(array of entityids.EntityId - minItems: 1 - maxItems: 10000)
  List of sports the licence applies to
- costCenter: (string)
  Cost center for the licence
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id or the licence period id is invalid

Secured by oauth_2_0

/licence/{sportsFederationId}/{licencePeriodId}/sport/{sportId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id
sportId: required(integer)
The id of the sport

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Licences for the Sports Federation's Licence Period. Returns an empty response if licencePeriodId is invalid

Body

Media type: application/json

Type: object

Properties

content: required(array of licence.Licence)
The list of Licence entries on the page
Items: Licence
- id: required(integer)
  The Suomisport id of the Licence
- modificationTime: required(datetime)
  Last modification time of the Licence
- federationId: required(integer)
  The Sports Federation id of the Licence
- licencePeriodId: required(integer)
  The Licence Period id of the Licence
- name: required(string)
  The Licence name
- description: (string)
  The Licence description
- priceInCents: required(integer - minimum: 0)
  The price of the licence in cents
- salesStartTime: required(date-only)
  The Licence sales start date
- salesEndTime: required(date-only)
  The Licence sales end date
- usageStartTime: required(date-only)
  The Licence usage period start date
- usageEndTime: required(date-only)
  The Licence usage period end date
- earliestBirthDate: (date-only)
  The earliest birth date the Licence is valid for
- latestBirthDate: (date-only)
  The latest birth date the Licence is valid for
- type: (one of Competition, Hobby, Judge, Trustee)
  Type of the licence
- validityDurationInDays: (integer)
  Licence validity duration when the licence is valid for a fixed number of days.
- insuranceRequirement: required(one of SpecificInsurance, AnyInsurance, InsuranceNotRequired)
  Insurance requirement for the licence
- requireExternalInsuranceInfo: required(boolean)
  True, if external insurance information entry is required, false otherwise.
- insuranceIds: (array of entityids.EntityId - minItems: 1 - maxItems: 10000)
  List of ids of insurances that can be bought with the licence
- sportsIds: required(array of entityids.EntityId - minItems: 1 - maxItems: 10000)
  List of sports the licence applies to
- costCenter: (string)
  Cost center for the licence
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 403

The sports federation id is invalid or user has no rights to requested sports federation

Secured by oauth_2_0

Merit Group Data

API for retrieving merit group data.

/merit-group/{organizationId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

organizationId: required(integer)
The organization id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The merit groups of an organization.

Body

Media type: application/json

Type: object

Properties

content: required(array of merit.MeritGroup)
The list of merit groups that belong to this page.
Items: MeritGroup
- id: required(integer)
  The Suomisport id of the merit group
- isOrdered: required(boolean)
  true if the merits of this merit group are ordered and false otherwise.
- isSportBound: required(boolean)
  true if the merits of this merit group are bound to a specific sport and false otherwise.
- modificationTime: required(datetime)
  The last modification time of the merit group.
- name: required(string)
  The name of the merit group
- organizationId: required(integer)
  The id of the organization that owns this merit group
- sportId: required(integer)
  The id of the sport in which the merits of this merit group are bound.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The organization id is invalid

Secured by oauth_2_0

Merit data

API for retrieving merit data.

/merit/{groupId} get

API for retrieving the merits of a merit group.

get

API for retrieving the merits of a merit group.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

groupId: required(integer)
The merit group id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The merits of a merit group.

Body

Media type: application/json

Type: object

Properties

content: required(array of merit.Merit)
The list of merits that belong to this page.
Items: Merit
- id: required(integer)
  The Suomisport id of the merit.
- description: required(string)
  The description of this merit.
- meritGrantingAuthorType: required(string)
  The type of entity who can grant this merit. The legal values are:
  BOTH means that both a club and a sport federation can grant this merit. CLUB means that only a club can grant this merit. FEDERATION means that only a sport federation can grant this merit.
- meritGroupId: required(integer)
  The Suomisport id of the merit group that owns this merit.
- meritGroupName: required(string)
  The name of the merit group that owns this merit.
- meritValidityPeriodType: required(string)
  The type of the validity period. The legal values are:
  PERPETUAL means that the awarded merit is valid without any time-bound limitations. FIXED_DURATION means that the awarded merit is valid for given period for example 3 years. FIXED_DATE means that the awarded merit is valid until the given date for example 25-05-2018.
- modificationTime: required(datetime)
  The modification time of this merit.
- name: required(string)
  The name of this merit.
- orderNumber: required(integer - minimum: 1)
  The order number of this merit. The merits should be sorted in ascending order by using the value of this field.
- type: required(string)
  The type of this merit. The legal values are:
  COMPETITION means that the merit is for competitional purpose like belts in many martial arts. CARD means that the merit is for other than competitional purposes like getting free entrance on games or honoring person who has done 10 years of work for some club or federation.
- validityFixedDate: required(date-only)
  The end date of the validity period. This is given only if the value of the meritValidityPeriodType is FIXED_DATE.
- validityFixedDurationInMonths: required(integer - minimum: 1)
  The validity period of this merit in months. This given only if the value of the meritValidityPeriodType is FIXED_DURATION.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The merit group id is invalid.

Secured by oauth_2_0

Granted merits

API for retrieving merits granted to the users.

/granted-merit/{meritId} get

API for retrieving the granted merits of a merit.

get

API for retrieving the granted merits of a merit.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

meritId: required(integer)
The merit id.

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The granted merits of a merit.

Body

Media type: application/json

Type: object

Properties

content: required(array of merit.MeritUser)
The list of users that belong to this page.
Items: MeritUser
- id: required(integer)
  The user id.
- additionalInformation: required(string)
  Contains additional information about the granted merit.
- email: required(string)
  The email address of the user.
- firstName: required(string)
  The first name of the user.
- nickname: (string)
  The calling name (nick name) of the user
- grantedMerit: required(object)
  The merit that has been granted to this user.
  - id: required(integer)
    The granted merit Suomisport id
  - grantingDate: required(date-only)
    The date in which this merit was granted.
  - meritGroupId: required(integer)
    The id of the merit group.
  - meritGroupName: required(string)
    The name of the merit group.
  - meritId: required(integer)
    The id of the merit.
  - meritGranter: required(string)
    The name of entity or person who granted this merit.
  - meritName: required(string)
    The name of the merit.
  - registrationDate: required(date-only)
    Describes the date when the merit was acknowled by an external party. For example, most belt ranks used in combat sports must be acknowled by an international sport federation, and this field contains the date when this was done.
  - validUntilDate: required(date-only)
    The last validity date of this merit.
- guardians: required(array of user.GuardianInformation)
  Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
  Items: GuardianInformation
  - firstName: required(string)
    Guardian first name or nickname
  - lastName: required(string)
    Guardian last name
  - email: (string)
    Guardian email address
  - phone: (string)
    Guardian phone number
- lastName: required(string)
  The last name of the user.
- phoneNumber: required(string)
  The phone number of the user.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The merit id is invalid.

Secured by oauth_2_0

Merit Granting API

API for managing merit grants

/merit-grant/grant/{meritId} post

API for granting merits

post

Grant merit to users of the organization.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

meritId: required(integer)
The merit id.

Body

Media type: application/json

Type: object

Properties

grantingDate: required(date-only)
The granting date for the merit
granterUserId: (integer)
The optional Suomisport user id of the merit granter. Either the granter user id or the merit granter must be provided. If both are provided, the granter user id takes precedence over the granter name.
meritGranter: (string - minLength: 1 - maxLength: 255)
The optional name for the merit granter. Either the granter user id or the merit granter must be provided. If both are provided, the granter user id takes precedence over the granter name.
meritAdditionalInfo: (string - maxLength: 2048)
The optional additional info for the granted merit.
registrationDate: (date-only)
The optional date when the merit was acknowledged by an external party. For example, most higher belt ranks used in combat sports must be acknowledged by an international sport federation, and this field contains the date when this was done.
meritGrantees: required(array of entityids.EntityId - minItems: 1 - maxItems: 10000)
The list ids of the users the merit is granted to. The users must be readable by the organization - i.e. the users must have a valid licence, insurance or membership or a recent event registration for the granting organization. The format is array of unique Suomisport user ids (integers).
notifyGrantees: (boolean - default: true)
Optional setting to control whether to notify the grantees on the granted merit. Default functionality is to notify the new grantees.

Example:

{
  "grantingDate": "2018-01-01",
  "meritGranter": "Urheiluliitto",
  "meritGrantees": [
    1292,
    39933,
    293333
  ]
}

HTTP status code 200

The merits were granted or the grant date for the already-granted merits was updated for the users.

Secured by oauth_2_0

Sport Data

API for retrieving Sport data.

/sport/{sportsFederationId} get

API for retrieving Sports for a Sports Federation.

get

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Sports for the Sports Federation

Body

Media type: application/json

Type: object

Properties

content: required(array of sport.Sport)
The list of Sport entries on the page
Items: Sport
- id: required(integer)
  The Suomisport id of the entity
- modificationTime: required(datetime)
  Last modification time of the entity
- federationId: required(integer)
  The Sports Federation id of the entity
- name: required(string)
  The entity name
- description: (string)
  The long description of the entity
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

Insurance Data

API for retrieving Insurance data.

/insurance/{sportsFederationId} get

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Insurances for the Sports Federation

Body

Media type: application/json

Type: object

Properties

content: required(array of insurance.Insurance)
The list of Insurance entries on the page
Items: Insurance
- id: required(integer)
  The Suomisport id of the Insurance
- modificationTime: required(datetime)
  Last modification time of the Insurance
- federationId: required(integer)
  The Sports Federation id of the Insurance
- licencePeriodId: required(integer)
  The Licence Period id of the Insurance
- name: required(string)
  The Insurance name
- description: (string)
  The Insurance description
- priceInCents: required(integer - minimum: 0)
  The price of the Insurance in cents
- earliestBirthDate: (date-only)
  The earliest birth date the Licence is valid for
- latestBirthDate: (date-only)
  The latest birth date the Licence is valid for
- gender: (one of Male, Female, Both)
  Gender the insurance is suitable for
- insuranceCompany: required(string)
  Insurance company name
- insuranceNumber: (string)
  The insurance number
- insuranceSubCode: (string)
  Sub code for the insurance identifying an insurance within a family of insurances
- transferInsuranceAutomatically: required(boolean)
  Setting for automatic insurance transfer to the insurance company
- termsLink: (string)
  Link to the terms of the insurance
- infoLink: (string)
  Link to the information page about the insurance
- costCenter: (string)
  Cost center for the licence
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id is invalid

Secured by oauth_2_0

/insurance/{sportsFederationId}/{licencePeriodId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Insurances for the Sports Federation.

Body

Media type: application/json

Type: object

Properties

content: required(array of insurance.Insurance)
The list of Insurance entries on the page
Items: Insurance
- id: required(integer)
  The Suomisport id of the Insurance
- modificationTime: required(datetime)
  Last modification time of the Insurance
- federationId: required(integer)
  The Sports Federation id of the Insurance
- licencePeriodId: required(integer)
  The Licence Period id of the Insurance
- name: required(string)
  The Insurance name
- description: (string)
  The Insurance description
- priceInCents: required(integer - minimum: 0)
  The price of the Insurance in cents
- earliestBirthDate: (date-only)
  The earliest birth date the Licence is valid for
- latestBirthDate: (date-only)
  The latest birth date the Licence is valid for
- gender: (one of Male, Female, Both)
  Gender the insurance is suitable for
- insuranceCompany: required(string)
  Insurance company name
- insuranceNumber: (string)
  The insurance number
- insuranceSubCode: (string)
  Sub code for the insurance identifying an insurance within a family of insurances
- transferInsuranceAutomatically: required(boolean)
  Setting for automatic insurance transfer to the insurance company
- termsLink: (string)
  Link to the terms of the insurance
- infoLink: (string)
  Link to the information page about the insurance
- costCenter: (string)
  Cost center for the licence
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id or the Licence Period id is invalid

Secured by oauth_2_0

Event Data

API for retrieving event data.

/event/search get

API to search event data according to different criteria.

get

Retrieve event data by performing a free-text-search.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Query Parameters

searchTerm: required(string)
The string to search for in the event data.
page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```

HTTP status code 200

The events containing the specified search string.

Body

Media type: application/json

Type: object

Properties

content: required(array of event.EventSearchResult)
The list of event search results on the page.
Items: EventSearchResult
- eventId: required(integer)
  The Suomisport id of the event
- name: required(string)
  The event name
- sports: required(array of event.SportDisciplineName)
  The list of sport disciplines exercised at the event
- organizerId: required(integer)
  The Suomisport id of the organizer
- organizerName: required(string)
  The name of the organization organizing the event
- startDateTime: required(datetime-only)
  The date and time at which the event starts. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
- endDateTime: required(datetime-only)
  The date and time at which the event ends. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
- currentAttendeeCount: required(integer)
  The number of currently enrolled attendees
- maxAttendeeCount: required(integer)
  The maximum number of attendees
- locationAddress: required(string)
  The street address where the event is held
- locationDescription: required(string)
  Detailed description of the place where the event is held
- locationCoordinates: required(object)
  Coordinates of the place where the event is held
  - lat: required(number)
    Latitude coordinate
  - lon: required(number)
    Longitude coordinate
- uuid: required(string)
  Unique identifier of the event
- priceInCents: required(integer)
  Participation fee of the event in cents
- parentSeriesEventId: required(integer)
  The Suomisport id of this event's parent series event
- parentSeriesEventUuid: required(string)
  The uuid of this event's parent series event
- parentSeriesEventName: required(string)
  The name of this event's parent series event
- eventCategory: (string - minLength: 1 - maxLength: 255)
  Category of the event. Can be used to include only events of a certain category such as 'Training' or 'REFEREE_TRAINING'. The event category is not visible to the end-users, it is targeted primarily for API usage.
- eventInstructors: (array of user.UserProfile - minItems: 1 - maxItems: 255)
  Instructors of the event. The instructor information contains only Suomisport id, sport-ID, name, email, phone number, language code and profile modification timestamp for the profile.
  The instructors are returned for the event only if specifically requested by setting the includeInstructors -parameter to true on the request.
  Items: UserProfile
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    streetAddress: required(string)
    postCode: required(string)
    postOffice: required(string)
    state: (string)
    countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

/event/search/{federationId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

federationId: required(integer)
The ID of the federation under which the event is organized

Query Parameters

topLeftLat: required(number)
The latitude of the top-left corner of the coordinate bounding box.
topLeftLon: required(number)
The longitude of the top-left corner of the coordinate bounding box.
bottomRightLat: required(number)
The latitude of the bottom-right corner of the coordinate bounding box.
bottomRightLon: required(number)
The longitude of the bottom-right corner of the coordinate bounding box.
dateTimeRangeStart: required(datetime-only)
The start time and date of the search date range. The time is interpreted as a local time in the timezone of the events to be searched.
dateTimeRangeEnd: required(datetime-only)
The end time and date of the search date range. The time is interpreted as a local time in the timezone of the events to be searched.
page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```

HTTP status code 200

The events fulfilling the given criteria

Body

Media type: application/json

Type: object

Properties

content: required(array of event.EventSearchResult)
The list of event search results on the page.
Items: EventSearchResult
- eventId: required(integer)
  The Suomisport id of the event
- name: required(string)
  The event name
- sports: required(array of event.SportDisciplineName)
  The list of sport disciplines exercised at the event
- organizerId: required(integer)
  The Suomisport id of the organizer
- organizerName: required(string)
  The name of the organization organizing the event
- startDateTime: required(datetime-only)
  The date and time at which the event starts. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
- endDateTime: required(datetime-only)
  The date and time at which the event ends. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
- currentAttendeeCount: required(integer)
  The number of currently enrolled attendees
- maxAttendeeCount: required(integer)
  The maximum number of attendees
- locationAddress: required(string)
  The street address where the event is held
- locationDescription: required(string)
  Detailed description of the place where the event is held
- locationCoordinates: required(object)
  Coordinates of the place where the event is held
  - lat: required(number)
    Latitude coordinate
  - lon: required(number)
    Longitude coordinate
- uuid: required(string)
  Unique identifier of the event
- priceInCents: required(integer)
  Participation fee of the event in cents
- parentSeriesEventId: required(integer)
  The Suomisport id of this event's parent series event
- parentSeriesEventUuid: required(string)
  The uuid of this event's parent series event
- parentSeriesEventName: required(string)
  The name of this event's parent series event
- eventCategory: (string - minLength: 1 - maxLength: 255)
  Category of the event. Can be used to include only events of a certain category such as 'Training' or 'REFEREE_TRAINING'. The event category is not visible to the end-users, it is targeted primarily for API usage.
- eventInstructors: (array of user.UserProfile - minItems: 1 - maxItems: 255)
  Instructors of the event. The instructor information contains only Suomisport id, sport-ID, name, email, phone number, language code and profile modification timestamp for the profile.
  The instructors are returned for the event only if specifically requested by setting the includeInstructors -parameter to true on the request.
  Items: UserProfile
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    streetAddress: required(string)
    postCode: required(string)
    postOffice: required(string)
    state: (string)
    countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

/event/uuid/{eventUuid} get

Find the event whose UUID is the specified one.

get

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

eventUuid: required(string)
The UUID of the event to be found.

HTTP status code 200

The event with the specified UUID.

Body

Media type: application/json

Type: object

Properties

eventId: required(integer)
The Suomisport id of the event
name: required(string)
The event name
sports: required(array of event.SportDisciplineName)
The list of sport disciplines exercised at the event
organizerId: required(integer)
The Suomisport id of the organizer
organizerName: required(string)
The name of the organization organizing the event
startDateTime: required(datetime-only)
The date and time at which the event starts. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
endDateTime: required(datetime-only)
The date and time at which the event ends. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
currentAttendeeCount: required(integer)
The number of currently enrolled attendees
maxAttendeeCount: required(integer)
The maximum number of attendees
locationAddress: required(string)
The street address where the event is held
locationDescription: required(string)
Detailed description of the place where the event is held
locationCoordinates: required(object)
Coordinates of the place where the event is held
- lat: required(number)
  Latitude coordinate
- lon: required(number)
  Longitude coordinate
uuid: required(string)
Unique identifier of the event
priceInCents: required(integer)
Participation fee of the event in cents
parentSeriesEventId: required(integer)
The Suomisport id of this event's parent series event
parentSeriesEventUuid: required(string)
The uuid of this event's parent series event
parentSeriesEventName: required(string)
The name of this event's parent series event
eventCategory: (string - minLength: 1 - maxLength: 255)
Category of the event. Can be used to include only events of a certain category such as 'Training' or 'REFEREE_TRAINING'. The event category is not visible to the end-users, it is targeted primarily for API usage.
eventInstructors: (array of user.UserProfile - minItems: 1 - maxItems: 255)
Instructors of the event. The instructor information contains only Suomisport id, sport-ID, name, email, phone number, language code and profile modification timestamp for the profile.
The instructors are returned for the event only if specifically requested by setting the includeInstructors -parameter to true on the request.
Items: UserProfile
- id: required(integer)
  The Suomisport id of the User
- sportId: required(integer - minimum: 10000000 - maximum: 999999999)
  Sport-ID for the user
- firstName: (string)
  The official first names of the user
- nickname: (string)
  User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
- lastName: (string)
  Last names
- email: (string)
  The user email address
- phone: (string)
  The user phone number
- address: (object)
  The user postal address
  - streetAddress: required(string)
  - postCode: required(string)
  - postOffice: required(string)
  - state: (string)
  - countryCode: (string)
- modificationTime: required(datetime)
  Last modification time of the User data
- birthDate: (date-only)
  Date of birth
- username: (string)
  User-selected unique nickname of the user, e.g. @happyuser
- city: (string)
  User home city
- gender: (one of Male, Female, Both)
  Gender of the user
- socialSecurityNumber: (string)
  User's social security number
- hasSocialSecurityNumber: (boolean)
  True if user has a Finnish Social Security Number, false if s/he does not have
- nationality: (string - maxLength: 2)
  Country code of the user's nationality
- marketingPermission: (boolean)
  True if the user has allowed 3rd party marketing messages, false otherwise.
- deceasedDate: (date-only)
  The deceased date
- languageCode: (one of FI, SV, EN - default: FI)
  (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
- locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
  Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
- guardians: (array of user.GuardianInformation)
  Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
  Items: GuardianInformation
  - firstName: required(string)
    Guardian first name or nickname
  - lastName: required(string)
    Guardian last name
  - email: (string)
    Guardian email address
  - phone: (string)
    Guardian phone number
- dependants: (array of user.DependantInformation)
  Information about user's dependants, i.e. children or other dependant persons.
  Items: DependantInformation
  - id: required(integer)
    The Suomisport id of the dependant User
  - firstName: required(string)
    Dependant first name
  - lastName: required(string)
    Dependant last name
- sportParameters: (array of user.user_sport_parameter.UserSportParameter)
  The user's sport parameter values for requested sport parameters
  Items: UserSportParameter
  - id: required(integer)
    The Suomisport id of the sport parameter value
  - modificationTime: required(datetime)
    Last modification time of the sport parameter value
  - sportId: required(integer)
    The id of the Sport the parameter is associated with
  - sportName: required(string)
    The name of the Sport the parameter is associated with
  - sportParameterId: required(integer)
    The id of the Sport Parameter entity
  - name: required(string - minLength: 1)
    The name of the parameter
  - value: required(string)
    The parameter value

HTTP status code 404

No event was found with the specified UUID.

Secured by oauth_2_0

/event/list post

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```

Body

Media type: application/json

Type: object

Properties

searchText: (string)
Free-text seach terms applied over the event name and description.
federationId: (integer)
Sports Federation id. Only events of organizations in hierarchy are considered candidate match. Mandatory value for non-public event visibility in which case the value must match the API client authorization permissions.
organizerId: (integer)
Event organizer organization id
locationCoordinates: (object)
Bounding box location coordinates for the event
- topLeftLat: required(number)
- topLeftLon: required(number)
- bottomRightLat: required(number)
- bottomRightLon: required(number)
dateRange: (object)
Time range for the event search. The event is considered a candidate match if the event time overlaps the defined range. If either start or end is left out, only events that occur before or after (respectively) the set value are considered as the candidate match.
- start: (datetime)
  The start of the time range used in event search.
- end: (datetime)
  The end of the time range used in event search.
eventVisibility: (one of PUBLIC, PRIVATE, ANY - default: PUBLIC)
Visibility of the event.
- PUBLIC lists only events that are publicly available.
- PRIVATE lists only private events that are not publicly visible.
- ANY lists all events
tags: (array of event_search_terms.TagString - minItems: 1 - maxItems: 10)
Event tags. At least one tag must match the event. An event has zero or more tags. A tag is a simple string.
Example:
```
[
  "Erotuomari",
  "Koulutus"
]
```
eventCategory: (string - minLength: 1 - maxLength: 255)
Category of the event. Can be used to include only events of a certain category such as 'Training' or 'REFEREE_TRAINING'. The event category is not visible to the end-users, it is targeted primarily for API usage.
includeInstructors: required(boolean - default: false)
Setting to include event instructors in the result. Only applicable when either organizerId or federationId is set. The result batch size must be < 1000 items for performance reasons.
The response will include a subset of instructors' profile data: Suomisport id, sport-ID, name, email, phone number, language code and profile modification timestamp.

HTTP status code 200

The events of the organization.

Body

Media type: application/json

Type: object

Properties

content: required(array of event.EventSearchResult)
The list of event search results on the page.
Items: EventSearchResult
- eventId: required(integer)
  The Suomisport id of the event
- name: required(string)
  The event name
- sports: required(array of event.SportDisciplineName)
  The list of sport disciplines exercised at the event
- organizerId: required(integer)
  The Suomisport id of the organizer
- organizerName: required(string)
  The name of the organization organizing the event
- startDateTime: required(datetime-only)
  The date and time at which the event starts. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
- endDateTime: required(datetime-only)
  The date and time at which the event ends. The time is stated as a local time in the timezone of the event's location, regardless of the timezone reported in this data field.
- currentAttendeeCount: required(integer)
  The number of currently enrolled attendees
- maxAttendeeCount: required(integer)
  The maximum number of attendees
- locationAddress: required(string)
  The street address where the event is held
- locationDescription: required(string)
  Detailed description of the place where the event is held
- locationCoordinates: required(object)
  Coordinates of the place where the event is held
  - lat: required(number)
    Latitude coordinate
  - lon: required(number)
    Longitude coordinate
- uuid: required(string)
  Unique identifier of the event
- priceInCents: required(integer)
  Participation fee of the event in cents
- parentSeriesEventId: required(integer)
  The Suomisport id of this event's parent series event
- parentSeriesEventUuid: required(string)
  The uuid of this event's parent series event
- parentSeriesEventName: required(string)
  The name of this event's parent series event
- eventCategory: (string - minLength: 1 - maxLength: 255)
  Category of the event. Can be used to include only events of a certain category such as 'Training' or 'REFEREE_TRAINING'. The event category is not visible to the end-users, it is targeted primarily for API usage.
- eventInstructors: (array of user.UserProfile - minItems: 1 - maxItems: 255)
  Instructors of the event. The instructor information contains only Suomisport id, sport-ID, name, email, phone number, language code and profile modification timestamp for the profile.
  The instructors are returned for the event only if specifically requested by setting the includeInstructors -parameter to true on the request.
  Items: UserProfile
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    streetAddress: required(string)
    postCode: required(string)
    postOffice: required(string)
    state: (string)
    countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

/event/activityprogram post

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Body

Media type: application/json

Type: object

Properties

id: required(integer)
The Suomisport id of the event
name: required(string)
Name of the activity program.
description: required(string)
A more verbose description of the program.
organizerId: required(integer)
The Suomisport id of the organization responsible for the event.
activityProgramDefinition: required(object)
Event properties specific to activity programs.
- activityProgramType: required(one of SCHOOL_ACTIVITY, CLUB_ACTIVITY, OTHER)
- activityProgramFunding: required(one of LASTEN_LIIKE, OPH_KERHOTUKI, LIIKKUVA_KOULU, TAIDE_JA_KULTTUURI, NUORISOTOIMI, SEURATUKI, VANHEMPAINYHDISTYS, YKSITYINEN, MUU)
- municipality: required(string)
  Municipality of the location
- minSchoolGrade: required(one of PRE_SCHOOL, GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, GRADE_7, GRADE_8, GRADE_9, GRADE_10)
  Minimum elementary school grade for participants.
- maxSchoolGrade: required(one of PRE_SCHOOL, GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, GRADE_7, GRADE_8, GRADE_9, GRADE_10)
  Maximum elementary school grade for participants.
contactPerson: required(object)
information about contact person.
- name: required(string)
  Full name of person.
- email: required(string)
  Email address of person.
- phoneNumber: required(string)
  Phone number of person.
location: required(object)
information about the location of the program.
- name: (string)
  Name of the location, e.g. name of school
- address: required(string)
  Address of location
- description: (string)
  Free description of location
- coordinates: required(object)
  Latitude and longitude of location
  - lat: required(number)
    Latitude coordinate
  - lon: required(number)
    Longitude coordinate
registrationSettings: required(object)
Information about registration settings.
- registrationStart: required(datetime)
  Start of regitration period.
- registrationEnd: required(datetime)
  End of registration period.

HTTP status code 201

Activity program was cread successfully

Body

Media type: application/json

Type: object

Properties

id: required(integer)
The Suomisport id of the event
name: required(string)
Name of the activity program.
description: required(string)
A more verbose description of the program.
organizerId: required(integer)
The Suomisport id of the organization responsible for the event.
activityProgramDefinition: required(object)
Event properties specific to activity programs.
- activityProgramType: required(one of SCHOOL_ACTIVITY, CLUB_ACTIVITY, OTHER)
- activityProgramFunding: required(one of LASTEN_LIIKE, OPH_KERHOTUKI, LIIKKUVA_KOULU, TAIDE_JA_KULTTUURI, NUORISOTOIMI, SEURATUKI, VANHEMPAINYHDISTYS, YKSITYINEN, MUU)
- municipality: required(string)
  Municipality of the location
- minSchoolGrade: required(one of PRE_SCHOOL, GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, GRADE_7, GRADE_8, GRADE_9, GRADE_10)
  Minimum elementary school grade for participants.
- maxSchoolGrade: required(one of PRE_SCHOOL, GRADE_1, GRADE_2, GRADE_3, GRADE_4, GRADE_5, GRADE_6, GRADE_7, GRADE_8, GRADE_9, GRADE_10)
  Maximum elementary school grade for participants.
contactPerson: required(object)
information about contact person.
- name: required(string)
  Full name of person.
- email: required(string)
  Email address of person.
- phoneNumber: required(string)
  Phone number of person.
location: required(object)
information about the location of the program.
- name: (string)
  Name of the location, e.g. name of school
- address: required(string)
  Address of location
- description: (string)
  Free description of location
- coordinates: required(object)
  Latitude and longitude of location
  - lat: required(number)
    Latitude coordinate
  - lon: required(number)
    Longitude coordinate
registrationSettings: required(object)
Information about registration settings.
- registrationStart: required(datetime)
  Start of regitration period.
- registrationEnd: required(datetime)
  End of registration period.

Secured by oauth_2_0

Sport Parameter Data

API for retrieving Sport Parameter data.

/sport-parameter/{sportsFederationId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Sport Parameters for the Sports Federation

Body

Media type: application/json

Type: object

Properties

content: required(array of sport_parameter.SportParameter)
The list of SportParameter entries on the page
Items: SportParameter
- id: required(integer)
  The Suomisport id of the sport parameter
- modificationTime: required(datetime)
  Last modification time of the sport parameter
- sportId: required(integer)
  The id of the Sport entity
- sportName: required(string)
  The name of the Sport entity
- name: required(string)
  The name of the parameter
- type: required(one of ShotText, LongText)
  The type of the parameter value
- maxLength: required(integer - minimum: 0)
  Maximum length of the value
- athleteCanModify: required(boolean)
  Sets whether the athlete can modify the value of the parameter
- apiCanModify: required(boolean)
  Sets whether an API client can modify the value of the parameter
pageable: required(object)
Pageable listing page details
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

User Insurance Data

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

/user-insurance/{sportsFederationId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Licences for the Sports Federation

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserInsurance)
The list of User Insurance entries on the page.
Items: UserInsurance
- id: required(integer)
  The Suomisport id of the User Insurance.
- modificationTime: required(datetime)
  Last modification time of the User Insurance.
- federationId: required(integer)
  The Sports Federation id of the User Insurance.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Insurance.
- licencePeriodName: required(string)
  The Licence Period name.
- insuranceId: required(integer)
  The id of the Insurance.
- name: required(string)
  The Insurance name.
- user: required(object)
  The user details for the User Insurance.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Insurance usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Insurance usage period.
- salesPriceInCents: required(integer)
  User Insurance sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the User Insurance, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Insurance this User Insurance upgrades and replaces.
- insuranceTransferTime: (datetime-only)
  Time when the insurance was transferred to the insurance company's system.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id is invalid

Secured by oauth_2_0

/user-insurance/{sportsFederationId}/{licencePeriodId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The User Insurances for the Sports Federation.

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserInsurance)
The list of User Insurance entries on the page.
Items: UserInsurance
- id: required(integer)
  The Suomisport id of the User Insurance.
- modificationTime: required(datetime)
  Last modification time of the User Insurance.
- federationId: required(integer)
  The Sports Federation id of the User Insurance.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Insurance.
- licencePeriodName: required(string)
  The Licence Period name.
- insuranceId: required(integer)
  The id of the Insurance.
- name: required(string)
  The Insurance name.
- user: required(object)
  The user details for the User Insurance.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Insurance usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Insurance usage period.
- salesPriceInCents: required(integer)
  User Insurance sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the User Insurance, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Insurance this User Insurance upgrades and replaces.
- insuranceTransferTime: (datetime-only)
  Time when the insurance was transferred to the insurance company's system.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id or the licence period id is invalid

Secured by oauth_2_0

/user-insurance/{sportsFederationId}/{licencePeriodId}/user/{userId} get

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id
userId: required(integer)
The user Id

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The User Insurances for the Sports Federation. Returns an empty response if licencePeriodId or userId is invalid

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserInsurance)
The list of User Insurance entries on the page.
Items: UserInsurance
- id: required(integer)
  The Suomisport id of the User Insurance.
- modificationTime: required(datetime)
  Last modification time of the User Insurance.
- federationId: required(integer)
  The Sports Federation id of the User Insurance.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Insurance.
- licencePeriodName: required(string)
  The Licence Period name.
- insuranceId: required(integer)
  The id of the Insurance.
- name: required(string)
  The Insurance name.
- user: required(object)
  The user details for the User Insurance.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Insurance usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Insurance usage period.
- salesPriceInCents: required(integer)
  User Insurance sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the User Insurance, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Insurance this User Insurance upgrades and replaces.
- insuranceTransferTime: (datetime-only)
  Time when the insurance was transferred to the insurance company's system.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 403

The sports federation id is invalid or user has no rights to requested sports federation

Secured by oauth_2_0

Event Registrations

Event Registered Users

Manage registered users for events.

/event/registered-event-users/{eventId} get

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.

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

eventId: required(number)
The id of the event.

Query Parameters

page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

List of registered users.

Body

Media type: application/json

Type: object

Properties

content: required(array of event_user.RegisteredEventUser)
The list of User event registration entries on the page.
Items: RegisteredEventUser
- id: required(integer)
  The Suomisport id of the User event registration.
- modificationTime: required(datetime)
  Last modification time of the User event registration. The modification time is updated every time the registration is changed (registration is created or payment status is modified).
- eventId: required(integer)
  The Suomisport id of the event.
- user: required(object)
  The user details for the event registration. For the event registration, only the basic user contact information is returned. The details include user id, sport-id, full name, nickname, email address, phone number, address and guardian contact information.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- registrationInfo: (string - minLength: 1 - maxLength: 1024)
  Registrant-provided information on the registration. For example registrant's allergies or preferences.
- paymentStatus: required(one of FREE, PAID, WAITING_PAYMENT_CONFIRMATION)
  Status of the payment for the event. Statuses:
  - FREE: the user is registered to the free event
  - PAID: the user has registered to the event and paid the event fee
  - WAITING_PAYMENT_CONFIRMATION: the user may have registered to the event but the payment information has not yet arrived from the payment service. The payment status will be determined in 7 days after the payment attempt at the latest.
  The payment status WAITING_PAYMENT_CONFIRMATION occurs if the user does not return to the payment service or Suomisport from the bank or credit card company payment page. The status is resolved to PAID as soon as the payment is confirmed, typically in two banking days. If the payment is not resolved in 7 days, the payment is automatically marked as not paid and the registration does not appear in this listing anymore. It is most likely that the event registration with this status is not paid.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

Secured by oauth_2_0

Club Transfers of the User Licences

API for managing the club transfers of the User Licences

ClientData

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

User Info

API for retrieving basic info of a user

Account Data

API for accessing account data.

/account/active/profile get put

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.

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Query Parameters

includeDependants: required(boolean)
Determines whether dependant information is included in response.

HTTP status code 200

The currently active account.

Body

Media type: application/json

Type: object

Properties

id: required(integer)
The Suomisport id of the User
sportId: required(integer - minimum: 10000000 - maximum: 999999999)
Sport-ID for the user
firstName: (string)
The official first names of the user
nickname: (string)
User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
lastName: (string)
Last names
email: (string)
The user email address
phone: (string)
The user phone number
address: (object)
The user postal address
- streetAddress: required(string)
- postCode: required(string)
- postOffice: required(string)
- state: (string)
- countryCode: (string)
modificationTime: required(datetime)
Last modification time of the User data
birthDate: (date-only)
Date of birth
username: (string)
User-selected unique nickname of the user, e.g. @happyuser
city: (string)
User home city
gender: (one of Male, Female, Both)
Gender of the user
socialSecurityNumber: (string)
User's social security number
hasSocialSecurityNumber: (boolean)
True if user has a Finnish Social Security Number, false if s/he does not have
nationality: (string - maxLength: 2)
Country code of the user's nationality
marketingPermission: (boolean)
True if the user has allowed 3rd party marketing messages, false otherwise.
deceasedDate: (date-only)
The deceased date
languageCode: (one of FI, SV, EN - default: FI)
(Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
guardians: (array of user.GuardianInformation)
Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
Items: GuardianInformation
- firstName: required(string)
  Guardian first name or nickname
- lastName: required(string)
  Guardian last name
- email: (string)
  Guardian email address
- phone: (string)
  Guardian phone number
dependants: (array of user.DependantInformation)
Information about user's dependants, i.e. children or other dependant persons.
Items: DependantInformation
- id: required(integer)
  The Suomisport id of the dependant User
- firstName: required(string)
  Dependant first name
- lastName: required(string)
  Dependant last name
sportParameters: (array of user.user_sport_parameter.UserSportParameter)
The user's sport parameter values for requested sport parameters
Items: UserSportParameter
- id: required(integer)
  The Suomisport id of the sport parameter value
- modificationTime: required(datetime)
  Last modification time of the sport parameter value
- sportId: required(integer)
  The id of the Sport the parameter is associated with
- sportName: required(string)
  The name of the Sport the parameter is associated with
- sportParameterId: required(integer)
  The id of the Sport Parameter entity
- name: required(string - minLength: 1)
  The name of the parameter
- value: required(string)
  The parameter value

Secured by oauth_2_0

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Query Parameters

includeDependants: required(boolean)
Determines whether dependant information is included in response. This does not affect the profile update itself.

Body

Media type: application/json

Type: object

Properties

locale: (one of fi_FI, sv_SE, en_GB)
Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).

HTTP status code 200

The currently active account's profile data.

Body

Media type: application/json

Type: object

Properties

id: required(integer)
The Suomisport id of the User
sportId: required(integer - minimum: 10000000 - maximum: 999999999)
Sport-ID for the user
firstName: (string)
The official first names of the user
nickname: (string)
User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
lastName: (string)
Last names
email: (string)
The user email address
phone: (string)
The user phone number
address: (object)
The user postal address
- streetAddress: required(string)
- postCode: required(string)
- postOffice: required(string)
- state: (string)
- countryCode: (string)
modificationTime: required(datetime)
Last modification time of the User data
birthDate: (date-only)
Date of birth
username: (string)
User-selected unique nickname of the user, e.g. @happyuser
city: (string)
User home city
gender: (one of Male, Female, Both)
Gender of the user
socialSecurityNumber: (string)
User's social security number
hasSocialSecurityNumber: (boolean)
True if user has a Finnish Social Security Number, false if s/he does not have
nationality: (string - maxLength: 2)
Country code of the user's nationality
marketingPermission: (boolean)
True if the user has allowed 3rd party marketing messages, false otherwise.
deceasedDate: (date-only)
The deceased date
languageCode: (one of FI, SV, EN - default: FI)
(Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
guardians: (array of user.GuardianInformation)
Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
Items: GuardianInformation
- firstName: required(string)
  Guardian first name or nickname
- lastName: required(string)
  Guardian last name
- email: (string)
  Guardian email address
- phone: (string)
  Guardian phone number
dependants: (array of user.DependantInformation)
Information about user's dependants, i.e. children or other dependant persons.
Items: DependantInformation
- id: required(integer)
  The Suomisport id of the dependant User
- firstName: required(string)
  Dependant first name
- lastName: required(string)
  Dependant last name
sportParameters: (array of user.user_sport_parameter.UserSportParameter)
The user's sport parameter values for requested sport parameters
Items: UserSportParameter
- id: required(integer)
  The Suomisport id of the sport parameter value
- modificationTime: required(datetime)
  Last modification time of the sport parameter value
- sportId: required(integer)
  The id of the Sport the parameter is associated with
- sportName: required(string)
  The name of the Sport the parameter is associated with
- sportParameterId: required(integer)
  The id of the Sport Parameter entity
- name: required(string - minLength: 1)
  The name of the parameter
- value: required(string)
  The parameter value

Secured by oauth_2_0

/account/{userId}/profile get

get

Retrieves the account data of the specified user.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

userId: required(integer)
The ID of the user whose account is being fetched.

Query Parameters

includeDependants: required(boolean)
Determines whether dependant information is included in response.

HTTP status code 200

The account data of the specified user.

Body

Media type: application/json

Type: object

Properties

id: required(integer)
The Suomisport id of the User
sportId: required(integer - minimum: 10000000 - maximum: 999999999)
Sport-ID for the user
firstName: (string)
The official first names of the user
nickname: (string)
User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
lastName: (string)
Last names
email: (string)
The user email address
phone: (string)
The user phone number
address: (object)
The user postal address
- streetAddress: required(string)
- postCode: required(string)
- postOffice: required(string)
- state: (string)
- countryCode: (string)
modificationTime: required(datetime)
Last modification time of the User data
birthDate: (date-only)
Date of birth
username: (string)
User-selected unique nickname of the user, e.g. @happyuser
city: (string)
User home city
gender: (one of Male, Female, Both)
Gender of the user
socialSecurityNumber: (string)
User's social security number
hasSocialSecurityNumber: (boolean)
True if user has a Finnish Social Security Number, false if s/he does not have
nationality: (string - maxLength: 2)
Country code of the user's nationality
marketingPermission: (boolean)
True if the user has allowed 3rd party marketing messages, false otherwise.
deceasedDate: (date-only)
The deceased date
languageCode: (one of FI, SV, EN - default: FI)
(Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
guardians: (array of user.GuardianInformation)
Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
Items: GuardianInformation
- firstName: required(string)
  Guardian first name or nickname
- lastName: required(string)
  Guardian last name
- email: (string)
  Guardian email address
- phone: (string)
  Guardian phone number
dependants: (array of user.DependantInformation)
Information about user's dependants, i.e. children or other dependant persons.
Items: DependantInformation
- id: required(integer)
  The Suomisport id of the dependant User
- firstName: required(string)
  Dependant first name
- lastName: required(string)
  Dependant last name
sportParameters: (array of user.user_sport_parameter.UserSportParameter)
The user's sport parameter values for requested sport parameters
Items: UserSportParameter
- id: required(integer)
  The Suomisport id of the sport parameter value
- modificationTime: required(datetime)
  Last modification time of the sport parameter value
- sportId: required(integer)
  The id of the Sport the parameter is associated with
- sportName: required(string)
  The name of the Sport the parameter is associated with
- sportParameterId: required(integer)
  The id of the Sport Parameter entity
- name: required(string - minLength: 1)
  The name of the parameter
- value: required(string)
  The parameter value

Secured by oauth_2_0

Manage product orders.

/order post

post

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

Body

Media type: application/json

Type: object

Properties

orderId: (integer)
Unique id of the new order. This field is filled in during the order API call.
status: (one of CANCELLED, COMPLETED, ERROR, IN_PROGRESS, WAITING_PAYMENT_CONFIRMATION)
State of the newly created order. This field is filled in during the order API call.
userId: required(integer)
ID of the user who is placing the order. In case the organizationId field is not set, the user is the instance to be billed.
organizationId: (integer)
If set, this depicts the ID of the organization on whose behalf the order is placed. I.e. in this case the organization is billed.
source: required(EVENT_REGISTRATION)
The source from which the order was placed.
purchases: required(array of order.Purchase)
The purchases to be made in this order.
Items: Purchase
- beneficiaryUserId: (integer)
  User ID of the user to receive the purchased products. Alternatively, a beneficiaryOrganizationId can be specified, if the purchased products are to be received by an organization.
- beneficiaryOrganizationId: (integer)
  Organization ID of the organization to receive the purchased products. Alternatively, a beneficiaryUserId can be specified, if the purchased products are to be received by a single user.
- products: required(array of order.Product)
  The products to be purchased.
  Items: Product
  - productType: required(EVENT_REGISTRATION)
    The type of product to be purchased.
  - productId: required(integer)
    The ID of the product to be purchased.
  - productStatusRowId: (integer)
    The ID of a product-type-specific status row ID. This is a field reserved for future use and is ignored when purchasing event registrations.

HTTP status code 200

The order was created successfully

Body

Media type: application/json

Type: object

Properties

orderId: (integer)
Unique id of the new order. This field is filled in during the order API call.
status: (one of CANCELLED, COMPLETED, ERROR, IN_PROGRESS, WAITING_PAYMENT_CONFIRMATION)
State of the newly created order. This field is filled in during the order API call.
userId: required(integer)
ID of the user who is placing the order. In case the organizationId field is not set, the user is the instance to be billed.
organizationId: (integer)
If set, this depicts the ID of the organization on whose behalf the order is placed. I.e. in this case the organization is billed.
source: required(EVENT_REGISTRATION)
The source from which the order was placed.
purchases: required(array of order.Purchase)
The purchases to be made in this order.
Items: Purchase
- beneficiaryUserId: (integer)
  User ID of the user to receive the purchased products. Alternatively, a beneficiaryOrganizationId can be specified, if the purchased products are to be received by an organization.
- beneficiaryOrganizationId: (integer)
  Organization ID of the organization to receive the purchased products. Alternatively, a beneficiaryUserId can be specified, if the purchased products are to be received by a single user.
- products: required(array of order.Product)
  The products to be purchased.
  Items: Product
  - productType: required(EVENT_REGISTRATION)
    The type of product to be purchased.
  - productId: required(integer)
    The ID of the product to be purchased.
  - productStatusRowId: (integer)
    The ID of a product-type-specific status row ID. This is a field reserved for future use and is ignored when purchasing event registrations.

Secured by oauth_2_0

Manage multiple product orders at once.

User Licence Data

API for retrieving data of User Licences bought to users.

/user-licence/{sportsFederationId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id

Query Parameters

includeSportParams: required(string - default: false - pattern: ^(true|false|\d+(,\d+)*)$)
Controls the sport parameters included in the response. Only the sport parameters that have a non-empty value for the user are eligible for inclusion. Options:
- false : No sports parameters are included
- true : All applicable sports parameters for the federation are included
- id1,id2,... : Include applicable sport parameters with the given ids only
page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The Licences for the Sports Federation

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserLicence)
The list of User Licence entries on the page.
Items: UserLicence
- id: required(integer)
  The Suomisport id of the User Licence.
- modificationTime: required(datetime)
  Last modification time of the User Licence.
- federationId: required(integer)
  The Sports Federation id of the User Licence.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Licence.
- licencePeriodName: required(string)
  The Licence Period name.
- licenceId: required(integer)
  The id of the Licence.
- name: required(string)
  The Licence name.
- user: required(object)
  The user details for the Licence.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Licence usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Licence usage period.
- salesPriceInCents: required(integer)
  The Licence sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the Licence, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Licence this User Licence upgrades and replaces.
- licenceOrganizationId: required(integer)
  The organization the User Licence is bound to, usually a club.
- licenceOrganizationSportId: required(integer - minimum: 10000000 - maximum: 999999999)
  Sport-ID of the organization the User Licence is bound to.
- licenceOrganizationName: required(string)
  The name of the organization the User Licence is bound to.
- licenceOrganizationOfficialName: required(string)
  The official name of the organization the User Licence is bound to.
- externalInsuranceCompany: (string)
  The name of the external insurance company for the Licence.
- externalInsuranceNumber: (string)
  The insurance number for the external insurance company for the Licence.
- licencePrimarySportId: (integer)
  The Id of the sport the User Licence is bound to.
- licencePrimarySportName: (string)
  The name of the sport the User Licence is bound to.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id is invalid

Secured by oauth_2_0

/user-licence/{sportsFederationId}/{licencePeriodId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id

Query Parameters

includeSportParams: required(string - default: false - pattern: ^(true|false|\d+(,\d+)*)$)
Controls the sport parameters included in the response. Only the sport parameters that have a non-empty value for the user are eligible for inclusion. Options:
- false : No sports parameters are included
- true : All applicable sports parameters for the federation are included
- id1,id2,... : Include applicable sport parameters with the given ids only
includeUpgradedLicences: required(boolean - default: true)
Whether upgraded licences should be included in the response. Note that this affects only the licences which were upgraded (i.e. pre-upgrade), not the licences with which they were upgraded.
page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The User Licences for the Sports Federation.

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserLicence)
The list of User Licence entries on the page.
Items: UserLicence
- id: required(integer)
  The Suomisport id of the User Licence.
- modificationTime: required(datetime)
  Last modification time of the User Licence.
- federationId: required(integer)
  The Sports Federation id of the User Licence.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Licence.
- licencePeriodName: required(string)
  The Licence Period name.
- licenceId: required(integer)
  The id of the Licence.
- name: required(string)
  The Licence name.
- user: required(object)
  The user details for the Licence.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Licence usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Licence usage period.
- salesPriceInCents: required(integer)
  The Licence sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the Licence, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Licence this User Licence upgrades and replaces.
- licenceOrganizationId: required(integer)
  The organization the User Licence is bound to, usually a club.
- licenceOrganizationSportId: required(integer - minimum: 10000000 - maximum: 999999999)
  Sport-ID of the organization the User Licence is bound to.
- licenceOrganizationName: required(string)
  The name of the organization the User Licence is bound to.
- licenceOrganizationOfficialName: required(string)
  The official name of the organization the User Licence is bound to.
- externalInsuranceCompany: (string)
  The name of the external insurance company for the Licence.
- externalInsuranceNumber: (string)
  The insurance number for the external insurance company for the Licence.
- licencePrimarySportId: (integer)
  The Id of the sport the User Licence is bound to.
- licencePrimarySportName: (string)
  The name of the sport the User Licence is bound to.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The Sports Federation id or the licence period id is invalid

Secured by oauth_2_0

/user-licence/{sportsFederationId}/{licencePeriodId}/{licenceId} get

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.

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id
licenceId: required(integer)
The licence id

Query Parameters

includeSportParams: required(string - default: false - pattern: ^(true|false|\d+(,\d+)*)$)
Controls the sport parameters included in the response. Only the sport parameters that have a non-empty value for the user are eligible for inclusion. Options:
- false : No sports parameters are included
- true : All applicable sports parameters for the federation are included
- id1,id2,... : Include applicable sport parameters with the given ids only
page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The user licences of the specified licence.

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserLicence)
The list of User Licence entries on the page.
Items: UserLicence
- id: required(integer)
  The Suomisport id of the User Licence.
- modificationTime: required(datetime)
  Last modification time of the User Licence.
- federationId: required(integer)
  The Sports Federation id of the User Licence.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Licence.
- licencePeriodName: required(string)
  The Licence Period name.
- licenceId: required(integer)
  The id of the Licence.
- name: required(string)
  The Licence name.
- user: required(object)
  The user details for the Licence.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Licence usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Licence usage period.
- salesPriceInCents: required(integer)
  The Licence sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the Licence, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Licence this User Licence upgrades and replaces.
- licenceOrganizationId: required(integer)
  The organization the User Licence is bound to, usually a club.
- licenceOrganizationSportId: required(integer - minimum: 10000000 - maximum: 999999999)
  Sport-ID of the organization the User Licence is bound to.
- licenceOrganizationName: required(string)
  The name of the organization the User Licence is bound to.
- licenceOrganizationOfficialName: required(string)
  The official name of the organization the User Licence is bound to.
- externalInsuranceCompany: (string)
  The name of the external insurance company for the Licence.
- externalInsuranceNumber: (string)
  The insurance number for the external insurance company for the Licence.
- licencePrimarySportId: (integer)
  The Id of the sport the User Licence is bound to.
- licencePrimarySportName: (string)
  The name of the sport the User Licence is bound to.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 400

The sports federation id, licence period id, or licence id is invalid

Secured by oauth_2_0

/user-licence/{sportsFederationId}/{licencePeriodId}/sport/{sportId} get

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id
sportId: required(integer)
The id of the sport

Query Parameters

includeSportParams: required(string - default: false - pattern: ^(true|false|\d+(,\d+)*)$)
Controls the sport parameters included in the response. Only the sport parameters that have a non-empty value for the user are eligible for inclusion. Options:
- false : No sports parameters are included
- true : All applicable sports parameters for the federation are included
- id1,id2,... : Include applicable sport parameters with the given ids only
page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The user licences of the specified sport. Returns an empty response if licencePeriodId or sportId is invalid

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserLicence)
The list of User Licence entries on the page.
Items: UserLicence
- id: required(integer)
  The Suomisport id of the User Licence.
- modificationTime: required(datetime)
  Last modification time of the User Licence.
- federationId: required(integer)
  The Sports Federation id of the User Licence.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Licence.
- licencePeriodName: required(string)
  The Licence Period name.
- licenceId: required(integer)
  The id of the Licence.
- name: required(string)
  The Licence name.
- user: required(object)
  The user details for the Licence.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Licence usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Licence usage period.
- salesPriceInCents: required(integer)
  The Licence sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the Licence, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Licence this User Licence upgrades and replaces.
- licenceOrganizationId: required(integer)
  The organization the User Licence is bound to, usually a club.
- licenceOrganizationSportId: required(integer - minimum: 10000000 - maximum: 999999999)
  Sport-ID of the organization the User Licence is bound to.
- licenceOrganizationName: required(string)
  The name of the organization the User Licence is bound to.
- licenceOrganizationOfficialName: required(string)
  The official name of the organization the User Licence is bound to.
- externalInsuranceCompany: (string)
  The name of the external insurance company for the Licence.
- externalInsuranceNumber: (string)
  The insurance number for the external insurance company for the Licence.
- licencePrimarySportId: (integer)
  The Id of the sport the User Licence is bound to.
- licencePrimarySportName: (string)
  The name of the sport the User Licence is bound to.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 403

The sports federation id is invalid or user has no rights to requested sports federation

Secured by oauth_2_0

/user-licence/{sportsFederationId}/{licencePeriodId}/user/{userId} get

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

Secured by oauth_2_0

Suomisport API is accessed using OAuth 2.0 tokens using Client Credentials.

URI Parameters

sportsFederationId: required(integer)
The Sports Federation id
licencePeriodId: required(integer)
The Licence Period id
userId: required(integer)
The id of the user

Query Parameters

includeSportParams: required(string - default: false - pattern: ^(true|false|\d+(,\d+)*)$)
Controls the sport parameters included in the response. Only the sport parameters that have a non-empty value for the user are eligible for inclusion. Options:
- false : No sports parameters are included
- true : All applicable sports parameters for the federation are included
- id1,id2,... : Include applicable sport parameters with the given ids only
page: (integer - default: 0 - minimum: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
```
20
```
size: (integer - default: 50 - minimum: 1 - maximum: 100000)
Limit the number of elements on the response
Example:
```
80
```
ts: (datetime)
Last modified since timestamp. The API returns elements modified after the ts timestamp. If the value is omitted, the timestamp is ignored and all of the elements are returned.
Example:
```
2017-05-28T12:21:42.090Z
```
tsOrder: (string - pattern: ^asc|desc$)
Order lists by last modified timestamp. The value determines the order, eithe ascending (asc) or descending (desc). If the value is set, it precedes all other orderings. If the value is not set, the API-specific default ordering will be used.

HTTP status code 200

The user licences of the specified user. Returns an empty response if licencePeriodId or userId is invalid

Body

Media type: application/json

Type: object

Properties

content: required(array of ulp.UserLicence)
The list of User Licence entries on the page.
Items: UserLicence
- id: required(integer)
  The Suomisport id of the User Licence.
- modificationTime: required(datetime)
  Last modification time of the User Licence.
- federationId: required(integer)
  The Sports Federation id of the User Licence.
- federationName: required(string)
  The Sports Federation name.
- licencePeriodId: required(integer)
  The Licence Period id of the User Licence.
- licencePeriodName: required(string)
  The Licence Period name.
- licenceId: required(integer)
  The id of the Licence.
- name: required(string)
  The Licence name.
- user: required(object)
  The user details for the Licence.
  - id: required(integer)
    The Suomisport id of the User
  - sportId: required(integer - minimum: 10000000 - maximum: 999999999)
    Sport-ID for the user
  - firstName: (string)
    The official first names of the user
  - nickname: (string)
    User nickname, the name the user wants to be addressed with. If the nickname is not defined, use the firstName to address the user.
  - lastName: (string)
    Last names
  - email: (string)
    The user email address
  - phone: (string)
    The user phone number
  - address: (object)
    The user postal address
    - streetAddress: required(string)
    - postCode: required(string)
    - postOffice: required(string)
    - state: (string)
    - countryCode: (string)
  - modificationTime: required(datetime)
    Last modification time of the User data
  - birthDate: (date-only)
    Date of birth
  - username: (string)
    User-selected unique nickname of the user, e.g. @happyuser
  - city: (string)
    User home city
  - gender: (one of Male, Female, Both)
    Gender of the user
  - socialSecurityNumber: (string)
    User's social security number
  - hasSocialSecurityNumber: (boolean)
    True if user has a Finnish Social Security Number, false if s/he does not have
  - nationality: (string - maxLength: 2)
    Country code of the user's nationality
  - marketingPermission: (boolean)
    True if the user has allowed 3rd party marketing messages, false otherwise.
  - deceasedDate: (date-only)
    The deceased date
  - languageCode: (one of FI, SV, EN - default: FI)
    (Deprecated, use 'locale' instead) Language code set by the user. Supported languages are Finnish (FI), Swedish (SE), English (EN).
  - locale: (one of fi_FI, sv_SE, en_GB - default: fi_FI)
    Language code set by the user. Supported languages are Finnish (fi_FI), Swedish (sv_SE), English (en_GB).
  - guardians: (array of user.GuardianInformation)
    Contact information of the user's guardians if the user does not have own contact information. Applies, for example, when the user is a minor and the parent information should be used for all communications
    Items: GuardianInformation
    firstName: required(string)
    Guardian first name or nickname
    lastName: required(string)
    Guardian last name
    email: (string)
    Guardian email address
    phone: (string)
    Guardian phone number
  - dependants: (array of user.DependantInformation)
    Information about user's dependants, i.e. children or other dependant persons.
    Items: DependantInformation
    id: required(integer)
    The Suomisport id of the dependant User
    firstName: required(string)
    Dependant first name
    lastName: required(string)
    Dependant last name
  - sportParameters: (array of user.user_sport_parameter.UserSportParameter)
    The user's sport parameter values for requested sport parameters
    Items: UserSportParameter
    id: required(integer)
    The Suomisport id of the sport parameter value
    modificationTime: required(datetime)
    Last modification time of the sport parameter value
    sportId: required(integer)
    The id of the Sport the parameter is associated with
    sportName: required(string)
    The name of the Sport the parameter is associated with
    sportParameterId: required(integer)
    The id of the Sport Parameter entity
    name: required(string - minLength: 1)
    The name of the parameter
    value: required(string)
    The parameter value
- usagePeriodStart: required(date-only)
  The start date of the User Licence usage period.
- usagePeriodEnd: required(date-only)
  The end time of the User Licence usage period.
- salesPriceInCents: required(integer)
  The Licence sales price in cents. The price may change over time in case the purchase is later fully or partionally refunded.
- purchaseTime: required(datetime-only)
  The activation time of the Licence, i.e. the time Suomisport was first notified on a successful purchase by the payment operator. The actual payment time may be earlier than purchaseTime.
- upgradeFrom: (integer)
  The id of the User Licence this User Licence upgrades and replaces.
- licenceOrganizationId: required(integer)
  The organization the User Licence is bound to, usually a club.
- licenceOrganizationSportId: required(integer - minimum: 10000000 - maximum: 999999999)
  Sport-ID of the organization the User Licence is bound to.
- licenceOrganizationName: required(string)
  The name of the organization the User Licence is bound to.
- licenceOrganizationOfficialName: required(string)
  The official name of the organization the User Licence is bound to.
- externalInsuranceCompany: (string)
  The name of the external insurance company for the Licence.
- externalInsuranceNumber: (string)
  The insurance number for the external insurance company for the Licence.
- licencePrimarySportId: (integer)
  The Id of the sport the User Licence is bound to.
- licencePrimarySportName: (string)
  The name of the sport the User Licence is bound to.
pageable: required(object)
Paging helper for retrieving data in batches.
- page: required(integer - default: 0 - minimum: 0)
  The zero-based page number
- size: required(integer - default: 50 - minimum: 1)
  The page size
- total: required(integer - minimum: 0)
  The total number of retrievable elements

HTTP status code 403

The sports federation id is invalid or user has no rights to requested sports federation

Suomisport API API documentation version v2

Generating the access token

Permissions overview

Organization permissions

Organization hierarchy

Cascading organization permissions

Special permissions

User personal data

PERMISSION_USER_ANONYMOUS

PERMISSION_USER_BASIC

PERMISSION_USER_CONTACT_INFO

PERMISSION_USER_EXTENDED

PERMISSION_USER_SSN

Organizations

get /organization

Query Parameters

HTTP status code 200

Body

Secured by oauth_2_0

get /organization/{id}

URI Parameters

HTTP status code 200

Body

Secured by oauth_2_0

get /organization/{id}/suborganizations

URI Parameters

Query Parameters

HTTP status code 200

Body

Secured by oauth_2_0

post /organization/{id}/suborganizations

URI Parameters

Body

HTTP status code 201

Body

Secured by oauth_2_0

get /organization/{id}/list

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Secured by oauth_2_0

put /organization/{id}/users

URI Parameters

Body

HTTP status code 200

Secured by oauth_2_0

get /organization/{id}/verifyAccess

URI Parameters

Query Parameters

HTTP status code 200

HTTP status code 403

Secured by oauth_2_0

Licence Period Data

get /licenceperiod/{sportsFederationId}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Secured by oauth_2_0

Licence Data

get /licence/{sportsFederationId}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Secured by oauth_2_0

get /licence/{sportsFederationId}/{licencePeriodId}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Secured by oauth_2_0

get /licence/{sportsFederationId}/{licencePeriodId}/sport/{sportId}

URI Parameters

Query Parameters