POST api/sectors/search

Retrieves a list of sectors that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter sectors by.

Name	Type	Additional information
Id	integer	None.
Name	string	None.
Names	Collection of string	None.
Radius	decimal number	None.
FamilyType	FamilyTypeDto	None.
IncomeBracket	IncomeBracketDto	None.
SectorPropertyFilters	Collection of SectorPropertyFilterCriteria	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 1",
  "Names": [
    "sample string 1",
    "sample string 2"
  ],
  "Radius": 1.1,
  "FamilyType": 1,
  "IncomeBracket": 1,
  "SectorPropertyFilters": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<SectorFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models.FilterCriteria">
  <FamilyType>Fledglings</FamilyType>
  <Id>1</Id>
  <IncomeBracket>Low</IncomeBracket>
  <Name>sample string 1</Name>
  <Names xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Names>
  <Radius>1.1</Radius>
  <SectorPropertyFilters>
    <SectorPropertyFilterCriteria>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </SectorPropertyFilterCriteria>
    <SectorPropertyFilterCriteria>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </SectorPropertyFilterCriteria>
  </SectorPropertyFilters>
</SectorFilterCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.