GET /api/notifications/types

Returns a list of notification types (categories) that are valid on the platform.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/notifications/types

Sample Request

The example below shows a request for notification types.

Sample Request URL

https://{hostname}/api/notifications/types

Sample request headers

GET /api/notifications/types HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json

Request Parameters

None.

Response

If successful, this operation returns HTTP status code 200, with the notification types.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 09 Feb 2018 21:06:25 GMT

Sample response body

{
    "NotificationType": [
        "com.soa.notification.type.api.auto.connect",
        "com.soa.notification.type.app.alert",
        "com.soa.notification.type.app.lifecycle",
        "com.soa.notification.type.app.post",
        "com.soa.notification.type.appteam",
        "com.soa.notification.type.contract.state.change",
        "com.soa.notification.type.news.update",
        "com.soa.notification.type.post.comment",
        "com.soa.notification.type.privateapi",
        "com.soa.notification.type.ticket.change"
    ]
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json

Response Body

Name	Type	Description
NotificationTypes	NotificationTypes	Contains information about the types of notifications available on the platform.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics