GET Areas/{dataSource}/{partnerName}

Get a list of all areas including higher level areagroups

Request Information

URI Parameters

Name	Description	Type	Additional information
dataSource		DataSourceEnum	Required
partnerName		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Area

Name	Description	Type	Additional information
dataSource		DataSourceEnum	None.
areaId		string	None.
areaIdParrent	Empty if this area is not a part of an bigger area	string	None.
areaLevel		AreaLevel	None.
sortOrderThisLevel	sortOrderThisLevel will not be delivered from all datasources	decimal number	None.
areaName		string	None.
areaNameParrent		string	None.
areaDescription		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "dataSource": 0,
    "areaId": "sample string 1",
    "areaIdParrent": "sample string 2",
    "areaLevel": 1,
    "sortOrderThisLevel": 1.1,
    "areaName": "sample string 3",
    "areaNameParrent": "sample string 4",
    "areaDescription": "sample string 5"
  },
  {
    "dataSource": 0,
    "areaId": "sample string 1",
    "areaIdParrent": "sample string 2",
    "areaLevel": 1,
    "sortOrderThisLevel": 1.1,
    "areaName": "sample string 3",
    "areaNameParrent": "sample string 4",
    "areaDescription": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HeimModel">
  <Area>
    <areaDescription>sample string 5</areaDescription>
    <areaId>sample string 1</areaId>
    <areaIdParrent>sample string 2</areaIdParrent>
    <areaLevel>LevelAreaGroup</areaLevel>
    <areaName>sample string 3</areaName>
    <areaNameParrent>sample string 4</areaNameParrent>
    <dataSource>Unknown</dataSource>
    <sortOrderThisLevel>1.1</sortOrderThisLevel>
  </Area>
  <Area>
    <areaDescription>sample string 5</areaDescription>
    <areaId>sample string 1</areaId>
    <areaIdParrent>sample string 2</areaIdParrent>
    <areaLevel>LevelAreaGroup</areaLevel>
    <areaName>sample string 3</areaName>
    <areaNameParrent>sample string 4</areaNameParrent>
    <dataSource>Unknown</dataSource>
    <sortOrderThisLevel>1.1</sortOrderThisLevel>
  </Area>
</ArrayOfArea>