GET api/Sector?sessionId={sessionId}&name={name}&comparison={comparison}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all sectors matching name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

name

string

Required

comparison

string

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

includeClosed

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of APISector
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

SectorGroupId

Unique identifier of sector group to which this belongs

integer

None.

CTRGroupId

Unique identifier of ctr group to which this relates

integer

None.

State

Status: Active, Closed or Suspended

string

None.

Number

Numeric identifier

integer

None.

Name

Textual identifier

string

None.

IABCategory

IAB category identifier

string

None.

PricingPerImpression

Allow charging based upon CPM model

boolean

None.

MinimumImpressionPrice

Minimum impression price for adverts

decimal number

None.

MaximumImpressionPrice

Maximum impression price for adverts

decimal number

None.

PricingPerClick

Allow charging based upon CPC model

boolean

None.

MinimumClickPrice

Minimum click price for adverts

decimal number

None.

MaximumClickPrice

Maximum click price for adverts

decimal number

None.

NumberOfImpressions

Number of impressions required to determine performance information

integer

None.

NumberOfClicks

Number of clicks required to determine performance information

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "sectorGroupId": 2,
    "ctrGroupId": 1,
    "state": "sample string 3",
    "number": 1,
    "name": "sample string 4",
    "iabCategory": "sample string 5",
    "pricingPerImpression": true,
    "minimumImpressionPrice": 1.1,
    "maximumImpressionPrice": 1.1,
    "pricingPerClick": true,
    "minimumClickPrice": 1.1,
    "maximumClickPrice": 1.1,
    "numberOfImpressions": 1,
    "numberOfClicks": 1
  },
  {
    "id": 1,
    "sectorGroupId": 2,
    "ctrGroupId": 1,
    "state": "sample string 3",
    "number": 1,
    "name": "sample string 4",
    "iabCategory": "sample string 5",
    "pricingPerImpression": true,
    "minimumImpressionPrice": 1.1,
    "maximumImpressionPrice": 1.1,
    "pricingPerClick": true,
    "minimumClickPrice": 1.1,
    "maximumClickPrice": 1.1,
    "numberOfImpressions": 1,
    "numberOfClicks": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPISector xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APISector>
    <CTRGroupId>1</CTRGroupId>
    <IABCategory>sample string 5</IABCategory>
    <Id>1</Id>
    <MaximumClickPrice>1.1</MaximumClickPrice>
    <MaximumImpressionPrice>1.1</MaximumImpressionPrice>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <Name>sample string 4</Name>
    <Number>1</Number>
    <NumberOfClicks>1</NumberOfClicks>
    <NumberOfImpressions>1</NumberOfImpressions>
    <PricingPerClick>true</PricingPerClick>
    <PricingPerImpression>true</PricingPerImpression>
    <SectorGroupId>2</SectorGroupId>
    <State>sample string 3</State>
  </APISector>
  <APISector>
    <CTRGroupId>1</CTRGroupId>
    <IABCategory>sample string 5</IABCategory>
    <Id>1</Id>
    <MaximumClickPrice>1.1</MaximumClickPrice>
    <MaximumImpressionPrice>1.1</MaximumImpressionPrice>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <Name>sample string 4</Name>
    <Number>1</Number>
    <NumberOfClicks>1</NumberOfClicks>
    <NumberOfImpressions>1</NumberOfImpressions>
    <PricingPerClick>true</PricingPerClick>
    <PricingPerImpression>true</PricingPerImpression>
    <SectorGroupId>2</SectorGroupId>
    <State>sample string 3</State>
  </APISector>
</ArrayOfAPISector>