Function

This API is used to query all configured attachments in a beacon.

Scenario

This API is called to query all configured attachments in a beacon.

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 with a response body containing the following parameters.

Attachment structure definition:

复制
{
"namespace": "namespace002",
"attachmentId": "202001191739115580278122214157680128",
"type": "4",
"value": "5oiR5piv5Lit5Zu95Lq6qw"
}

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:

复制
POST /WiseCloudNearbyBeaconService/v1/queryBeaconAttachment/bea001?projectId=id123 HTTP/1.1
Host: Domain name.
Cache-Control: no-cache
Content-Type: application/json
srcTranId: 201910181908046224775032
timeStamp: 1579423534
Accept: application/json
Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx

Response:

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

The service request fails, and an error response body is returned, for example, the attachment list of a beacon that does not exist is queried.

Request:

复制
POST /WiseCloudNearbyBeaconService/v1/queryBeaconAttachment/bea001?projectId=id123 HTTP/1.1
Host: Domain name.
Cache-Control: no-cache
Content-Type: application/json
srcTranId: 201910181908046224775037
timeStamp: 1579423534
Accept: application/json
Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx

Response:

复制
HTTP/1.1 404
Content-type: application/json
content-length: 113
{"serviceError":{"code":404000006,"message":"The beacon with ID bea001 does not exist.","status":"Not Found"}}

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

Request:

复制
POST /WiseCloudNearbyBeaconService/v1/queryBeaconAttachment/beacon001?projectId=id123 HTTP/1.1
Host: Domain name.
Cache-Control: no-cache
Content-Type: application/json
srcTranId: 201910181908046224775031
timeStamp: 1579423534
Accept: application/json
Authorization: Bearer eyJraWQiOiIx---xxx.eyJhdWQiOiJodHR---xxx.QRodgXa2xeXSt4Gp---xxx

Response:

复制
HTTP/1.1 200
content-length: 78
Content-Type: application/json;charset=UTF-8
{"attachments":[{"namespace":"namespace002","attachmentId":"202001191739115580278122214157680128","type":"4","value":"5oiR5piv5Lit5Zu95Lq6qw"}]}