POST api/Beacon?systemName={systemName}&username={username}&password={password}

Creates a new beacon

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

Body Parameters

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.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>