Function

This API is used to check whether a beacon has been registered.

Scenario

This API is called to check whether a beacon has been registered.

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.

Input Parameters

Output Parameters

If the request is successful, status code 200 is returned with a response body containing the following parameters.

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:

复制
GET /WiseCloudNearbyBeaconService/v1/beaconRegisterStatus/aa123?projectId=id123 HTTP/1.1
Host: Domain name.
Content-Type: application/json
srcTranId: 20191018190804622477503612345678912345678
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, an incorrect srcTranId parameter is passed.

Request:

复制
GET /WiseCloudNearbyBeaconService/v1/beaconRegisterStatus/aa123?projectId=id123 HTTP/1.1
Host: Domain name.
Content-Type: application/json
srcTranId: 20191018190804622477503612345678912345678
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: 150
{"serviceError":{"code":400000001,"message":"srcTranID: size must be between 0 and 24, srcTranID: must match \"^\\d{1,24}$\"","status":"Bad Request"}}

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

Request:

复制
GET /WiseCloudNearbyBeaconService/v1/beaconRegisterStatus/aa124?projectId=id123 HTTP/1.1
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: 12
{"status":1}