HTTP status code 200

The Licences for the Sports Federation

Body

Media type: application/json

Type: object

• 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

HTTP status code 200

The Licences for the Sports Federation.

Body

Media type: application/json

Type: object

• 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

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

• 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

HTTP status code 200

The root level organizations the client has access rights to.

Body

Media type: application/json

Type: object

• 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's primary name

  • officialName: (string)

    The organization's official 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

  • masterClubModificationTime: (datetime)

    Last modification time 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

  • url: required(string)

    The URL of the organization home page

  • contactPerson: required(string)

    The full name of the organization contact person

  • phone: required(string)

    The phone number of the organization

  • established: required(date-only)

    The date of establishment of the organization

  • terminated: required(date-only)

    The date of termination of the 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

HTTP status code 200

Organization with the specified ID

Body

Media type: application/json

Type: object

• 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's primary name

• officialName: (string)

  The organization's official 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

• masterClubModificationTime: (datetime)

  Last modification time 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

• url: required(string)

  The URL of the organization home page

• contactPerson: required(string)

  The full name of the organization contact person

• phone: required(string)

  The phone number of the organization

• established: required(date-only)

  The date of establishment of the organization

• terminated: required(date-only)

  The date of termination of the organization

Secured by oauth_2_0

HTTP status code 200

List of suborganizations of the organization

Body

Media type: application/json

Type: object

• 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's primary name

  • officialName: (string)

    The organization's official 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

  • masterClubModificationTime: (datetime)

    Last modification time 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

  • url: required(string)

    The URL of the organization home page

  • contactPerson: required(string)

    The full name of the organization contact person

  • phone: required(string)

    The phone number of the organization

  • established: required(date-only)

    The date of establishment of the organization

  • terminated: required(date-only)

    The date of termination of the 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

HTTP status code 201

Organization was created successfully

Body

Media type: application/json

Type: object

• 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's primary name

• officialName: (string)

  The organization's official 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

• masterClubModificationTime: (datetime)

  Last modification time 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

• url: required(string)

  The URL of the organization home page

• contactPerson: required(string)

  The full name of the organization contact person

• phone: required(string)

  The phone number of the organization

• established: required(date-only)

  The date of establishment of the organization

• terminated: required(date-only)

  The date of termination of the organization

Secured by oauth_2_0

HTTP status code 200

List of all organizations under a Sports Federation

Body

Media type: application/json

Type: object

• 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's primary name

  • officialName: (string)

    The organization's official 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

  • masterClubModificationTime: (datetime)

    Last modification time 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

  • url: required(string)

    The URL of the organization home page

  • contactPerson: required(string)

    The full name of the organization contact person

  • phone: required(string)

    The phone number of the organization

  • established: required(date-only)

    The date of establishment of the organization

  • terminated: required(date-only)

    The date of termination of the 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

HTTP status code 200

The access right was successfully created, or it already existed.

Secured by oauth_2_0

HTTP status code 200

The user has the specified access rights for the organization

HTTP status code 403

The user does not have the specified access rights for the organization

Secured by oauth_2_0

HTTP status code 200

The Licence Periods for the Sports Federation.

Body

Media type: application/json

Type: object

• 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

HTTP status code 200

The merit groups of an organization.

Body

Media type: application/json

Type: object

• 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

HTTP status code 200

The merits of a merit group.

Body

Media type: application/json

Type: object

• 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.

  • masterSportIds: (array of entityids.EntityId - minItems: 1 - maxItems: 10000)

    List of master sports ids linked to the merit

• 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

HTTP status code 200

The granted merits of a merit.

Body

Media type: application/json

Type: object

• 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.

    • organizations: required(array of merit.GrantedMeritOrganization)

      List of the organizations the granted merit is related to.

      Items: GrantedMeritOrganization

      • id: required(integer)

        The Suomisport ID of the organization

      • primaryName: required(string)

        The primary name 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

    • masterSports: required(array of sport.MasterSport)

      List of the master sports the granted merit is related to.

      Items: MasterSport

      • id: required(integer)

        The Suomisport id of the entity

      • name: required(string)

        The entity name

    • 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

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

HTTP status code 200

The Insurances for the Sports Federation

Body

Media type: application/json

Type: object

• 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

HTTP status code 200

The Insurances for the Sports Federation.

Body

Media type: application/json

Type: object

• 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

HTTP status code 200

The Sports for the Sports Federation

Body

Media type: application/json

Type: object

• 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

HTTP status code 200

The Licences for the Sports Federation

Body

Media type: application/json

Type: object

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

HTTP status code 200

The User Licences for the Sports Federation.

Body

Media type: application/json

Type: object

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

HTTP status code 200

The user licences of the specified licence.

Body

Media type: application/json

Type: object

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

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

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

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

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

HTTP status code 201

Club transfer of the User Licence was completed successfully

Secured by oauth_2_0

HTTP status code 200

The Licences for the Sports Federation

Body

Media type: application/json

Type: object

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

HTTP status code 200

The User Insurances for the Sports Federation.

Body

Media type: application/json

Type: object

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

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

• 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

  • 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

HTTP status code 200

The events containing the specified search string.

Body

Media type: application/json

Type: object

• 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.

  • registrationStartDateTime: required(datetime-only)

    The date and time at which event registration 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.

  • registrationEndDateTime: required(datetime-only)

    The date and time at which event registration 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

  • imageUrl: required(string)

    URL pointing to the image of the event.

  • 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

  • productDiscounts: required(array of event.ProductDiscount)

    Event's product discounts. An event has zero or more possible product discounts which define an alternative price for the event.

    Items: ProductDiscount

    • id: required(integer)

      The Suomisport id of the product discount

    • discountType: required(one of PUBLIC, PRICE_STEP)

      The type of the discount. The valid values are:

      • PUBLIC (jakso alennetulla hinnalla) - Discount is public and everybody will get it automatically when purchasing the product within the validity period.
      • PRICE_STEP (hintavalinta) - Discount is provided based on a selection made by the user from a pre-defined list of price steps.

      Discounts of type CODE (alennuskoodi) are not returned from the API.

    • name: required(string)

      Name of the product discount

    • description: (string)

      Description of the product discount

    • priceInCents: required(integer)

      The final price in cents of the product after discount

    • validityPeriod: (object)

      Validity period of the discount. Defined only if discountType is PUBLIC.

      • start: required(datetime)

        Start timestamp of the validity period

      • end: required(datetime)

        End timestamp of the validity period

  • 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

  • tags: (array of event.TagString)

    Event tags. An event has zero or more tags. A tag is a simple string.

    Example:

    [
      "Erotuomari",
      "Koulutus"
    ]

  • purpose: (string)

    Contains the function or the purpose of the event

    • SPORTS - Sports event (Liikuntatapahtuma)
    • EDUCATION - Educational event (Koulutustapahtuma)
    • ORGANIZATIONAL - Organizational event (Jarjestotapahtuma)
    • OTHER - Other (Muu tapahtuma)
    • PROMOTION - Promotional event (Yleisotapahtuma)
  • 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

    • modificationTime: required(datetime)

      Last modification time of the User data

    • deletionTime: (datetime)

      Time the User data was deleted

    • 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

    • birthDate: (date-only)

      Date of birth

    • 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)
    • marketingPermission: (boolean)

      True if the user has allowed 3rd party marketing messages, false otherwise.

    • 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).

    • 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

    • deceasedDate: (date-only)

      The deceased date

    • 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_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

    • isAuthenticatedWithPassword: required(boolean)

      Is current user authenticated with password.

    • isEventInstructor: required(boolean)

      Is current user an instructor in any event.

• 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