Help Center> Simple Message Notification> API Reference> APIs> Application Endpoint Operations> Querying Application Endpoint Attributes
View PDF

Querying Application Endpoint Attributes

Function

This API is used to query attributes of an endpoint.

URI

GET /v2/{project_id}/notifications/endpoints/{endpoint_urn}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

See Obtaining a Project ID.

endpoint_urn

Yes

String

Specifies the unique resource identifier of the endpoint. You can obtain it by referring to Querying the Endpoints of an Application.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

attributes

attributes object

Specifies the attribute key-value pair.
Table 4 attributes

Parameter

Type

Description

enabled

String

Specifies whether the device is available.

token

String

Specifies the device token.

user_data

String

Specifies the user data.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Example Requests

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/endpoints/{endpoint_urn}

null

Example Responses

Status code: 200

OK

{
  "request_id" : "c90d871f77f7425cae0a8b772a563d17",
  "attributes" : {
    "enabled" : "true",
    "token" : "3708232124742383445",
    "user_data" : "abc"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.