GET beacon/…

Retrieves a specific beacon definition.

Resource URL

https://www.drillster.com/api/2.1.1/beacon/{id}

Parameters

Field	Type	Description
`id` required	String	The ID of the beacon to be retrieved. Example value: `07212ead-8344-4426-8b41-8b0cb621625a_0000_0001`

Response

A 2.1.1 Beacon object containing the definition of the beacon.

Example request

GET https://www.drillster.com/api/2.1.1/beacon/07212ead-8344-4426-8b41-8b0cb621625a_0000_0001

Response

{
  "id": "07212ead-8344-4426-8b41-8b0cb621625a_0000_0001",
  "proximity": "FAR",
  "lingerDuration": "PT5M",
  "description": "iBeacon in main hall",
  "playable": {
    "id": "5x7kjFr2vfbptyUTsTximg",
    "type": "DRILL",
    "name": "17th Century Painters",
    "icon": {
      "type": "image/png",
      "url": "https://www.drillster.com/bin/feature/a17ab8d1cb2bd2fee8c60037995a30b42d837353"
    }
  }
}

Error responses

The following error situations are possible:

ID	Response code	Description
`invalid_id`	400 (Bad request)	Missing or invalid beacon ID
`beacon_not_found`	404 (Not found)	UUID not recognized or beacon definition not found
`invalid_input`	400 (Bad request)	Invalid beacon ID
`playable_not_found`	404 (Not found)	Associated playable not found
`internal_error`	500 (Internal error)	Error loading beacon data

Last updated on 2025-04-18