Function

This API is used to update a beacon attribute.

Scenario

This API is called to update a beacon attribute.

Prototype

For details about how to obtain the domain name and projectID, please refer to API Call Process.

Restrictions

• You need to obtain the service account credential. For details, please refer to Service Account-based Authentication.

• The beacon must be in activated state.

Input Parameters

Output Parameters

If the request is successful, status code 200 is returned without a response body.

If the request fails, a status code other than 200 is returned with the following response body:

(1) A non-service request fails due to an exception (for example, the gateway verification fails or the token expires).

(2) A service request fails.

The JSON structure of serviceError is as follows.

Result Code

Example

Use an expired Authorization parameter to call the API. An error response body is returned.

Request:

复制
PUT /WiseCloudNearbyBeaconService/v1/updateBeaconInfo?projectId=id123 HTTP/1.1
PUT data: {"beacon":{"beaconId":"aa123","beaconType":1,"beaconDesc":"iBeacon_73548ada","latitude":90.0,"longitude":180.0,"indoorLevel":"0","properties":"{\"key1\":\"value1\",\"key2\":\"value2\"}"}}
Host: Domain name.
Content-Type: application/json
srcTranId: 201910181908046224775031
timeStamp: 922337203685477580
Accept: application/json
Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx

Response:

复制
HTTP/1.1 401 Unauthorized
Content-type: application/json
content-length: 27
{"error":"session timeout"}

The request fails, and an error response body is returned, for example, the attribute of a deactivated beacon is updated.

Request:

复制
PUT /WiseCloudNearbyBeaconService/v1/updateBeaconInfo?projectId=id123 HTTP/1.1
PUT data: {"beacon":{"beaconId":"aabb123","beaconType":1,"beaconDesc":"iBeacon_test","latitude":81.0,"longitude":180.0,"indoorLevel":"0","properties":"{\"key1\":\"value1\",\"key2\":\"value2\"}"}}
Host: Domain name.
Content-Type: application/json
srcTranId: 201910181908046224775031
timeStamp: 922337203685477580
Accept: application/json
Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx

Response:

复制
HTTP/1.1 400 Bad Request
Content-type: application/json
content-length: 96
{"serviceError":{"code":400000009,"message":"The beacon is not active.","status":"Bad Request"}}

The request is successful, and a success response body is returned.

Request:

复制
PUT /WiseCloudNearbyBeaconService/v1/updateBeaconInfo?projectId=id123 HTTP/1.1
PUT data: {"beacon":{"beaconId":"aabb124","beaconType":1,"beaconDesc":"iBeacon_test","latitude":81.0,"longitude":180.0,"indoorLevel":"0","properties":"{\"key1\":\"value1\",\"key2\":\"value2\"}"}}
Host: Domain name.
Content-Type: application/json
srcTranId: 201910181908046224775031
timeStamp: 922337203685477580
Accept: application/json
Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx

Response:

复制
HTTP/1.1 200 OK
Content-type: application/json
content-length: 0