Export Service API documentation

General description

Export Service is replacing the old CompetitionService. The main reason for developing a new service is that CompetitionService is based on old technology and is very slow. The new Export Service is based on a REST API and delivers data in JSON format.

This is a service for external systems to retrieve data from IdrottOnline. The service provides information about persons, organisations, groups, licenses etc.

Export Service is designed to be used by external systems that stores a local copy of data that is needed in the external system. For example personsinsport is typically called once without Since to get all current data. Then personsinsport is called regularly with Since to get changed data in IdrottOnline, to update the local copy of data.

Each external application needs a subscription key. The application will be granted access to information for one or more sports and for one or more organisations. All requests requires the querystring parameter subscription-key, or the header Ocp-Apim-Subscription-Key, with the value of your primary key.

For persons in clubs the service will return only those persons that are active in the specified sport. For persons in organisations of other types, all persons in the organisation will be returned, as long as the organisation belongs to the specified sport. The same applies for groups.

All parameters that are not explicitly marked as Required are optional. All Ids in Export Service are unique identifiers in the system of IdrottOnline. Use helper methods to fetch types that corresponds to the ids. This applies both for input parameters and output fields.

During maintenance work, the service will return a response with HTTP status code 503 Service Unavailable for all service calls.

Report creating methods

When calling report creating methods (GroupsInSport, OrganisationsInSport, PersonsInSport and PersonIdsByPersonalNumbers), the process of returning data is as follows:
If the creation is finished within a given timeout value, you will get a response with HTTP status code 201 Created, including the generated data in the response body.
If the creation is not finished within the given timeout value, you will get a response with HTTP status code 202 Accepted, including a location URI in the header.
Use the location URI to poll for the generated report. If the location URI responds with HTTP status code 202 Accepted, then the processing is still in progress and you should keep polling until you receive a HTTP status code 302 Found with a location URI to the generated data. Use this URI to get the generated data.

The response containing generated data will include a HTTP header value called x-svenskidrott-report-generated-time. This is the time when the request was handled and can be used to determine the Since parameter for upcoming requests.

Main differences between Export Service and CompetitionService:

Delivers data in JSON format instead of XML format.
One method for getting persons instead of RequestPersonsInSportReport and RequestChangedPersonsInSportReport. Similar for organisations and groups.
Requests that are quick to process will be delivered directly. Requests that takes long to process will be stored in a file that can be downloaded.
Possible to get more data from IdrottOnline like persons without full personal number and groups of all types, not only teams.
Possible to retrieve persons from both federations and clubs in one request.
Possible to specify what linked data to return.
When requesting changed data it is possible to specify what linked information to look at.

Documentation for version 1

Educations

Handles data regarding educations.

API	Description
GET exportservice/education/events/{id}	Returns an event by id
GET exportservice/education/studyplans/{id}	Returns a study plan by id
GET exportservice/education/events/{eventId}/participants	Returns a list of participants from an event
POST exportservice/education/events/search	Search for events
POST exportservice/education/studyplans/search	Search for study plans

Groups

Handles data related to groups.

API	Description
GET exportservice/groupsinsport/{reportGuid}	Returns a previously generated list of groups. Use reportGuid returned by POST exportservice/groupsinsport
POST exportservice/groupsinsport	Creates a list of groups within the provided SportIds. See "Report creating methods" under "General description" for how to call this method.

API

Description

GET exportservice/groupsinsport/{reportGuid}

Returns a previously generated list of groups. Use reportGuid returned by POST exportservice/groupsinsport

POST exportservice/groupsinsport

Creates a list of groups within the provided SportIds.

See "Report creating methods" under "General description" for how to call this method.

Helpers

Help methods for getting IAS system data.

API	Description
GET exportservice/genders	Returns available genders
GET exportservice/grouptypes	Returns available group types
GET exportserviceorg/genders	Returns available genders
GET exportservice/regiontypes	Returns available region types
GET exportservice/accounttypes	Returns available account types
GET exportservice/addresstypes	Returns available address types
GET exportservice/contacttypes	Returns available contact types
GET exportserviceorg/grouptypes	Returns available group types
GET exportserviceorg/regiontypes	Returns available region types
GET exportserviceorg/accounttypes	Returns available account types
GET exportserviceorg/addresstypes	Returns available address types
GET exportserviceorg/contacttypes	Returns available contact types
GET exportservice/publishruletypes	Returns available publish rule types
GET exportservice/organisationtypes	Returns available organisation types
GET exportservice/roletypecategories	Returns available roletype categories
GET exportserviceorg/publishruletypes	Returns available publish rule types
GET exportserviceorg/organisationtypes	Returns available organisation types
GET exportserviceorg/roletypecategories	Returns available roletype categories
GET exportservice/roletypeattributetypes	Returns the different attribute types for role types.
GET exportserviceorg/roletypeattributetypes	Returns the different attribute types for role types.
GET exportservice/sports?includeSubsports={includeSubsports}	Returns available sports. A sport can have underlying subsports.
GET exportserviceorg/sports?includeSubsports={includeSubsports}	Returns available sports. A sport can have underlying subsports.
GET exportservice/utils/roletypes?sportId={sportId}&organisationId={organisationId}	Returns roletypes for the given sport and organisation: the role types must be owned by the specified sport's owner SF/Gren/Klass, or the child non-clubs of the specified sport's owner SF/Gren/Klass;the role types must be owned by the given organisation if specified; else the result is only determined by the specified sport.

Organisations

To handle the data related to organisations.

