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.
Request Information
Request URL
https://api.idrottonline.se/exportservice/personsinsportURI 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
ExportService.DataContracts.Request.CreatePersonsInSportRequestName | Description | Type | Additional information |
---|---|---|---|
SportIds |
The persons in the result must have a connection to at least any of the provided SportIds.
|
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
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 |
Request Formats
application/json, text/json
{ "SportIds": [ 10 ], "Since": "2025-07-03T13:29:24", "OrganisationIds": [ 1, 2, 3 ], "IncludeUnderlyingOrganisations": true, "OrganisationTypeIds": [], "PersonIds": [ 123, 124, 125 ], "IncludeTrialPersons": null, "IncludeFullPersonalNumber": false, "ReturnRoles": true, "SearchRoles": true, "ReturnRoleAttributes": true, "SearchRoleAttributes": true, "ReturnContacts": true, "SearchContacts": true, "ReturnAddresses": true, "SearchAddresses": true, "ReturnLicenses": true, "SearchLicenses": true }
Response Information
Resource Description
A list of persons with associated properties
Collection of ExportService.DataContracts.PersonName | Description | Type | Additional information |
---|---|---|---|
PersonalNumber |
Swedish personal number in format yyyyMMdd####. |
string |
None. |
IsDeleted |
Indicates if this record is a oblished one. |
boolean |
None. |
DeleteDate |
If the person is not deleted the value is set to null |
date |
None. |
IsDead |
indicates if the person is passed away. |
boolean |
None. |
DeathDate |
If the person is not dead the value is set to null |
date |
None. |
Roles |
The roles held by the person, except the member one(s). |
Collection of ExportService.DataContracts.ActiveRole |
None. |
Memberships |
The member roles held by the person. |
Collection of ExportService.DataContracts.Membership |
None. |
Licenses |
The licenses issued to this person. |
Collection of ExportService.DataContracts.License.License |
None. |
Consensus |
The consensus. |
Collection of ExportService.DataContracts.Consensus |
None. |
PersonId |
The IAS id |
integer |
None. |
FirstName |
The person's firstname |
string |
None. |
LastName |
The person's lastname |
string |
None. |
AlternativeFirstName |
The person's alternative first name |
string |
None. |
BirthDate |
Date of birth |
string |
None. |
ProtectedPersonalData |
If set to true, the person has protected personal data |
boolean |
None. |
GenderId |
Use Helper operation to fetch possible values. |
integer |
None. |
NationalityId |
Use Regions operation to fetch possible values |
integer |
None. |
NationalityName |
The name of the nationality |
string |
None. |
Addresses |
The addresses owned by this person. |
Collection of ExportService.DataContracts.PersonAddress |
None. |
Contacts |
The contacts owned by this person. |
Collection of ExportService.DataContracts.PersonContact |
None. |
ChangeTracking |
The change tracking of this person himself/herself. |
ExportService.DataContracts.ChangeTracking |
None. |
Response Formats
application/json, text/json
[ { "PersonalNumber": "20010101xxxx", "IsDeleted": false, "DeleteDate": null, "IsDead": false, "DeathDate": null, "Roles": [ { "OrganisationId": 456, "OrganisationTypeId": 5, "SportId": 6, "AttributeValues": [ { "Name": "Name of role attribute", "Value": "TRUE", "ValueType": "Boolean", "IsPassive": false, "ChangeTracking": { "FADateTime": "2012-10-10T10:10:00", "FAAppId": 0, "LCDateTime": "2015-10-11T20:20:00", "LCAppId": 0 } } ], "RoleId": 4, "RoleType": { "RoleTypeId": 3, "RoleTypeName": "Name of roleType", "RoleTypeCategoryId": 2, "RoleTypeOwnerOrganisationId": 0 }, "IsPassive": false, "IsDeleted": false, "ChangeTracking": { "FADateTime": "2012-10-10T10:10:00", "FAAppId": 0, "LCDateTime": "2015-10-11T20:20:00", "LCAppId": 0 } } ], "Memberships": [ { "OrganisationId": 456, "MemberRoleId": 2, "MembershipNumber": "456-789", "MemberSince": "2015-05-05T00:00:00", "MemberUntil": "2017-05-05T00:00:00", "MemberRoleIsApproved": true, "ChangeTracking": { "FADateTime": "2012-10-10T10:10:00", "FAAppId": 0, "LCDateTime": "2015-10-11T20:20:00", "LCAppId": 0 }, "LifeMember": false } ], "Licenses": [ { "LicenseId": "00000000-0000-0000-0000-000000000000", "LicenseNumber": "123456456", "LicenseTypeId": "00000000-0000-0000-0000-000000000000", "LicenseTypeName": null, "PeriodId": "00000000-0000-0000-0000-000000000000", "PeriodStartTime": null, "PeriodEndTime": null, "PeriodType": 0, "IsPassive": false, "IsTerminated": true, "IsExpired": true, "IsPaid": true, "IsApproved": true, "IsDeleted": false, "LicenseCategorisations": null, "ApproveDate": "2015-06-08T00:00:00", "PaidFeeDate": null, "ApplyDate": "2015-06-06T00:00:00", "DeletedDate": null, "OrganisationId": 456, "LastChangedDate": null, "FreeText": null } ], "Consensus": null, "PersonId": 123, "FirstName": "Karl", "LastName": "Karlsson", "AlternativeFirstName": "Kalle", "BirthDate": "2001-01-01", "ProtectedPersonalData": false, "GenderId": 1, "NationalityId": 182, "NationalityName": "Sverige", "Addresses": [ { "PublishRule": { "PublishRuleTypeId": 2, "VisibleForOrganisationIds": null }, "AddressId": 78945, "AddressTypeId": 1, "Line1": "Stora gatan 4", "Line2": "", "PostalNumber": 11111, "PostalCity": "Stockholm", "NonSwedishPostalNumber": null, "CountryId": 182, "CountryName": "Sverige", "IsDefault": true, "IsDeleted": false, "ChangeTracking": { "FADateTime": "2012-10-10T10:10:00", "FAAppId": 0, "LCDateTime": "2015-10-11T20:20:00", "LCAppId": 0 } } ], "Contacts": [ { "PublishRule": { "PublishRuleTypeId": 2, "VisibleForOrganisationIds": null }, "ContactId": 789, "ContactTypeId": 1, "ContactInfo": "email@email.se", "IsDeleted": false, "ChangeTracking": { "FADateTime": "2012-10-10T10:10:00", "FAAppId": 0, "LCDateTime": "2015-10-11T20:20:00", "LCAppId": 0 } } ], "ChangeTracking": { "FADateTime": "2012-10-10T10:10:00", "FAAppId": 0, "LCDateTime": "2015-10-11T20:20:00", "LCAppId": 0 } } ]