POST areas/getsuburb

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SearchID	integer	None.
UserName	string	None.
TenantId	integer	None.
StreetName	string	None.
SuburbId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SearchID": 1,
  "UserName": "sample string 2",
  "TenantId": 3,
  "StreetName": "sample string 4",
  "SuburbId": 5
}

text/html

Sample:

{"SearchID":1,"UserName":"sample string 2","TenantId":3,"StreetName":"sample string 4","SuburbId":5}

application/xml, text/xml

Sample:

<SearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.ListenerWebAPI.Models">
  <SearchID>1</SearchID>
  <StreetName>sample string 4</StreetName>
  <SuburbId>5</SuburbId>
  <TenantId>3</TenantId>
  <UserName>sample string 2</UserName>
</SearchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SearchModel'.

Response Information

Resource Description

Collection of AreasEntity

Name	Type	Additional information
AreaID	integer	None.
DivisionID	integer	None.
AreaName	string	Required String length: inclusive between 0 and 15
AreaType	integer	Required
ParentID	integer	None.
Active	integer	None.
TenantID	integer	None.
PricelistId	integer	None.
TravelTime	integer	None.
isDefault	boolean	None.
AreaDesc	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AreaID": 1,
    "DivisionID": 1,
    "AreaName": "sample string 2",
    "AreaType": 3,
    "ParentID": 4,
    "Active": 5,
    "TenantID": 6,
    "PricelistId": 1,
    "TravelTime": 1,
    "isDefault": true,
    "AreaDesc": "sample string 8"
  },
  {
    "AreaID": 1,
    "DivisionID": 1,
    "AreaName": "sample string 2",
    "AreaType": 3,
    "ParentID": 4,
    "Active": 5,
    "TenantID": 6,
    "PricelistId": 1,
    "TravelTime": 1,
    "isDefault": true,
    "AreaDesc": "sample string 8"
  }
]

text/html

Sample:

[{"AreaID":1,"DivisionID":1,"AreaName":"sample string 2","AreaType":3,"ParentID":4,"Active":5,"TenantID":6,"PricelistId":1,"TravelTime":1,"isDefault":true,"AreaDesc":"sample string 8"},{"AreaID":1,"DivisionID":1,"AreaName":"sample string 2","AreaType":3,"ParentID":4,"Active":5,"TenantID":6,"PricelistId":1,"TravelTime":1,"isDefault":true,"AreaDesc":"sample string 8"}]

application/xml, text/xml

Sample:

<ArrayOfAreasEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Areas">
  <AreasEntity>
    <Active>5</Active>
    <AreaDesc>sample string 8</AreaDesc>
    <AreaID>1</AreaID>
    <AreaName>sample string 2</AreaName>
    <AreaType>3</AreaType>
    <DivisionID>1</DivisionID>
    <ParentID>4</ParentID>
    <PricelistId>1</PricelistId>
    <TenantID>6</TenantID>
    <TravelTime>1</TravelTime>
    <isDefault>true</isDefault>
  </AreasEntity>
  <AreasEntity>
    <Active>5</Active>
    <AreaDesc>sample string 8</AreaDesc>
    <AreaID>1</AreaID>
    <AreaName>sample string 2</AreaName>
    <AreaType>3</AreaType>
    <DivisionID>1</DivisionID>
    <ParentID>4</ParentID>
    <PricelistId>1</PricelistId>
    <TenantID>6</TenantID>
    <TravelTime>1</TravelTime>
    <isDefault>true</isDefault>
  </AreasEntity>
</ArrayOfAreasEntity>