POST exportservice/education/events/search
Search for events
Request Information
Request URL
https://api.idrottonline.se/exportservice/education/events/searchURI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
x-svenskidrott-api-version |
The requested API version |
string |
Default value is 1.0 |
api-version |
The requested API version |
string |
Default value is 1.0 |
Body Parameters
The request with search criteria
ExportService.DataContracts.Request.SearchEventsRequestName | Description | Type | Additional information |
---|---|---|---|
OrganiserId |
The organiser ("anordnare" in Swedish) of the event. Typically an SDF or a SISU district. |
integer |
None. |
OrganisationId |
The organisation ("arrangör" in Swedish) of the event. Typically a club but could also be a district organisation. |
integer |
None. |
FromDate |
Include events from within this date. |
date |
None. |
ToDate |
Include events to within this date. |
date |
None. |
OperationYear |
The operation year of the event. |
integer |
None. |
StudyPlanId |
The id of the studyplan. |
integer |
None. |
IncludeEventsFromUnderlyingOrganisations |
Include events from underlying organisations (from the organiser id). At the moment there is only support for underlying SDFs if the organiser is an SF. |
boolean |
None. |
Request Formats
application/json, text/json
{ "OrganiserId": 123, "OrganisationId": 123, "FromDate": "2025-06-04T00:00:00", "ToDate": "2025-07-02T00:00:00", "OperationYear": 2025, "StudyPlanId": 567, "IncludeEventsFromUnderlyingOrganisations": true }
Response Information
Resource Description
A list of events
Collection of ExportService.DataContracts.Education.EventName | Description | Type | Additional information |
---|---|---|---|
Id |
A unique identifier of the event. |
integer |
None. |
StudyPlanId |
The id of the study plan |
integer |
None. |
Name |
The name of the event |
string |
None. |
Description |
The description of the event |
string |
None. |
StartTime |
Start time for the the first occurrence of the event. |
date |
None. |
EndTime |
End time for the the last occurrence of the event. |
date |
None. |
OrganiserId |
The organiser ("anordnare" in Swedish) of the event. Typically an SDF or a SISU district. |
integer |
None. |
OrganisationId |
The organisation ("arrangör" in Swedish) of the event. Typically a club but could also be a district organisation. |
integer |
None. |
State |
The state of the event. Typically "Planerad", "Startad" or "Slutrapporterad". |
ExportService.DataContracts.Education.EventState |
None. |
Location |
The location of the event |
string |
None. |
Response Formats
application/json, text/json
[ { "Id": 23411, "StudyPlanId": 123, "Name": "Träningslära A", "Description": "Grundkurs i träningslära. Inga speciella förkunskaper krävs.", "StartTime": "2016-01-01T00:00:00", "EndTime": "2016-02-15T00:00:00", "OrganiserId": 43234, "OrganisationId": 21345, "State": { "Id": "b3226608-6f50-4ecb-ab69-00b0cb0b86c5", "Name": "Planerad" }, "Location": "Sportcentralen, Jönköping" }, { "Id": 23432, "StudyPlanId": 123, "Name": "Träningslära B", "Description": "Grundkurs i träningslära. Inga speciella förkunskaper krävs.", "StartTime": "2016-01-01T00:00:00", "EndTime": "2016-02-15T00:00:00", "OrganiserId": 43234, "OrganisationId": 21345, "State": { "Id": "b3226608-6f50-4ecb-ab69-00b0cb0b86c5", "Name": "Planerad" }, "Location": "Sportcentralen, Jönköping" } ]