GET exportservice/regions?regionTypeIds={regionTypeIds}

Returns a list of regions based on region types

Request Information

Request URL

https://api.idrottonline.se/exportservice/regions?regionTypeIds={regionTypeIds}

URI Parameters

NameDescriptionTypeAdditional information
regionTypeIds

A comma separated list of integers. E.g. 1,2,3. Use Helper operation to fetch possible values.

string

Required

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

None.

Response Information

Resource Description

a list of regions

Collection of ExportService.DataContracts.Regions.Region
NameDescriptionTypeAdditional information
RegionId

The id of the region

integer

None.

ParentRegionId

The id of the parent region

integer

None.

RegionTypeId

Type of region. Use Helper operation to fetch possible values.

integer

None.

Code

The region's code or number

string

None.

ShortCode

The region's short code, e.g. "SE"

string

None.

Name

The name of the region

string

None.

DescribingName

The describing name of the region. Used in e.g. extending country information

string

None.

IsActive

If set to false the region does not exist anymore

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "RegionId": 182,
    "ParentRegionId": null,
    "RegionTypeId": 2,
    "Code": "SWE",
    "ShortCode": "SE",
    "Name": "Sverige",
    "DescribingName": "",
    "IsActive": true
  },
  {
    "RegionId": 244,
    "ParentRegionId": 182,
    "RegionTypeId": 4,
    "Code": "01",
    "ShortCode": "01",
    "Name": "Stockholms län",
    "DescribingName": "",
    "IsActive": true
  },
  {
    "RegionId": 16563,
    "ParentRegionId": 182,
    "RegionTypeId": 5,
    "Code": "0126",
    "ShortCode": "",
    "Name": "Huddinge",
    "DescribingName": "",
    "IsActive": true
  }
]