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

Gets all sector groups 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 APISectorGroup
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

NetworkId

Unique identifier of network to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

Name

Textual 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.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "networkId": 1,
    "state": "sample string 2",
    "name": "sample string 3",
    "pricingPerImpression": true,
    "minimumImpressionPrice": 1.1,
    "maximumImpressionPrice": 1.1,
    "pricingPerClick": true,
    "minimumClickPrice": 1.1,
    "maximumClickPrice": 1.1
  },
  {
    "id": 1,
    "networkId": 1,
    "state": "sample string 2",
    "name": "sample string 3",
    "pricingPerImpression": true,
    "minimumImpressionPrice": 1.1,
    "maximumImpressionPrice": 1.1,
    "pricingPerClick": true,
    "minimumClickPrice": 1.1,
    "maximumClickPrice": 1.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPISectorGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APISectorGroup>
    <Id>1</Id>
    <MaximumClickPrice>1.1</MaximumClickPrice>
    <MaximumImpressionPrice>1.1</MaximumImpressionPrice>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <Name>sample string 3</Name>
    <NetworkId>1</NetworkId>
    <PricingPerClick>true</PricingPerClick>
    <PricingPerImpression>true</PricingPerImpression>
    <State>sample string 2</State>
  </APISectorGroup>
  <APISectorGroup>
    <Id>1</Id>
    <MaximumClickPrice>1.1</MaximumClickPrice>
    <MaximumImpressionPrice>1.1</MaximumImpressionPrice>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <Name>sample string 3</Name>
    <NetworkId>1</NetworkId>
    <PricingPerClick>true</PricingPerClick>
    <PricingPerImpression>true</PricingPerImpression>
    <State>sample string 2</State>
  </APISectorGroup>
</ArrayOfAPISectorGroup>