Config ble beacon profile

post

https://{api-base-url}/cfg_beacon_profiles/{group_name}

Config Ble Beacon Profile

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

group_name

string

required

the name of configured group

Query Params

profile_name

string

required

config ble beacon profile name

config_method

string

enum

required

Defaults to auto_generate

ble beacon profile method. Openlocate advertisement beacon only support auto_generate.

Allowed:

adv_format

string

enum

ble advertise beacon format

Allowed:

radio_instance

string

enum

required

apply the profile ble radio instance

Allowed:

interval

integer

ble beacon advertisement interval, in ms. increment in multiples of 100 and range is 100-30000

major_start

integer

ibeacon config, range is 0-65535

major_end

integer

ibeacon config, range is 0-65535

minor_start

integer

ibeacon config, range is 0-65535

minor_end

integer

ibeacon config, range is 0-65535

UUID

string

ibeacon config

payload

string

custom beacon config, length is 3-31 bytes and each bytes include 2 ASCII characters

Body Params

the detail for beacon advertisement. by adv_format value to config deatil payload.

openlocate

object

Responses

200

Successful response

401

Unauthorized

403

Forbidden

429

API Rate limit exceeded

default

Unexpected error

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

404Not found

500Internal server error