| Name | Description | Type | Additional information |
|---|---|---|---|
| SportIds |
The organisations 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 an organisation is added, changed, removed or any of the organisations' following entities are changed
If not set, the result will contain the current information available. |
date |
None. |
| OrganisationIds |
The ids of the top level organisations to get organisations for. If parameter IncludeUnderlyingOrganisations is set to true, then the response will also include underlying organisations. I.e. if you provide an OrganisationId for an SF, you will also get organisations of type 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 data from underlying organisations in the result. |
boolean |
Default value: true |
| OrganisationTypeIds |
Used to restrict the results to only include organisations of a type in the provided OrganisationTypeIds. |
Collection of integer |
Default value: All |
| ReturnOpeningHours |
Set to true to include opening hours in the response. |
boolean |
Default value: true |
| SearchOpeningHours |
Set to true to search for changes in opening hours. Only applicable when Since date is set. |
boolean |
Default value: true |
| ReturnAccounts |
Set to true to include accounts in the response. |
boolean |
Default value: true |
| SearchAccounts |
Set to true to search for changes in accounts. Only applicable when Since date is set. |
boolean |
Default value: true |
| ReturnPersons |
Set to true to include persons in the response. |
boolean |
Default value: true |
| SearchPersons |
Set to true to search for changes in persons. 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 |
| 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 |
| ReturnParentBelongings |
Set to true to include parent belongings in the response. |
boolean |
Default value: true |
| SearchParentBelongings |
Set to true to search for changes in parent belongings. Only applicable when Since date is set. |
boolean |
Default value: true |