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

Querying Application Attributes

Function

This API is used to query attributes of a platform application.

URI

GET /v2/{project_id}/notifications/applications/{application_urn}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

See Obtaining a Project ID.

application_urn

Yes

String

Specifies the unique resource identifier of the application. You can obtain it based on Querying Platform Applications.

Request Parameters

Table 2 Request header parameters

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.

application_id

String

Specifies the application ID, which is unique.

attributes

Table 4 object

-
Table 4 ApplicationAttribute

Parameter

Type

Description

enabled

String

Specifies whether the platform application is enabled.

apple_certificate_expiration_date

String

Specifies the expiration time of the Apple certificate. This parameter is valid only for the APNS and APNS_SANDBOX platforms. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

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/applications/{application_urn}

null

Example Responses

Status code: 200

OK

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "application_id" : "b1b8643dc12b4g77ad6e35a16003119b",
  "attributes" : {
    "enabled" : "true",
    "apple_certificate_expiration_date" : "2018-03-09T12:21:40Z"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Application Operations