• Simple Message Notification

smn
  1. Help Center
  2. Simple Message Notification
  3. API Reference
  4. APIs
  5. Version Querying
  6. Querying the SMN API v2 Version

Querying the SMN API v2 Version

Description

  • API name

    QueryV2ApiInfo

  • Function

    Query the SMN API v2 version information.

URI

  • URI format

    GET /{api_version}

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    api_version

    Yes

    String

    Version to be queried

    NOTE:

    Currently, only v2 is supported.

Request

  • Request example
    GET /v2

Response

  • Parameter description
    Table 1 Parameter in the response

    Parameter

    Type

    Description

    version

    Object

    Version object

    Table 2 Description of the version field

    Parameter

    Type

    Description

    id

    String

    Version number, for example, v2

    links

    Links structure array. For details, see section Links Structure.

    API URL

    min_version

    String

    Minimum microversion number. If the APIs do not support microversions, the value is left blank.

    status

    String

    Version status, which can be the following:

    • CURRENT: widely used version
    • SUPPORTED: earlier version which is still supported
    • DEPRECATED: deprecated version which may be deleted later

    updated

    String

    Version release time, which must be UTC time. For example, the release time of v2 is 2014-06-28T12:20:21Z.

    version

    String

    Maximum microversion number. If the APIs do not support microversions, the value is left blank.

  • Response example
    {
        "version": 
            {
                "id": "v2",
                "links": [
                    {
                        "href": "https://127.0.0.1/v2",
                        "rel": "self"
                    }
                ],
                "min_version": "",
                "status": "CURRENT",
                "updated": "2018-09-19T00:00:00Z",
                "version": ""
            }
    }

Returned Value

See section Returned Value.

Error Code

See section Error Code.