REST API for Oracle Commerce Cloud December 2017

getNotification

get

/ccadmin/v1/notificationMessages/{id}

Get Notification. Get the notification.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Id of notification.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getNotification_response

Properties

count: Type: integer

1 for simple notification and >1 for rolled up notification.
createdDate: Type: string

Date time when notification was created.
details: Type: string

Detailed information formatted as JSON payload..
id: Type: string

Id of notification.
key: Type: string

Key to roll up notification.
message: Type: string

Message content in notification.
pinned: Type: boolean

Is this notification pinned?
rolledUp: Type: boolean

Is this notification rolled up?
viewedDate: Type: string

Date time when notification was viewed.

Example application/json


{
    "viewedDate":null,
    "rolledUp":false,
    "pinned":false,
    "createdDate":"2016-10-19T19:46:11.754Z",
    "count":1,
    "details":"{\"Type\":\"test\",\"rate\":2.55,\"http code\":500,\"Date\":\"2016-10-19T19:46:11.753Z\"}",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/notificationMessages/931269"
        }
    ],
    "id":"931269",
    "message":"This is Failing",
    "key":"test"
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "viewedDate": null,
  "rolledUp": false,
  "pinned": false,
  "createdDate": "2016-10-19T19:46:11.754Z",
  "count": 1,
  "details": "{\"Type\":\"test\",\"rate\":2.55,\"http code\":500,\"Date\":\"2016-10-19T19:46:11.753Z\"}",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/notificationMessages/931269"
  }],
  "id": "931269",
  "message": "This is Failing",
  "key": "test"
}