GET api/Beacon?sessionId={sessionId}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all beacons

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

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 APIBeacon
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

State

Status: Active, Closed or Suspended

string

None.

Name

Textual identifier

string

None.

Duration

Lifetime in seconds

integer

None.

ImpressionLimit

Limit of impressions

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "state": "sample string 2",
    "name": "sample string 3",
    "duration": 1,
    "impressionLimit": 1
  },
  {
    "id": 1,
    "state": "sample string 2",
    "name": "sample string 3",
    "duration": 1,
    "impressionLimit": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIBeacon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIBeacon>
    <Duration>1</Duration>
    <Id>1</Id>
    <ImpressionLimit>1</ImpressionLimit>
    <Name>sample string 3</Name>
    <State>sample string 2</State>
  </APIBeacon>
  <APIBeacon>
    <Duration>1</Duration>
    <Id>1</Id>
    <ImpressionLimit>1</ImpressionLimit>
    <Name>sample string 3</Name>
    <State>sample string 2</State>
  </APIBeacon>
</ArrayOfAPIBeacon>