Suomisport
Suomisport Public API for external clients. The API does not replace the 2.0 API, instead it provides functions that the 2.0 API does not cover.
This definition covers the parts of the 3.0 Public API which can be used be all 3rd party software.
Version: 3.2.2
BasePath:/api/public/v3
Proprietary License
https://www.olympiakomitea.fi/olympiakomitea/jasenpalvelut/suomisport
Access
- OAuth AuthorizationUrl:TokenUrl:https://www.suomisport.fi/oauth2/token
[ Jump to Models ]
Table of Contents
Retrieve the list of all area associations of Suomisport (getAllAreaAssociations)
Return type
Example data
Content-Type: application/json
[ {
"id" : 0,
"officialName" : "officialName",
"grantStatementGroup" : {
"primaryName" : "primaryName",
"id" : 6
}
}, {
"id" : 0,
"officialName" : "officialName",
"grantStatementGroup" : {
"primaryName" : "primaryName",
"id" : 6
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of all Suomisport area associations was retrieved successfully
Up
get /area-association/{areaAssociationId}/listChildren
Retrieve the list of children of an area association (listAreaAssociationChildren)
Path parameters
areaAssociationId (required)
Path Parameter — The id of the area association super organization default: null format: int64
Query parameters
page (optional)
Query Parameter — Skip over a number of elements by specifying an offset value for the query default: 0 format: int32
size (optional)
Query Parameter — Limit the number of elements on the response default: 50 format: int32
ts (optional)
Query Parameter — Last-modified timestamp to allow fetching only lately updated organizations. default: null format: date-time
tsOrder (optional)
Query Parameter — Order lists by last-modified timestamp. default: null
businessId (optional)
Query Parameter — Return only suborganizations with specified business id. default: null
Return type
Example data
Content-Type: application/json
{
"pageable" : {
"total" : 0,
"size" : 1,
"page" : 0
},
"content" : [ {
"areaAssociationId" : 2,
"municipalityId" : 7,
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"address" : {
"streetAddress" : "streetAddress",
"countryCode" : "countryCode",
"postCode" : "postCode",
"state" : "state",
"postOffice" : "postOffice"
},
"areaAssociationName" : "areaAssociationName",
"businessId" : "businessId",
"description" : "description",
"sportsFederationId" : 5,
"officialName" : "officialName",
"abbreviation" : "abbreviation",
"parentOrganizationId" : 1,
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"sportId" : 6,
"emailAddress" : "emailAddress",
"phoneNumber" : "phoneNumber",
"sportsFederationName" : "sportsFederationName",
"masterSportId" : 9,
"masterClubName" : "masterClubName",
"masterClubId" : 5,
"registrationNumber" : "registrationNumber",
"iban" : "iban",
"imageUrl" : "imageUrl",
"id" : 0,
"bic" : "bic"
}, {
"areaAssociationId" : 2,
"municipalityId" : 7,
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"address" : {
"streetAddress" : "streetAddress",
"countryCode" : "countryCode",
"postCode" : "postCode",
"state" : "state",
"postOffice" : "postOffice"
},
"areaAssociationName" : "areaAssociationName",
"businessId" : "businessId",
"description" : "description",
"sportsFederationId" : 5,
"officialName" : "officialName",
"abbreviation" : "abbreviation",
"parentOrganizationId" : 1,
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"sportId" : 6,
"emailAddress" : "emailAddress",
"phoneNumber" : "phoneNumber",
"sportsFederationName" : "sportsFederationName",
"masterSportId" : 9,
"masterClubName" : "masterClubName",
"masterClubId" : 5,
"registrationNumber" : "registrationNumber",
"iban" : "iban",
"imageUrl" : "imageUrl",
"id" : 0,
"bic" : "bic"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of area association children was retrieved successfully
PublicOrganizationPage
Up
get /sportsfederation/{federationId}/mastersports
Find sports by id of the federation (findFederationMasterSports)
Finds list of sports by id of the federation
Path parameters
federationId (required)
Path Parameter — Id of the federation default: null format: int64
Return type
Example data
Content-Type: application/json
[ {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
}, {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of the sports of the federation
Find list of all master sports (findMasterSports)
Finds list of master sports
Return type
Example data
Content-Type: application/json
[ {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
}, {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of the sports
Get the municipalities of Finland (getMunicipalities)
Get details of all municipalities in Finland.
Return type
Example data
Content-Type: application/json
[ {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"id" : 0,
"areaAssociation" : {
"emailAddress" : "emailAddress",
"phoneNumber" : "phoneNumber",
"primaryName" : "primaryName",
"id" : 6
}
}, {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"id" : 0,
"areaAssociation" : {
"emailAddress" : "emailAddress",
"phoneNumber" : "phoneNumber",
"primaryName" : "primaryName",
"id" : 6
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns all of the municipalities of Finland as a list.
Fetch tokens (getTokens)
Fetch access, refresh and id tokens
Request headers
Authorization (optional)
Header Parameter — OpenID Connect basic authorization header default: null
Query parameters
grant_type (required)
Query Parameter —
Determines the mechanism to authorize the creation of the tokens
The legal values are:
authorization_coderefresh_token
default: null
client_id (optional)
Query Parameter — The Suomisport id of the client default: null
client_secret (optional)
Query Parameter — OAuth 2 state default: null
redirect_uri (optional)
Query Parameter — Url to redirect after successful login default: null
code (optional)
Query Parameter — Authorization code default: null
scope (optional)
Query Parameter — A list of scope that the client wants to be included in the access token default: null
refresh_token (optional)
Query Parameter — Required if grant_type is refresh_token default: null
code_verifier (optional)
Query Parameter —
Code verifier for PKCE (Proof Key for Code Exchange by OAuth Public Clients).
A cryptographically random string that is used to correlate the authorization request to the token request.
NOTE: this is required parameter for PKCE-clients i.e. the clients using the Suomisport OIDC without client_secret.
default: null
Return type
Example data
Content-Type: application/json
{
"access_token" : "access_token",
"refresh_token" : "refresh_token",
"id_token" : "id_token",
"token_type" : "token_type",
"expires_in" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
200 response
Token
Send an authentication request (grantClientCredentials)
Send an authentication request
Query parameters
response_type (optional)
Query Parameter — OAuth2 response type, for now only 'code' is supported default: null
client_id (optional)
Query Parameter — The Suomisport id of the client default: null
redirect_uri (optional)
Query Parameter — Url to redirect after successful login default: null
state (optional)
Query Parameter — OAuth 2 state default: null
scope (optional)
Query Parameter — OAuth 2 scopes (https://www.oauth.com/oauth2-servers/scopes/) default: null
nonce (optional)
Query Parameter — String value used to associate a Client session with an ID Token, and to mitigate replay attacks. default: null
code_challenge (optional)
Query Parameter —
Code challenge for PKCE (Proof Key for Code Exchange by OAuth Public Clients).
A challenge derived from the code verifier that is sent in the authorization request, to be verified against later.
BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) == code_challenge
NOTE: this is required parameter for PKCE-clients i.e. the clients using the Suomisport OIDC without client_secret.
default: null
code_challenge_method (optional)
Query Parameter —
Code challenge method for PKCE (Proof Key for Code Exchange by OAuth Public Clients).
Defaults to "plain" if not present in the request.
The legal code verifier transformation method values are:
default: null
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
200 response
String
302
302 response
This is the example endpoint for clients using Suomisport webhooks.
Webhooks are supported for Suomisport events and event registrations. Client can register itself as a webhook
listener by providing a webhook URL when creating an event to the Suomisport.
Webhook event contains a Suomisport id_token as a request header "Authorization: Bearer <id_token>". Client must
verify the token and check that the audience claim of the token matches to the webhook target URL.
NOTE: this endpoint is not implemented in Suomisport API. It is just an example for clients to implement theirs.
(
webhookExamplePost)
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Webhook event is handled successfully. Suomisport will not retry sending the event when client responds with
status code 200.
400
Suomisport will retry sending events 4 times if client returns an error to the Suomisport.
Up
post /event/{eventUuid}/participants
Add participants to event (createEventParticipants)
Path parameters
eventUuid (required)
Path Parameter — UUID of the event default: null
Request body
Responses
200
Event participants saved successfully
Up
get /master-club/{masterClubId}/sportsClubs
Retrieve the list of subordinate sports clubs of the master club (getSportsClubs)
Path parameters
masterClubId (required)
Path Parameter — The id of the master club super organization default: null format: int64
Return type
Example data
Content-Type: application/json
[ {
"sportsFederationName" : "sportsFederationName",
"sports" : [ {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
}, {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
} ],
"primaryName" : "primaryName",
"sportsFederationId" : 6,
"id" : 0
}, {
"sportsFederationName" : "sportsFederationName",
"sports" : [ {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
}, {
"nameFi" : "nameFi",
"nameSe" : "nameSe",
"description" : "description",
"id" : 1
} ],
"primaryName" : "primaryName",
"sportsFederationId" : 6,
"id" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of subordinate sports clubs was retrieved successfully
Create a new Suomisport Merit (createMerit)
Request body
Return type
Example data
Content-Type: application/json
{
"meritGroupId" : 6,
"name" : "name",
"id" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information of the created merit
CreatedMerit
Get API version information (getApiVersion)
Returns the API version information
Return type
Example data
Content-Type: application/json
{
"patch" : "",
"fullVersion" : "",
"major" : 0,
"minor" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Version
Up
get /organization/municipality/list
Finds all municipalities registered as organizations to Suomisport (findAllMunicipalities)
Finds all Suomisport municipality organizations
Return type
Example data
Content-Type: application/json
[ {
"primaryName" : "primaryName",
"id" : 0
}, {
"primaryName" : "primaryName",
"id" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns all municipalities registered as organizations to Suomisport
Up
get /organization/sports-federation/list
Finds all Suomisport sports federations (findAllSportsFederations)
Finds all Suomisport sports federations and returns them as an array.
Query parameters
includePassive (optional)
Query Parameter — If true, sports federations with passive status are returned also. default: false
Return type
Example data
Content-Type: application/json
[ {
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"sportsFederationName" : "sportsFederationName",
"primaryName" : "primaryName",
"organizationOrigin" : "SUOMISPORT",
"id" : 0,
"hasAdminUsers" : true,
"organizationCollectionDetails" : {
"superOrganizationId" : 6,
"memberOrganizationCount" : 1
}
}, {
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"sportsFederationName" : "sportsFederationName",
"primaryName" : "primaryName",
"organizationOrigin" : "SUOMISPORT",
"id" : 0,
"hasAdminUsers" : true,
"organizationCollectionDetails" : {
"superOrganizationId" : 6,
"memberOrganizationCount" : 1
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns found Suomisport sports federations as an array.
Up
get /organization/getMultiple
Fetch multiple organization entities at once (getMultiple)
This API call returns those organization entities out of the given list which have not been deleted and do not have status PASSIVE.
Query parameters
organizationIds (required)
Query Parameter — The list of ids of the organizations whose entities to fetch default: null format: int64
Return type
Example data
Content-Type: application/json
[ {
"areaAssociationId" : 2,
"municipalityId" : 7,
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"address" : {
"streetAddress" : "streetAddress",
"countryCode" : "countryCode",
"postCode" : "postCode",
"state" : "state",
"postOffice" : "postOffice"
},
"areaAssociationName" : "areaAssociationName",
"businessId" : "businessId",
"description" : "description",
"sportsFederationId" : 5,
"officialName" : "officialName",
"abbreviation" : "abbreviation",
"parentOrganizationId" : 1,
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"sportId" : 6,
"emailAddress" : "emailAddress",
"phoneNumber" : "phoneNumber",
"sportsFederationName" : "sportsFederationName",
"masterSportId" : 9,
"masterClubName" : "masterClubName",
"masterClubId" : 5,
"registrationNumber" : "registrationNumber",
"iban" : "iban",
"imageUrl" : "imageUrl",
"id" : 0,
"bic" : "bic"
}, {
"areaAssociationId" : 2,
"municipalityId" : 7,
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"address" : {
"streetAddress" : "streetAddress",
"countryCode" : "countryCode",
"postCode" : "postCode",
"state" : "state",
"postOffice" : "postOffice"
},
"areaAssociationName" : "areaAssociationName",
"businessId" : "businessId",
"description" : "description",
"sportsFederationId" : 5,
"officialName" : "officialName",
"abbreviation" : "abbreviation",
"parentOrganizationId" : 1,
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"sportId" : 6,
"emailAddress" : "emailAddress",
"phoneNumber" : "phoneNumber",
"sportsFederationName" : "sportsFederationName",
"masterSportId" : 9,
"masterClubName" : "masterClubName",
"masterClubId" : 5,
"registrationNumber" : "registrationNumber",
"iban" : "iban",
"imageUrl" : "imageUrl",
"id" : 0,
"bic" : "bic"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The set of organization entities.
Up
get /organization/queryVisibility
Query public API visibility of organizations (queryVisibility)
Queries which of the organizations whose ids are passed are visible via the public organization APIs.
Organizations which are not visible will not appear in the results of any public organization API call. An organization is not visible if it is either
- hard-deleted,
- soft-deleted or
- its status is PASSIVE.
This API call returns the subset of ids of visible organizations out of the given organization ids.
Query parameters
organizationIds (required)
Query Parameter — The list of ids of the organizations whose visibility is to be queried default: null format: int64
Return type
array[Long]
Example data
Content-Type: application/json
[ 0, 0 ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The subset of ids of visible organizations out of the given organization ids
Up
get /organization/search
Search Suomisport organizations (search)
Searches Suomisport organizations by business id, registration number, or name. The search will return a maximum of 20 results per organization origin. If no search terms are specified, an empty list is returned.
The results can be further constrained by a sports federation id and organization type. The sports federation id constraint only affects organizations with origin SUOMISPORT or SINETTISEURAT.
The results also include organizations imported from Seuraverkko and Sinettiseurat.
Query parameters
businessId (optional)
Query Parameter — Organization business id default: null
registrationNumber (optional)
Query Parameter — Organization registration number default: null
name (optional)
Query Parameter — Organization name (case-insensitive) default: null
sportsFederationId (optional)
Query Parameter — Sports federation id default: null format: int64
type (optional)
Query Parameter — Organization type default: null
collectionType (optional)
Query Parameter — Organization collection type default: null
Return type
Example data
Content-Type: application/json
[ {
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"sportsFederationName" : "sportsFederationName",
"primaryName" : "primaryName",
"organizationOrigin" : "SUOMISPORT",
"id" : 0,
"hasAdminUsers" : true,
"organizationCollectionDetails" : {
"superOrganizationId" : 6,
"memberOrganizationCount" : 1
}
}, {
"organizationType" : "UNRECOGNIZED_ENUM_VALUE",
"organizationCollectionType" : "UNRECOGNIZED_ENUM_VALUE",
"sportsFederationName" : "sportsFederationName",
"primaryName" : "primaryName",
"organizationOrigin" : "SUOMISPORT",
"id" : 0,
"hasAdminUsers" : true,
"organizationCollectionDetails" : {
"superOrganizationId" : 6,
"memberOrganizationCount" : 1
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns found organization details as an array.
Create a new Suomisport Event (createEvent)
Request body
Return type
Example data
Content-Type: application/json
{
"organizerId" : 6,
"visibility" : "visibility",
"name" : "name",
"id" : 0,
"uuid" : "uuid",
"status" : "status"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information of the created event
CreatedEvent
Retrieve page of events (getEvents)
Query parameters
page (optional)
Query Parameter — Skip over a number of elements by specifying an offset value for the query default: 0 format: int32
size (optional)
Query Parameter — Limit the number of elements on the response default: 50 format: int32
attendeeMaxBirthDate (optional)
Query Parameter — Maximum allowed birthdate of an attendee default: null format: date
attendeeMinBirthDate (optional)
Query Parameter — Minimum allowed birthdate of an attendee default: null format: date
dateTimeRangeStart (optional)
Query Parameter — 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. default: null format: date-time
dateTimeRangeEnd (optional)
Query Parameter — 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. default: null format: date-time
sportEventSponsoringProjectName (optional)
Query Parameter — The case insensitive name of the sport event sponsoring project (for example HOBIHOBI or Lisää Liikettä) default: null
municipalityName (optional)
Query Parameter — The case insensitive name of the municipality linked to event (for example Tampere or vantaa) default: null
gender (optional)
Query Parameter — The gender of the attendee default: null
mastersportIds (optional)
Query Parameter — The ids of the mastersports linked to the federation sports of the event default: null format: int64
sportNames (optional)
Query Parameter — Search terms used to search from master sport and sport names of event default: null
minPriceInCents (optional)
Query Parameter — Min participation fee of the event in cents default: null format: int64
maxPriceInCents (optional)
Query Parameter — Max participation fee of the event in cents default: null format: int64
tag (optional)
Query Parameter — The tag linked to the event (deprecated, use tags instead) default: null
tags (optional)
Query Parameter — The tags linked to the event default: null
attendeeLocationLat (optional)
Query Parameter — The Attendee latitude coordinate default: null format: double
attendeeLocationLong (optional)
Query Parameter — The Attendee longitude coordinate default: null format: double
sort (optional)
Query Parameter — The field names used to sort the events default: null
includeDeletedEvents (optional)
Query Parameter — Include recently deleted events (deleted within about a month) default: false
searchTerm (optional)
Query Parameter — Search term used to search by event name, tag, location, organizer name and sports default: null
Return type
Example data
Content-Type: application/json
{
"pageable" : {
"total" : 0,
"size" : 1,
"page" : 0
},
"content" : [ {
"municipalityNameSe" : "municipalityNameSe",
"registrationMinBirthDate" : "2000-01-23",
"municipalityId" : 2,
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"locationDescription" : "locationDescription",
"description" : "description",
"deletionTime" : "2000-01-23T04:56:07.000+00:00",
"locationAddress" : "locationAddress",
"contactPersonPhone" : "contactPersonPhone",
"uuid" : "uuid",
"currentAttendeeCount" : 1,
"registrationMaxBirthDate" : "2000-01-23",
"parentSeriesEventUuid" : "parentSeriesEventUuid",
"organizerId" : 6,
"municipalityNameFi" : "municipalityNameFi",
"sportEventSponsoringProjectIds" : [ 3, 3 ],
"eventKind" : "INDIVIDUAL",
"modificationTime" : "2000-01-23T04:56:07.000+00:00",
"imageUrl" : "imageUrl",
"organizerName" : "organizerName",
"locationCoordinates" : {
"lon" : 2.3021358869347655,
"lat" : 5.637376656633329
},
"eventId" : 0,
"allowedGender" : "MALE",
"registrationEndTime" : "2000-01-23T04:56:07.000+00:00",
"sports" : [ "sports", "sports" ],
"mastersports" : [ "mastersports", "mastersports" ],
"priceInCents" : 7,
"parentSeriesEventName" : "parentSeriesEventName",
"endDateTime" : "2000-01-23T04:56:07.000+00:00",
"registrationStartTime" : "2000-01-23T04:56:07.000+00:00",
"tags" : [ "tags", "tags" ],
"parentSeriesEventId" : 9,
"maxAttendeeCount" : 5,
"startDateTime" : "2000-01-23T04:56:07.000+00:00",
"contactPersonName" : "contactPersonName",
"sportEventSponsoringProjectNames" : [ "sportEventSponsoringProjectNames", "sportEventSponsoringProjectNames" ],
"name" : "name",
"contactPersonEmail" : "contactPersonEmail"
}, {
"municipalityNameSe" : "municipalityNameSe",
"registrationMinBirthDate" : "2000-01-23",
"municipalityId" : 2,
"creationTime" : "2000-01-23T04:56:07.000+00:00",
"locationDescription" : "locationDescription",
"description" : "description",
"deletionTime" : "2000-01-23T04:56:07.000+00:00",
"locationAddress" : "locationAddress",
"contactPersonPhone" : "contactPersonPhone",
"uuid" : "uuid",
"currentAttendeeCount" : 1,
"registrationMaxBirthDate" : "2000-01-23",
"parentSeriesEventUuid" : "parentSeriesEventUuid",
"organizerId" : 6,
"municipalityNameFi" : "municipalityNameFi",
"sportEventSponsoringProjectIds" : [ 3, 3 ],
"eventKind" : "INDIVIDUAL",
"modificationTime" : "2000-01-23T04:56:07.000+00:00",
"imageUrl" : "imageUrl",
"organizerName" : "organizerName",
"locationCoordinates" : {
"lon" : 2.3021358869347655,
"lat" : 5.637376656633329
},
"eventId" : 0,
"allowedGender" : "MALE",
"registrationEndTime" : "2000-01-23T04:56:07.000+00:00",
"sports" : [ "sports", "sports" ],
"mastersports" : [ "mastersports", "mastersports" ],
"priceInCents" : 7,
"parentSeriesEventName" : "parentSeriesEventName",
"endDateTime" : "2000-01-23T04:56:07.000+00:00",
"registrationStartTime" : "2000-01-23T04:56:07.000+00:00",
"tags" : [ "tags", "tags" ],
"parentSeriesEventId" : 9,
"maxAttendeeCount" : 5,
"startDateTime" : "2000-01-23T04:56:07.000+00:00",
"contactPersonName" : "contactPersonName",
"sportEventSponsoringProjectNames" : [ "sportEventSponsoringProjectNames", "sportEventSponsoringProjectNames" ],
"name" : "name",
"contactPersonEmail" : "contactPersonEmail"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The page of Suomisport events
ApiEventPage
Up
get /user/{sportId}/user-id
Retrieve the Suomisport User ID by the User Sport-ID (findUserIdByUserSportId)
Path parameters
sportId (required)
Path Parameter — The Sport-ID of the User. Sport-ID is an eight- or nine-digit identifier of a person. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"userId" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns the Suomisport ID of the requested user
UserInfo
403
The Sport-ID is invalid or authorized API user has no rights to requested user
[ Jump to Methods ]
Table of Contents
ApiEventPage - ApiMasterSport - ApiSportsClub - AreaAssociation - CreateEvent - CreateEventParticipants - CreateMerit - CreatedEvent - CreatedMerit - EducationalSystem - EventDateTime - EventLocation - EventPriceDetails - EventWebhookEvent - EventWebhookEvent_eventPayload - EventWebhookEvent_eventRegistrationPayload - GrantStatementGroup - MeritGrant - MunicipalityListResponse - OrganizationCollectionType - OrganizationOrigin - OrganizationSearchResponse - OrganizationSearchResponse_organizationCollectionDetails - OrganizationType - Pageable - PublicAPIEventSearchResult - PublicAddress - PublicOrganization - PublicOrganizationPage - PublicOrganizationSelectItem - SimplifiedOrganizationSearchResponse - Token - UserInfo - Version -
Page of Suomisport events.
content (optional)
pageable (optional)
Suomisport master sport entity.
id (optional)
Long The Suomisport id of the sport. format: int64
nameFi
nameSe (optional)
description (optional)
String The description of the sport
A CLUB level organization, coupled with the master sports, acquired through sports
federation association.
id (optional)
Long The id of the organization. format: int64
primaryName (optional)
String The primary name of the organization.
sportsFederationId (optional)
Long The id of the sports federation. format: int64
sportsFederationName (optional)
String The name of the associated sports federation.
sports (optional)
Area association related to the municipality.
id (optional)
Long The id of the area association related to the municipality. format: int64
primaryName (optional)
String The primary name of the area association.
emailAddress (optional)
String The email address of the area association.
phoneNumber (optional)
String The phone number of the area association.
The information of the event to be created
name
description (optional)
String The description of the event
organizerId
Long Suomisport ID of the organization organizing the event format: int64
locationAddress (optional)
String The street address where the event is held
locationDescription (optional)
String Detailed description of the place where the event is held
locationCoordinates (optional)
priceDetails (optional)
municipalityId (optional)
Long The Suomisport id of the municipality related to the event format: int64
mastersportIds (optional)
array[Long] The list of Suomisport mastersport IDs related to the event format: int64
startDateTime
endDateTime
registrationStartDateTime (optional)
registrationEndDateTime (optional)
maxAttendeeCount (optional)
Integer The maximum number of attendees. The absence of a value means that there is no limit. format: int32
registrationCancellable
Boolean Is registration to the event cancellable
registrationCancellationDeadline (optional)
educationalSystem (optional)
meritIds (optional)
array[Long] The list of merit ids that can be granted to event attendees format: int64
allowedRegisterer
String Contains the visibility settings of an event. Legal values are:
ATHLETE - means that an athlete can register himself/herself to an event.ORGANIZATION_USER - means that an organization user can register participants to events which are organized by his/her organization.BOTH - means that athletes and organization users can register new participants to events.
visibility
String Contains the visibility settings of an event. Legal values are:
PUBLIC - means that the event is shown on the event list page and it can be found from
Google as long as Google has indexed the event page.PRIVATE - means that the event can be accessed only if you know the URL of the event.
purpose
String Contains the function or the purpose of the event
SPORTS - Sports event (Liikuntatapahtuma)EDUCATION - Educational event (Koulutustapahtuma)ORGANIZATIONAL - Organizational event (Järjestötapahtuma)OTHER - Other (Muu tapahtuma)PROMOTION - Promotional event (Yleisötapahtuma)
status (optional)
String Contains the status of an event
DRAFT - means that the event is not visible in the servicePUBLISHED - means that the event is visible in the service
eventKind (optional)
String Contains the event kind. For external API users INDIVIDUAL is the way to go.
INDIVIDUAL - means that the event is regular event with regular form and registration processCROWD_REGISTRATION - means that the event is custom event used for Seurapalvelu Crowd registration
The information of the event participants and optional details of the granting of the event merits
userIds
array[Long] 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). format: int64
grantEventMerits
Boolean Should event merits be granted for participants
meritGrant (optional)
A merit contains the information of a single merit.
name
description
String The description of the merit.
meritGroupId
Long The Suomisport id of the merit group that owns this merit. format: int64
organizationId
Long The Suomisport id of the owner organization of the merit format: int64
meritGrantingAuthorType
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.
meritValidityPeriodType
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.
type
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 (optional)
date The end date of the validity period. This is given only if the value of
the meritValidityPeriodType is FIXED_DATE. format: date
validityFixedDurationInMonths (optional)
Integer The validity period of this merit in months. This given only if the value of
the meritValidityPeriodType is FIXED_DURATION. format: int16
mastersportIds (optional)
array[Long] The list of Suomisport mastersport IDs related to the merit format: int64
userProvidedMasterSportRequired (optional)
Boolean Does this merit require input from user (e.g. in event registration)
to correctly tie it to desired master sport(s).
Contains the subset of the information of the created event
id
Long The Suomisport ID of the event.
This is the ID of the database object and is mainly for internal usage. format: int64
uuid
String The unique UUID of the event.
This is the generated UUID of the event and is mainly used for public access to the event.
name
organizerId
Long Suomisport ID of the organization organizing the event format: int64
visibility
String Contains the visibility settings of an event. Legal values are:
PUBLIC - means that the event is shown on the event list page and it can be found from
Google as long as Google has indexed the event page.PRIVATE - means that the event can be accessed only if you know the URL of the event.
status
String Contains the status of an event
DRAFT - means that the event is not visible in the servicePUBLISHED - means that the event is visible in the service
A merit contains the information of a single merit.
id (optional)
Long The Suomisport id of the merit. format: int64
meritGroupId (optional)
Long The Suomisport ID of the merit group that owns this merit. format: int64
name (optional)
String The name of this merit.
Details of an educational system the event is related to.
name
String The name/type of the educational system. Legal values are:
courseId
String The id of the educational system course the Event is related to
The date and time at which the event starts. The time is optional and is stated as a local time
in the timezone of the event's location.
date
date The date at which the event starts (yyyy-mm-dd) format: date
time (optional)
String The time at which the event starts (HH:MM)
Geographical coordinates.
lat
Double Latitude coordinate format: double
lon
Double Longitude coordinate format: double
The event price details.
name
description
String The description of the price
priceInCents
Payload of the event webhooks.
id
Long The unique ID of the webhook event. format: int64
type
EVENT
EVENT_REGISTRATION
eventPayload (optional)
eventRegistrationPayload (optional)
The payload for the Event webhook events
type
String The type of the Suomisport Event webhook events
UPDATE
DELETE
eventId
Long The ID of the Suomisport event the webhook event is targeted for format: int64
timestamp
Date The modification time of the event format: date-time
The payload for the Event registration webhook events
type
String The type of the Suomisport Event webhook events
UPDATE
DELETE
CREATE
eventId
Long The ID of the Suomisport event the registration is related to format: int64
eventRegistrationId
Long The ID of the event registration format: int64
userId
Long The ID of the registered Suomisport user format: int64
timestamp
Date The modification time of the event registration format: date-time
registrationType
CROWD
MEMBERSHIP
Grant statement group
primaryName (optional)
String The primary name of grant statement group (Aluelausujaryhmä)
id (optional)
Long The Suomisport id of grant statement group (Aluelausujaryhmä) format: int64
The details of the granting of the event merits.
These details are mandatory if grantEventMerits is set to 'true'.
grantingDate
date The granting date for the merit (yyyy-mm-dd) format: date
granterUserId (optional)
Long 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. format: int64
meritGranter (optional)
String 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 (optional)
String The optional additional info for the granted merit.
registrationDate (optional)
date 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. (yyyy-mm-dd) format: date
notifyGrantees (optional)
Boolean Optional setting to control whether to notify the grantees on the granted merit. Default functionality
is to notify the new grantees.
Contains the details of the Finnish municipalities.
id (optional)
Long The id of the municipality. format: int64
nameFi (optional)
String The Finnish name of the municipality.
nameSe (optional)
String The Swedish name of the municipality.
areaAssociation (optional)
Organization collection type definition
Defines the origin of the organization.
Contains the details of the found Suomisport organization.
id (optional)
Long The id of the organization. Should be combined with organizationOrigin to ensure uniqueness. format: int64
primaryName (optional)
String The primary name of the organization.
organizationType (optional)
organizationCollectionType (optional)
organizationOrigin (optional)
hasAdminUsers (optional)
Boolean For organizations with origin
SUOMISPORT: true, if the organization has at least one admin user.
sportsFederationName (optional)
String The name of the sports federation of this organization.
organizationCollectionDetails (optional)
Details about the related organization collection if one exists
superOrganizationId (optional)
Long The id of the found organization's super organization, if one exists format: int64
memberOrganizationCount (optional)
Long The number of found member organizations for organization collection format: int64
Organization type definition
Pageable listing page details
page (optional)
Integer The zero-based page number format: int32
size (optional)
Integer The page size format: int32
total (optional)
Integer The total number of retrievable elements format: int32
Search results of an event organized by a sports organization.
eventId (optional)
Long The Suomisport id of the event format: int64
name (optional)
description (optional)
sports (optional)
array[String] The list of sport disciplines exercised at the event
mastersports (optional)
array[String] The list of mastersports related to sports of the event
organizerId (optional)
Long Suomisport ID of the organization organizing the event format: int64
organizerName (optional)
String The name of the organization organizing the event
startDateTime (optional)
Date 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. format: date-time
endDateTime (optional)
Date 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. format: date-time
currentAttendeeCount (optional)
Integer The number of currently enrolled attendees format: int32
maxAttendeeCount (optional)
Integer The maximum number of attendees format: int32
locationAddress (optional)
String The street address where the event is held
locationDescription (optional)
String Detailed description of the place where the event is held
locationCoordinates (optional)
uuid (optional)
String Unique identifier of the event
priceInCents (optional)
Long Participation fee of the event in cents format: int64
parentSeriesEventId (optional)
Long The Suomisport id of this event's parent series event format: int64
parentSeriesEventUuid (optional)
String The uuid of this event's parent series event
parentSeriesEventName (optional)
String The name of this event's parent series event
sportEventSponsoringProjectNames (optional)
array[String] The list of names of the sponsoring projects of the event
sportEventSponsoringProjectIds (optional)
array[Long] The list of ids of the sponsoring projects of the event format: int64
municipalityNameFi (optional)
String The Finnish name of the municipality of the event
municipalityNameSe (optional)
String The Swedish name of the municipality of the event
municipalityId (optional)
Long The id of the municipality of the event format: int64
registrationMaxBirthDate (optional)
date The registration max birth date format: date
registrationMinBirthDate (optional)
date The registration min birth date format: date
registrationStartTime (optional)
Date The registration start time format: date-time
registrationEndTime (optional)
Date The registration end time format: date-time
tags (optional)
allowedGender (optional)
String The gender which is required for attendee. If the gender field is null, user with any gender can attend.
MALE
FEMALE
imageUrl (optional)
String URL of the image of the event
eventKind (optional)
INDIVIDUAL
SERIES
ACTIVITY_PROGRAM
contactPersonName (optional)
String The name of the contact person of the event
contactPersonEmail (optional)
String The email of the contact person of the event
contactPersonPhone (optional)
String The phone number of the contact person of the event
creationTime (optional)
Date The time when the event was created format: date-time
modificationTime (optional)
Date The time when the event was last modified format: date-time
deletionTime (optional)
Date The time when the event was deleted format: date-time
Full address of the organization
streetAddress (optional)
postCode (optional)
postOffice (optional)
state (optional)
countryCode (optional)
Suomisport organization entity.
id (optional)
Long The Suomisport id of the organization. format: int64
organizationType
organizationCollectionType (optional)
officialName
String The organization official name
abbreviation (optional)
String The organization name abbreviation
description (optional)
String The long description of the organization
sportId (optional)
Long The Sport-ID of the organization format: int64
parentOrganizationId (optional)
Long The parent organization id of the organization format: int64
sportsFederationId (optional)
Long The parent federation id of the organization format: int64
masterClubId (optional)
Long The organization's master club's organization id format: int64
areaAssociationId (optional)
Long The organization's area association's organization id format: int64
emailAddress (optional)
String The email address of the organization
phoneNumber (optional)
String The phone number of the organization
businessId (optional)
String The business id of the organization
registrationNumber (optional)
String The registration number of the organization
address (optional)
municipalityId (optional)
Long The municipality id of the organization format: int64
masterSportId (optional)
Long The Suomisport master sport id of the organization format: int64
iban (optional)
String The IBAN of the organization
bic (optional)
String The BIC of the organization
sportsFederationName (optional)
String The parent federation name of the organization
masterClubName (optional)
String The name of the master club containing this organization
areaAssociationName (optional)
String The name of the area association containing this organization
imageUrl (optional)
String A URL pointing to the organization's logo image. The image is 180x180 pixels in size.
Page of organizations. The page of organizations is used to iterate through the list
of organizations.
content (optional)
pageable (optional)
Organization item displayed in a UI element for selection.
id (optional)
Long The Suomisport id of the organization. format: int64
officialName (optional)
String The official name of the organization.
grantStatementGroup (optional)
Contains only name and id of the organization.
id (optional)
Long The id of the organization. format: int64
primaryName (optional)
String The primary name of the organization.
OAuth 2 token dto
expires_in (optional)
Integer Number of seconds until the access_token expires
refresh_token (optional)
access_token (optional)
id_token (optional)
String OpenID Connect id token
token_type (optional)
String The token type is always Bearer
Suomisport User ID information
userId (optional)
Long Suomisport ID of the requested user format: int64
API version information. Contains full version information, as well as the major, minor and patch versions as separate structured fields.
fullVersion (optional)
String Full version number of the API. Format.
...
major (optional)
Integer Major version of the API. format: int32
minor (optional)
Integer Minor version of the API. format: int32
patch (optional)
String Revision number of the API. The revision number can be either release revision or development revision.