NameDescriptionTypeAdditional information
SportIds

The persons in the result must have a connection to at least any of the provided SportIds.
Should contain Id for one main sport or one or more subsports.

Collection of integer

Required
Since

If set, the result will contain changes from this time and later only. If a person is added or changed, or any of the persons' following entities are changed

  • Address
  • Contacts
  • Licenses
  • Roles
  • RoleAttributes
then the service will treat the person as changed.

If not set, the result will contain the current information available.

Persons in organisations that no longer have any connection to any of the SportIds, will not be returned.

date

None.
OrganisationIds

The ids of the top level organisations to get persons for. If parameter IncludeUnderlyingOrganisations is set to true, then the response will also include persons for underlying organisations. I.e. if you provide an OrganisationId for an SF, you will also get persons from Regions, SDFs, SubSports (Gren/Klass) and Clubs, if parameter IncludeUnderlyingOrganisations is set to true.

Collection of integer

None.
IncludeUnderlyingOrganisations

Set to false to not include persons from underlying organisations in the result.

boolean

Default value: true
OrganisationTypeIds

Used to restrict the results to only include persons connected with organisations of a type in the provided OrganisationTypeIds.

Collection of integer

Default value: All
PersonIds

if PersonIds is specified, then only persons in PersonIds will be returned. These persons still needs to fulfill all other parameters.

Collection of integer

None.
IncludeTrialPersons

a flag to indicate if trial person be included in result. To be compatible with old request contract, the default value is 'true' when this property is missing from the request.

boolean

Default value: true
IncludeFullPersonalNumber

Bool value to indicate if the personal number is included in the result.

boolean

Default value: false
ReturnRoles

Set to true to include roles in the response.

boolean

Default value: true
SearchRoles

Set to true to search for changes in roles. Only applicable when Since date is set.

boolean

Default value: true
ReturnRoleAttributes

Set to true to include role attributes in the response

boolean

Default value: true
SearchRoleAttributes

Set to true to search for changes in role attributes. Only applicable when Since date is set.

boolean

Default value: true
ReturnContacts

Set to true to include contacts in the response.

boolean

Default value: true
SearchContacts

Set to true to search for changes in contacts. Only applicable when Since date is set.

boolean

Default value: true
ReturnAddresses

Set to true to include addresses in the response.

boolean

Default value: true
SearchAddresses

Set to true to search for changes in addresses. Only applicable when Since date is set.

boolean

Default value: true
ReturnLicenses

Set to true to include licenses in the response

boolean

Default value: true
SearchLicenses

Set to true to search for changes in licenses. Only applicable when Since date is set.

boolean

Default value: true