API	Description
GET exportservice/organisationsinsport/{reportGuid}	Returns a previously generated list of organisations. Use reportGuid returned by POST exportservice/organisationsinsport
POST exportservice/organisationsinsport	Creates a list of organisations within the provided SportIds. See "Report creating methods" under "General description" for how to call this method.

API

Description

GET exportservice/organisationsinsport/{reportGuid}

Returns a previously generated list of organisations. Use reportGuid returned by POST exportservice/organisationsinsport

POST exportservice/organisationsinsport

Creates a list of organisations within the provided SportIds.

See "Report creating methods" under "General description" for how to call this method.

Persons

Handles data regarding persons updated.

API	Description
GET exportservice/personsinsport/{reportGuid}	Returns a previously generated list of persons. Use reportGuid returned by POST exportservice/personsinsport
GET exportservice/persons/personidsbypersonalnumbers/{reportGuid}	Returns a previously generated list of person data for provided personal numbers. Use reportGuid returned by POST exportservice/persons/personidsbypersonalnumbers
POST exportservice/personsinsport	Creates a list of persons within the provided SportIds. See "Report creating methods" under "General description" for how to call this method.
POST exportservice/persons/personidsbypersonalnumbers	Returns PersonIds for provided personal numbers See "Report creating methods" under "General description" for how to call this method.

Regions

To handle the data related to regions.

API	Description
GET exportservice/regions?regionTypeIds={regionTypeIds}	Returns a list of regions based on region types
GET exportserviceorg/regions?regionTypeIds={regionTypeIds}	Returns a list of regions based on region types

Reports

Handles saved reports

API	Description
GET exportservice/reports/{reportGuid}	Get data from a long running operation
GET exportserviceorg/reports/{reportGuid}	Get data from a long running operation
GET exportservice/reports/push/{reportGuid}	Pushes the specified report to queue.
GET exportserviceorg/reports/push/{reportGuid}	Pushes the specified report to queue.

Documentation for version 2

Helpers

Help methods for getting IAS system data.

API	Description
GET exportservice/genders	Returns available genders
GET exportservice/grouptypes	Returns available group types
GET exportserviceorg/genders	Returns available genders
GET exportservice/regiontypes	Returns available region types
GET exportservice/accounttypes	Returns available account types
GET exportservice/addresstypes	Returns available address types
GET exportservice/contacttypes	Returns available contact types
GET exportserviceorg/grouptypes	Returns available group types
GET exportserviceorg/regiontypes	Returns available region types
GET exportserviceorg/accounttypes	Returns available account types
GET exportserviceorg/addresstypes	Returns available address types
GET exportserviceorg/contacttypes	Returns available contact types
GET exportservice/publishruletypes	Returns available publish rule types
GET exportservice/organisationtypes	Returns available organisation types
GET exportservice/roletypecategories	Returns available roletype categories
GET exportserviceorg/publishruletypes	Returns available publish rule types
GET exportserviceorg/organisationtypes	Returns available organisation types
GET exportserviceorg/roletypecategories	Returns available roletype categories
GET exportservice/roletypeattributetypes	Returns the different attribute types for role types.
GET exportserviceorg/roletypeattributetypes	Returns the different attribute types for role types.
GET exportservice/sports?includeSubsports={includeSubsports}	Returns available sports. A sport can have underlying subsports.
GET exportserviceorg/sports?includeSubsports={includeSubsports}	Returns available sports. A sport can have underlying subsports.
GET exportservice/utils/roletypes?sportId={sportId}&organisationId={organisationId}	Returns roletypes for the given sport and organisation: the role types must be owned by the specified sport's owner SF/Gren/Klass, or the child non-clubs of the specified sport's owner SF/Gren/Klass;the role types must be owned by the given organisation if specified; else the result is only determined by the specified sport.

Organisations

To handle the data related to organisations.

API	Description
GET exportservice/organisationsinsport/{reportGuid}	Returns a previously generated list of organisations. Use reportGuid returned by POST exportservice/organisationsinsport
POST exportservice/organisationsinsport	Creates a list of organisations within the provided SportIds. See "Report creating methods" under "General description" for how to call this method.

API

Description

GET exportservice/organisationsinsport/{reportGuid}

Returns a previously generated list of organisations. Use reportGuid returned by POST exportservice/organisationsinsport

POST exportservice/organisationsinsport

Creates a list of organisations within the provided SportIds.

See "Report creating methods" under "General description" for how to call this method.

Persons

Handles data regarding persons updated.

API	Description
GET exportservice/personsinsport/{reportGuid}	Returns a previously generated list of persons. Use reportGuid returned by POST exportservice/personsinsport
GET exportservice/persons/personidsbypersonalnumbers/{reportGuid}	Returns a previously generated list of person data for provided personal numbers. Use reportGuid returned by POST exportservice/persons/personidsbypersonalnumbers
POST exportservice/personsinsport	Creates a list of persons within the provided SportIds. See "Report creating methods" under "General description" for how to call this method.
POST exportservice/persons/personidsbypersonalnumbers	Returns PersonIds for provided personal numbers See "Report creating methods" under "General description" for how to call this method.

Regions

To handle the data related to regions.

API	Description
GET exportservice/regions?regionTypeIds={regionTypeIds}	Returns a list of regions based on region types
GET exportserviceorg/regions?regionTypeIds={regionTypeIds}	Returns a list of regions based on region types

Reports

Handles saved reports

API	Description
GET exportservice/reports/{reportGuid}	Get data from a long running operation
GET exportserviceorg/reports/{reportGuid}	Get data from a long running operation
GET exportservice/reports/push/{reportGuid}	Pushes the specified report to queue.
GET exportserviceorg/reports/push/{reportGuid}	Pushes the specified report to queue.