Beacons

Returns a list of Beacons for specified tenant

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Responses

200

OK

BeaconIdstring · nullableOptional

Unique string that identifies the beacon

Namestring · min: 1Required

A string with name

Typestring · min: 1Required

A string with Type (Valid types are iBeacon and Eddystone)

Uuidstring · min: 1Required

A string with UUID

MajorRevisioninteger · int32Required

A integer with Major Revision

MinorRevisioninteger · int32Required

A integer with Minor Revision

Rangeinteger · int32 · nullableOptional

Range in meters

Colorstring · nullableOptional

Color of Beacon (Supported colors are orange, black, green, blue, red, purple)

MinZoominteger · int32Optional

Minimum Zoom when Beacon is shown

VisibleInSubTenantsbooleanOptional

If true, Beacon is visible to users in sub-tenants.

get/V2/{tenantVarCode}/beacons

GET /V2/{tenantVarCode}/beacons HTTP/1.1
Accept: */*

200

OK

[
  {
    "BeaconId": "text",
    "Name": "text",
    "Type": "text",
    "Uuid": "text",
    "MajorRevision": 1,
    "MinorRevision": 1,
    "Range": 1,
    "Color": "text",
    "Position": {
      "Lat": 1,
      "Lon": 1
    },
    "MinZoom": 1,
    "VisibleInSubTenants": true
  }
]

Creates a new Beacon

post

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Body

BeaconIdstring · nullableOptional

Unique string that identifies the beacon

Namestring · min: 1Required

A string with name

Typestring · min: 1Required

A string with Type (Valid types are iBeacon and Eddystone)

Uuidstring · min: 1Required

A string with UUID

MajorRevisioninteger · int32Required

A integer with Major Revision

MinorRevisioninteger · int32Required

A integer with Minor Revision

Rangeinteger · int32 · nullableOptional

Range in meters

Colorstring · nullableOptional

Color of Beacon (Supported colors are orange, black, green, blue, red, purple)

MinZoominteger · int32Optional

Minimum Zoom when Beacon is shown

VisibleInSubTenantsbooleanOptional

If true, Beacon is visible to users in sub-tenants.

Responses

200

OK

No content

post/V2/{tenantVarCode}/beacons

POST /V2/{tenantVarCode}/beacons HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "BeaconId": "text",
  "Name": "text",
  "Type": "text",
  "Uuid": "text",
  "MajorRevision": 1,
  "MinorRevision": 1,
  "Range": 1,
  "Color": "text",
  "Position": {
    "Lat": 1,
    "Lon": 1
  },
  "MinZoom": 1,
  "VisibleInSubTenants": true
}

200

OK

No content

Returns a specific Beacon

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

beaconIdstringRequired

Beacon Id

Responses

200

OK

BeaconIdstring · nullableOptional

Unique string that identifies the beacon

Namestring · min: 1Required

A string with name

Typestring · min: 1Required

A string with Type (Valid types are iBeacon and Eddystone)

Uuidstring · min: 1Required

A string with UUID

MajorRevisioninteger · int32Required

A integer with Major Revision

MinorRevisioninteger · int32Required

A integer with Minor Revision

Rangeinteger · int32 · nullableOptional

Range in meters

Colorstring · nullableOptional

Color of Beacon (Supported colors are orange, black, green, blue, red, purple)

MinZoominteger · int32Optional

Minimum Zoom when Beacon is shown

VisibleInSubTenantsbooleanOptional

If true, Beacon is visible to users in sub-tenants.

get/V2/{tenantVarCode}/beacons/{beaconId}

GET /V2/{tenantVarCode}/beacons/{beaconId} HTTP/1.1
Accept: */*

200

OK

{
  "BeaconId": "text",
  "Name": "text",
  "Type": "text",
  "Uuid": "text",
  "MajorRevision": 1,
  "MinorRevision": 1,
  "Range": 1,
  "Color": "text",
  "Position": {
    "Lat": 1,
    "Lon": 1
  },
  "MinZoom": 1,
  "VisibleInSubTenants": true
}

Updates an existing Beacon

put

Path parameters

tenantVarCodestringRequired

Tenant Var Code

beaconIdstringRequired

Beacon Id

Body

BeaconIdstring · nullableOptional

Unique string that identifies the beacon

Namestring · min: 1Required

A string with name

Typestring · min: 1Required

A string with Type (Valid types are iBeacon and Eddystone)

Uuidstring · min: 1Required

A string with UUID

MajorRevisioninteger · int32Required

A integer with Major Revision

MinorRevisioninteger · int32Required

A integer with Minor Revision

Rangeinteger · int32 · nullableOptional

Range in meters

Colorstring · nullableOptional

Color of Beacon (Supported colors are orange, black, green, blue, red, purple)

MinZoominteger · int32Optional

Minimum Zoom when Beacon is shown

VisibleInSubTenantsbooleanOptional

If true, Beacon is visible to users in sub-tenants.

Responses

200

OK

No content

put/V2/{tenantVarCode}/beacons/{beaconId}

PUT /V2/{tenantVarCode}/beacons/{beaconId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "BeaconId": "text",
  "Name": "text",
  "Type": "text",
  "Uuid": "text",
  "MajorRevision": 1,
  "MinorRevision": 1,
  "Range": 1,
  "Color": "text",
  "Position": {
    "Lat": 1,
    "Lon": 1
  },
  "MinZoom": 1,
  "VisibleInSubTenants": true
}

200

OK

No content

Deletes a specific Beacon

delete

Path parameters

tenantVarCodestringRequired

Tenant Var Code

beaconIdstringRequired

Beacon Id

Responses

200

OK

No content

delete/V2/{tenantVarCode}/beacons/{beaconId}

DELETE /V2/{tenantVarCode}/beacons/{beaconId} HTTP/1.1
Accept: */*

200

OK

No content