Jump to

• Request
• Response
• Examples

Return a Notification

get

/mobile/system/notifications/notifications/{id}

Retrieves a specific notification by ID.

If you are using BASIC authorization, and the notification is for a different mobile backend, then the Oracle-Mobile-Backend-ID header must identify that mobile backend, and not the backend that your app is associated with.

Permissions

To access this operation, you must be a team member with the MobileEnvironment_Notifications role.

Request

Path Parameters

• id: integer
  The service-generated notification ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The notification was successfully retrieved.

Body ()

Root Schema : Stored notification

Type: object

Title: Stored notification

Match All

Show Source

• object Stored notification properties
  Title: Stored notification properties
• object User-entered notification
  Title: User-entered notification

{
    "title":"Stored notification",
    "required":[
        "id",
        "status",
        "links"
    ],
    "type":"object",
    "allOf":[
        {
            "title":"Stored notification properties",
            "properties":{
                "id":{
                    "description":"Service-generated identifier.",
                    "type":"integer"
                },
                "errorMessage":{
                    "description":"Message explaining a status of `Error` or `Warning`. If there are multiple associated problems, only the first is shown here.",
                    "type":"string"
                },
                "createdOn":{
                    "description":"When the notification was created.",
                    "$ref":"#/definitions/mobFullDate"
                },
                "deviceCount":{
                    "description":"When the `status` is `Sending`, `Sent`, or `Warning`, this is the number of devices that this notification was sent to. Also, under some conditions, this attribute is included when the `status` is `Error`.",
                    "type":"integer"
                },
                "platformCounts":{
                    "items":{
                        "$ref":"#/definitions/platformCount"
                    },
                    "description":"Device counts by platform.",
                    "minItems":1,
                    "type":"array",
                    "uniqueItems":true
                },
                "status":{
                    "description":"Current status of the notification.",
                    "$ref":"#/definitions/status"
                },
                "links":{
                    "$ref":"#/definitions/links"
                },
                "processedOn":{
                    "description":"When the notification was processed.",
                    "$ref":"#/definitions/mobFullDate"
                }
            }
        },
        {
            "$ref":"#/definitions/notificationCreate"
        }
    ]
}

Nested Schema : Stored notification properties

Type: object

Title: Stored notification properties

Show Source

• createdOn(optional): string
  Title: Full date and time

  Pattern: ([0-9][0-9][0-9][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]).([0-9][0-9][0-9])Z

  Complete date plus hours, minutes, seconds, and a decimal fraction of a second in W3C date-time format (YYYY-MM-DDThh:mm.ss.SSSZ).
• deviceCount(optional): integer
  When the `status` is `Sending`, `Sent`, or `Warning`, this is the number of devices that this notification was sent to. Also, under some conditions, this attribute is included when the `status` is `Error`.
• errorMessage(optional): string
  Message explaining a status of `Error` or `Warning`. If there are multiple associated problems, only the first is shown here.
• id(optional): integer
  Service-generated identifier.
• links(optional): array Relationship links
  Title: Relationship links

  Minimum Number of Items: 1

  Unique Items Required: true
• platformCounts(optional): array platformCounts
  Minimum Number of Items: 1

  Unique Items Required: true

  Device counts by platform.
• processedOn(optional): string
  Title: Full date and time

  Pattern: ([0-9][0-9][0-9][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]).([0-9][0-9][0-9])Z

  Complete date plus hours, minutes, seconds, and a decimal fraction of a second in W3C date-time format (YYYY-MM-DDThh:mm.ss.SSSZ).
• status(optional): string
  Title: Status values

  Allowed Values: [ "New", "Scheduled", "Sending", "Error", "Warning", "Sent" ]

{
    "title":"Stored notification properties",
    "properties":{
        "id":{
            "description":"Service-generated identifier.",
            "type":"integer"
        },
        "errorMessage":{
            "description":"Message explaining a status of `Error` or `Warning`. If there are multiple associated problems, only the first is shown here.",
            "type":"string"
        },
        "createdOn":{
            "description":"When the notification was created.",
            "$ref":"#/definitions/mobFullDate"
        },
        "deviceCount":{
            "description":"When the `status` is `Sending`, `Sent`, or `Warning`, this is the number of devices that this notification was sent to. Also, under some conditions, this attribute is included when the `status` is `Error`.",
            "type":"integer"
        },
        "platformCounts":{
            "items":{
                "$ref":"#/definitions/platformCount"
            },
            "description":"Device counts by platform.",
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "status":{
            "description":"Current status of the notification.",
            "$ref":"#/definitions/status"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "processedOn":{
            "description":"When the notification was processed.",
            "$ref":"#/definitions/mobFullDate"
        }
    }
}

Nested Schema : User-entered notification

Type: object

Title: User-entered notification

Match All

Show Source

• object Notification properties
  Title: Notification properties
• object Notification payload
  Title: Notification payload

  The payload to send. A notification can specify any combination of message, template, and unified payload. When selecting the most appropriate payload for a provider, the service uses the unified payload if it exists, then the template, if it exists, then the message (in that order).

{
    "title":"User-entered notification",
    "type":"object",
    "allOf":[
        {
            "title":"Notification properties",
            "properties":{
                "platform":{
                    "description":"Filter selected devices by `platform`. That is, after selecting all devices that match the specified notification tokens and all devices that match the specified users, filter out all devices that do not match the specified platform.",
                    "$ref":"#/definitions/platform"
                },
                "sendOn":{
                    "description":"When to send the notification. If empty or not specified, the notification is sent immediately.",
                    "$ref":"#/definitions/mobDate"
                },
                "users":{
                    "items":{
                        "type":"string"
                    },
                    "description":"Select devices to send the notification to by `user`.",
                    "minItems":1,
                    "type":"array",
                    "uniqueItems":true
                },
                "tag":{
                    "description":"User-defined tag that you use to categorize notifications.",
                    "type":"string"
                },
                "notificationTokens":{
                    "items":{
                        "type":"string"
                    },
                    "description":"Select devices to send the notification to by `notificationToken`.",
                    "minItems":1,
                    "type":"array",
                    "uniqueItems":true,
                    "maxItems":1000
                },
                "provider":{
                    "description":"Filter selected devices by `provider`. That is, after selecting all devices that match the specified notification tokens and all devices that match the specified users, filter out all devices that do not match the specified provider.",
                    "$ref":"#/definitions/provider"
                }
            }
        },
        {
            "$ref":"#/definitions/notificationPayload"
        }
    ]
}

Nested Schema : Relationship links

Type: array

Title: Relationship links

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• Array of: object Link
  Title: Link

{
    "title":"Relationship links",
    "items":{
        "$ref":"#/definitions/link"
    },
    "minItems":1,
    "uniqueItems":true,
    "type":"array"
}

Nested Schema : platformCounts

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Device counts by platform.

Show Source

• Array of: object Device counts for a platform
  Title: Device counts for a platform

{
    "items":{
        "$ref":"#/definitions/platformCount"
    },
    "description":"Device counts by platform.",
    "minItems":1,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : Link

Type: object

Title: Link

Show Source

• href: string
  A relative URL.
• rel:
  Allowed Values: [ "self", "canonical", "prev", "next" ]

  The type of link.

{
    "title":"Link",
    "properties":{
        "rel":{
            "description":"The type of link.",
            "enum":[
                "self",
                "canonical",
                "prev",
                "next"
            ]
        },
        "href":{
            "description":"A relative URL.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "type":"object"
}

Nested Schema : Device counts for a platform

Type: object

Title: Device counts for a platform

Show Source

• deviceCount: integer
  How many devices were selected for this platform.
• platform: string
  Title: Supported platforms

  Allowed Values: [ "IOS", "ANDROID", "WINDOWS", "WEB" ]
• successCount: integer
  How many devices were accepted by the underlying notification provider.

{
    "title":"Device counts for a platform",
    "properties":{
        "platform":{
            "description":"The platform.",
            "$ref":"#/definitions/platform"
        },
        "deviceCount":{
            "description":"How many devices were selected for this platform.",
            "type":"integer"
        },
        "successCount":{
            "description":"How many devices were accepted by the underlying notification provider.",
            "type":"integer"
        }
    },
    "required":[
        "platform",
        "deviceCount",
        "successCount"
    ],
    "type":"object"
}

Nested Schema : Notification properties

Type: object

Title: Notification properties

Show Source

• notificationTokens(optional): array notificationTokens
  Minimum Number of Items: 1

  Maximum Number of Items: 1000

  Unique Items Required: true

  Select devices to send the notification to by `notificationToken`.
• platform(optional): string
  Title: Supported platforms

  Allowed Values: [ "IOS", "ANDROID", "WINDOWS", "WEB" ]
• provider(optional): string
  Title: Supported notification providers

  Allowed Values: [ "APNS", "GCM", "FCM", "WNS", "SYNIVERSE" ]
• sendOn(optional): string
  Title: Short date and time

  Pattern: ([0-9][0-9][0-9][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])(T([0-1][0-9]|2[0-3]):([0-5][0-9]))+Z

  Complete date plus hours and minutes in W3C date-time format (YYYY-MM-DD[Thh:mm]Z).
• tag(optional): string
  User-defined tag that you use to categorize notifications.
• users(optional): array users
  Minimum Number of Items: 1

  Unique Items Required: true

  Select devices to send the notification to by `user`.

{
    "title":"Notification properties",
    "properties":{
        "platform":{
            "description":"Filter selected devices by `platform`. That is, after selecting all devices that match the specified notification tokens and all devices that match the specified users, filter out all devices that do not match the specified platform.",
            "$ref":"#/definitions/platform"
        },
        "sendOn":{
            "description":"When to send the notification. If empty or not specified, the notification is sent immediately.",
            "$ref":"#/definitions/mobDate"
        },
        "users":{
            "items":{
                "type":"string"
            },
            "description":"Select devices to send the notification to by `user`.",
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "tag":{
            "description":"User-defined tag that you use to categorize notifications.",
            "type":"string"
        },
        "notificationTokens":{
            "items":{
                "type":"string"
            },
            "description":"Select devices to send the notification to by `notificationToken`.",
            "minItems":1,
            "type":"array",
            "uniqueItems":true,
            "maxItems":1000
        },
        "provider":{
            "description":"Filter selected devices by `provider`. That is, after selecting all devices that match the specified notification tokens and all devices that match the specified users, filter out all devices that do not match the specified provider.",
            "$ref":"#/definitions/provider"
        }
    }
}

Nested Schema : Notification payload

Type: object

Title: Notification payload

The payload to send. A notification can specify any combination of message, template, and unified payload. When selecting the most appropriate payload for a provider, the service uses the unified payload if it exists, then the template, if it exists, then the message (in that order).

Show Source

• message(optional): string
  A simple message string. This will be used to create the payload. The maximum payload size depends on the provider. For APNS, FCM and GCM the payload size limit is 4096 bytes, for WNS the limit is 5000 bytes, and for Syniverse the limit is 1000 bytes.
• payload(optional): object Unified payload for notification providers
  Title: Unified payload for notification providers
• template(optional): object Template reference
  Title: Template reference

  Name and parameters for a template from which to create the payload

{
    "title":"Notification payload",
    "description":"The payload to send. A notification can specify any combination of message, template, and unified payload. When selecting the most appropriate payload for a provider, the service uses the unified payload if it exists, then the template, if it exists, then the message (in that order).",
    "properties":{
        "message":{
            "description":"A simple message string. This will be used to create the payload. The maximum payload size depends on the provider. For APNS, FCM and GCM the payload size limit is 4096 bytes, for WNS the limit is 5000 bytes, and for Syniverse the limit is 1000 bytes.",
            "type":"string"
        },
        "template":{
            "description":"A template to use to create the payload. The maximum payload size depends on the provider. For APNS, FCM and GCM the payload size limit is 4096 bytes, for WNS the limit is 5000 bytes, and for Syniverse the limit is 1000 bytes.",
            "$ref":"#/definitions/templateRef"
        },
        "payload":{
            "description":"A unified JSON payload for the notification providers. The maximum payload size depends on the provider. For APNS, FCM and GCM the payload size limit is 4096 bytes, for WNS the limit is 5000 bytes, and for Syniverse the limit is 1000 bytes.",
            "$ref":"#/definitions/unifiedPayload"
        }
    },
    "type":"object"
}

Nested Schema : notificationTokens

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1000

Unique Items Required: true

Select devices to send the notification to by `notificationToken`.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "description":"Select devices to send the notification to by `notificationToken`.",
    "minItems":1,
    "type":"array",
    "uniqueItems":true,
    "maxItems":1000
}

Nested Schema : users

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Select devices to send the notification to by `user`.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "description":"Select devices to send the notification to by `user`.",
    "minItems":1,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : Unified payload for notification providers

Type: object

Title: Unified payload for notification providers

Show Source

• services: object Notification payloads for specific providers
  Title: Notification payloads for specific providers

{
    "title":"Unified payload for notification providers",
    "properties":{
        "services":{
            "$ref":"#/definitions/providersPayload"
        }
    },
    "required":[
        "services"
    ],
    "type":"object"
}

Nested Schema : Template reference

Type: object

Title: Template reference

Name and parameters for a template from which to create the payload

Show Source

• name: string
  The template name.
• parameters(optional): object parameters
  The template parameters. The required parameters are defined by the template.

{
    "title":"Template reference",
    "description":"Name and parameters for a template from which to create the payload",
    "properties":{
        "name":{
            "description":"The template name.",
            "type":"string"
        },
        "parameters":{
            "description":"The template parameters.  The required parameters are defined by the template.",
            "type":"object"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Nested Schema : Notification payloads for specific providers

Type: object

Title: Notification payloads for specific providers

Show Source

• apns(optional): object apns
  If specified, this payload is used for notifications sent using APNS. This object must conform to APNS requirements.
• fcm(optional): object fcm
  If specified, this payload is used for notifications sent using FCM. An fcm object can contain either a notification object or a data object. A notification object has a predefined set of user-visible keys described in the FCM documentation. A data object has custom key-value pairs.
• gcm(optional): object gcm
  If specified, this payload is used for notifications sent using GCM. This object can contain arbitrary JSON properties.
• syniverse(optional): object Syniverse payload
  Title: Syniverse payload
• wns(optional): object WNS payload
  Title: WNS payload

{
    "title":"Notification payloads for specific providers",
    "properties":{
        "syniverse":{
            "description":"If specified, this payload is used for notifications sent using Syniverse.",
            "$ref":"#/definitions/syniversePayload"
        },
        "apns":{
            "description":"If specified, this payload is used for notifications sent using APNS. This object must conform to APNS requirements.",
            "type":"object"
        },
        "gcm":{
            "description":"If specified, this payload is used for notifications sent using GCM.  This object can contain arbitrary JSON properties.",
            "type":"object"
        },
        "fcm":{
            "description":"If specified, this payload is used for notifications sent using FCM. An <code>fcm</code> object can contain either a <code>notification</code> object or a <code>data</code> object. A <code>notification</code> object has a predefined set of user-visible keys described in the FCM documentation. A <code>data</code> object has custom key-value pairs.",
            "type":"object"
        },
        "wns":{
            "description":"If specified, this payload is used for notifications sent using WNS.",
            "$ref":"#/definitions/wnsPayload"
        }
    },
    "type":"object"
}

Nested Schema : apns

Type: object

If specified, this payload is used for notifications sent using APNS. This object must conform to APNS requirements.

Nested Schema : fcm

Type: object

If specified, this payload is used for notifications sent using FCM. An fcm object can contain either a notification object or a data object. A notification object has a predefined set of user-visible keys described in the FCM documentation. A data object has custom key-value pairs.

Nested Schema : gcm

Type: object

If specified, this payload is used for notifications sent using GCM. This object can contain arbitrary JSON properties.

Nested Schema : Syniverse payload

Type: object

Title: Syniverse payload

Show Source

• body: string
  The message to send as an SMS message.

{
    "title":"Syniverse payload",
    "properties":{
        "body":{
            "description":"The message to send as an SMS message.",
            "type":"string"
        }
    },
    "required":[
        "body"
    ],
    "type":"object"
}

Nested Schema : WNS payload

Type: object

Title: WNS payload

Show Source

• badge(optional): object Badge value or glyph
  Title: Badge value or glyph
• raw(optional): object Raw payload
  Title: Raw payload

  Specifies a raw payload. This is any arbitrary JSON object.
• tile(optional): object Base tile element
  Title: Base tile element

  Base tile element, which contains a single visual element.
• toast(optional): object Base toast element
  Title: Base toast element

  Base toast element, which contains at least a single visual element.

{
    "title":"WNS payload",
    "properties":{
        "raw":{
            "$ref":"#/definitions/wnsRaw"
        },
        "tile":{
            "$ref":"#/definitions/wnsTile"
        },
        "toast":{
            "$ref":"#/definitions/wnsToast"
        },
        "badge":{
            "$ref":"#/definitions/wnsBadge"
        }
    },
    "type":"object"
}

Nested Schema : Badge value or glyph

Type: object

Title: Badge value or glyph

Show Source

• value: string
  Either a numeric value or a string value that specifies a predefined badge glyph.
• version(optional): integer
  The version of the badge XML schema that this particular payload was developed for.

{
    "title":"Badge value or glyph",
    "properties":{
        "value":{
            "description":"Either a numeric value or a string value that specifies a predefined badge glyph.",
            "type":"string"
        },
        "version":{
            "description":"The version of the badge XML schema that this particular payload was developed for.",
            "type":"integer"
        }
    },
    "required":[
        "value"
    ],
    "type":"object"
}

Nested Schema : Raw payload

Type: object

Title: Raw payload

Specifies a raw payload. This is any arbitrary JSON object.

Nested Schema : Base tile element

Type: object

Title: Base tile element

Base tile element, which contains a single visual element.

Show Source

• visual: object Binding child elements
  Title: Binding child elements

{
    "title":"Base tile element",
    "description":"Base tile element, which contains a single visual element.",
    "properties":{
        "visual":{
            "description":"Contains multiple binding child elements, each of which defines a tile.",
            "$ref":"#/definitions/wnsTileVisual"
        }
    },
    "required":[
        "visual"
    ],
    "type":"object"
}

Nested Schema : Base toast element

Type: object

Title: Base toast element

Base toast element, which contains at least a single visual element.

Show Source

• audio(optional): object Sound to play
  Title: Sound to play

  Specifies a sound to play when a toast is displayed. This element also allows you to mute toast audio.
• commands(optional): object Scenario commands
  Title: Scenario commands

  Specifies that the toast indicates an incoming call or an alarm, with appropriate commands associated with each scenario.
• duration(optional): string
  The amount of time the toast should display.
• launch(optional): string
  A string that is passed to the application when it is activated by the toast. The format and contents of this string are defined by the app for its own use.
• visual: object Single binding element that defines a toast
  Title: Single binding element that defines a toast

{
    "title":"Base toast element",
    "description":"Base toast element, which contains at least a single visual element.",
    "properties":{
        "duration":{
            "description":"The amount of time the toast should display.",
            "type":"string"
        },
        "visual":{
            "description":"Contains a single binding element that defines a toast.",
            "$ref":"#/definitions/wnsToastVisual"
        },
        "audio":{
            "description":"Specifies a sound to play when a toast notification is displayed. This element also allows you to mute toast notification audio.",
            "$ref":"#/definitions/wnsAudio"
        },
        "commands":{
            "description":"Specifies that the toast notification indicates an incoming call or an alarm, with appropriate commands associated with each scenario.",
            "$ref":"#/definitions/wnsCommands"
        },
        "launch":{
            "description":"A string that is passed to the application when it is activated by the toast. The format and contents of this string are defined by the app for its own use.",
            "type":"string"
        }
    },
    "required":[
        "visual"
    ],
    "type":"object"
}

Nested Schema : Binding child elements

Type: object

Title: Binding child elements

Match All

Show Source

• object Child element properties
  Title: Child element properties
• object Common visual and binding properties
  Title: Common visual and binding properties

{
    "title":"Binding child elements",
    "required":[
        "binding"
    ],
    "type":"object",
    "allOf":[
        {
            "title":"Child element properties",
            "properties":{
                "binding":{
                    "items":{
                        "$ref":"#/definitions/wnsBinding"
                    },
                    "description":"Specifies the tile template. Every notification should include one binding element for each supported tile size.",
                    "minItems":1,
                    "type":"array",
                    "maxItems":2
                },
                "contentId":{
                    "description":"Set to a sender-defined string that uniquely identifies the content of the notification.",
                    "type":"string"
                },
                "version":{
                    "description":"The version of the tile XML schema this particular payload was developed for.",
                    "type":"string"
                }
            }
        },
        {
            "$ref":"#/definitions/wnsVisualElements"
        }
    ]
}

Nested Schema : Child element properties

Type: object

Title: Child element properties

Show Source

• binding(optional): array binding
  Minimum Number of Items: 1

  Maximum Number of Items: 2

  Specifies the tile template. Every notification should include one binding element for each supported tile size.
• contentId(optional): string
  Set to a sender-defined string that uniquely identifies the content of the notification.
• version(optional): string
  The version of the tile XML schema this particular payload was developed for.

{
    "title":"Child element properties",
    "properties":{
        "binding":{
            "items":{
                "$ref":"#/definitions/wnsBinding"
            },
            "description":"Specifies the tile template. Every notification should include one binding element for each supported tile size.",
            "minItems":1,
            "type":"array",
            "maxItems":2
        },
        "contentId":{
            "description":"Set to a sender-defined string that uniquely identifies the content of the notification.",
            "type":"string"
        },
        "version":{
            "description":"The version of the tile XML schema this particular payload was developed for.",
            "type":"string"
        }
    }
}

Nested Schema : Common visual and binding properties

Type: object

Title: Common visual and binding properties

Show Source

• addImageQuery(optional): boolean
  Set to `true` to allow Windows to append a query string to the image URI supplied in the toast notification.
• baseUri(optional): string
  A default base URI that is combined with relative URIs in image source attributes.
• branding(optional): string
  The form that the tile should use to display the app's brand.
• lang(optional): string
  The target locale of the XML payload, specified as a BCP-47 language tag such as `en-US` or `fr-FR`.

{
    "title":"Common visual and binding properties",
    "properties":{
        "baseUri":{
            "description":"A default base URI that is combined with relative URIs in image source attributes.",
            "type":"string"
        },
        "branding":{
            "description":"The form that the tile should use to display the app's brand.",
            "type":"string"
        },
        "lang":{
            "description":"The target locale of the XML payload, specified as a BCP-47 language tag such as `en-US` or `fr-FR`.",
            "type":"string"
        },
        "addImageQuery":{
            "description":"Set to `true` to allow Windows to append a query string to the image URI supplied in the toast notification.",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : binding

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Specifies the tile template. Every notification should include one binding element for each supported tile size.

Show Source

• Array of: object Toast template
  Title: Toast template

{
    "items":{
        "$ref":"#/definitions/wnsBinding"
    },
    "description":"Specifies the tile template. Every notification should include one binding element for each supported tile size.",
    "minItems":1,
    "type":"array",
    "maxItems":2
}

Nested Schema : Toast template

Type: object

Title: Toast template

Match All

Show Source

• object Toast template properties
  Title: Toast template properties
• object Common visual and binding properties
  Title: Common visual and binding properties

{
    "title":"Toast template",
    "required":[
        "template"
    ],
    "type":"object",
    "allOf":[
        {
            "title":"Toast template properties",
            "properties":{
                "template":{
                    "description":"One of the provided templates on which to base the toast.",
                    "type":"string"
                },
                "fallback":{
                    "description":"For backward compatibility, a template to use if the primary template isn't found.",
                    "type":"string"
                },
                "text":{
                    "items":{
                        "type":"string"
                    },
                    "description":"Specifies text to use in the toast template.",
                    "minItems":1,
                    "type":"array"
                },
                "image":{
                    "items":{
                        "$ref":"#/definitions/wnsImage"
                    },
                    "description":"Specifies an image to use in the toast template.",
                    "minItems":0,
                    "type":"array"
                }
            }
        },
        {
            "$ref":"#/definitions/wnsVisualElements"
        }
    ]
}

Nested Schema : Toast template properties

Type: object

Title: Toast template properties

Show Source

• fallback(optional): string
  For backward compatibility, a template to use if the primary template isn't found.
• image(optional): array image
  Minimum Number of Items: 0

  Specifies an image to use in the toast template.
• template(optional): string
  One of the provided templates on which to base the toast.
• text(optional): array text
  Minimum Number of Items: 1

  Specifies text to use in the toast template.

{
    "title":"Toast template properties",
    "properties":{
        "template":{
            "description":"One of the provided templates on which to base the toast.",
            "type":"string"
        },
        "fallback":{
            "description":"For backward compatibility, a template to use if the primary template isn't found.",
            "type":"string"
        },
        "text":{
            "items":{
                "type":"string"
            },
            "description":"Specifies text to use in the toast template.",
            "minItems":1,
            "type":"array"
        },
        "image":{
            "items":{
                "$ref":"#/definitions/wnsImage"
            },
            "description":"Specifies an image to use in the toast template.",
            "minItems":0,
            "type":"array"
        }
    }
}

Nested Schema : image

Type: array

Minimum Number of Items: 0

Specifies an image to use in the toast template.

Show Source

• Array of: object Image to use in a toast or tile template
  Title: Image to use in a toast or tile template

{
    "items":{
        "$ref":"#/definitions/wnsImage"
    },
    "description":"Specifies an image to use in the toast template.",
    "minItems":0,
    "type":"array"
}

Nested Schema : text

Type: array

Minimum Number of Items: 1

Specifies text to use in the toast template.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "description":"Specifies text to use in the toast template.",
    "minItems":1,
    "type":"array"
}

Nested Schema : Image to use in a toast or tile template

Type: object

Title: Image to use in a toast or tile template

Show Source

• addImageQuery(optional): boolean
  Set to `true` to allow Windows to append a query string to the image URI supplied in the toast.
• alt(optional): string
  For users of assistive technologies, a description of the image.
• src: string
  The URI of the image source.

{
    "title":"Image to use in a toast or tile template",
    "properties":{
        "alt":{
            "description":"For users of assistive technologies, a description of the image.",
            "type":"string"
        },
        "src":{
            "description":"The URI of the image source.",
            "type":"string"
        },
        "addImageQuery":{
            "description":"Set to `true` to allow Windows to append a query string to the image URI supplied in the toast.",
            "type":"boolean"
        }
    },
    "required":[
        "src"
    ],
    "type":"object"
}

Nested Schema : Sound to play

Type: object

Title: Sound to play

Specifies a sound to play when a toast is displayed. This element also allows you to mute toast audio.

Show Source

• loop(optional): boolean
  Set to `true` if the sound should repeat as long as the toast is shown, and `false` to play only once.
• silent(optional): boolean
  Set to `true` to mute the sound, and `false` to allow the toast sound to play.
• src(optional): string
  The media file to play in place of the default sound.

{
    "title":"Sound to play",
    "description":"Specifies a sound to play when a toast is displayed. This element also allows you to mute toast audio.",
    "properties":{
        "silent":{
            "description":"Set to `true` to mute the sound, and `false` to allow the toast sound to play.",
            "type":"boolean"
        },
        "loop":{
            "description":"Set to `true` if the sound should repeat as long as the toast is shown, and `false` to play only once.",
            "type":"boolean"
        },
        "src":{
            "description":"The media file to play in place of the default sound.",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : Scenario commands

Type: object

Title: Scenario commands

Specifies that the toast indicates an incoming call or an alarm, with appropriate commands associated with each scenario.

Show Source

• commands: array commands
  Minimum Number of Items: 1

  Specifies the scenario-associated buttons shown in the toast.
• scenario: string
  Specifies the intended use of the notification.

{
    "title":"Scenario commands",
    "description":"Specifies that the toast indicates an incoming call or an alarm, with appropriate commands associated with each scenario.",
    "properties":{
        "scenario":{
            "description":"Specifies the intended use of the notification.",
            "type":"string"
        },
        "commands":{
            "items":{
                "$ref":"#/definitions/wnsCommand"
            },
            "description":"Specifies the scenario-associated buttons shown in the toast.",
            "minItems":1,
            "type":"array"
        }
    },
    "required":[
        "scenario",
        "commands"
    ],
    "type":"object"
}

Nested Schema : Single binding element that defines a toast

Type: object

Title: Single binding element that defines a toast

Match All

Show Source

• object Element properties
  Title: Element properties
• object Common visual and binding properties
  Title: Common visual and binding properties

{
    "title":"Single binding element that defines a toast",
    "required":[
        "binding"
    ],
    "type":"object",
    "allOf":[
        {
            "title":"Element properties",
            "properties":{
                "binding":{
                    "description":"Specifies the toast template.",
                    "$ref":"#/definitions/wnsBinding"
                },
                "version":{
                    "description":"The version of the toast XML schema that this particular payload was developed for.",
                    "type":"string"
                }
            }
        },
        {
            "$ref":"#/definitions/wnsVisualElements"
        }
    ]
}

Nested Schema : commands

Type: array

Minimum Number of Items: 1

Specifies the scenario-associated buttons shown in the toast.

Show Source

• Array of: object Scenario button
  Title: Scenario button

  Specifies a scenario-associated button shown in a toast. The scenario is specified in the parent commands element.

{
    "items":{
        "$ref":"#/definitions/wnsCommand"
    },
    "description":"Specifies the scenario-associated buttons shown in the toast.",
    "minItems":1,
    "type":"array"
}

Nested Schema : Scenario button

Type: object

Title: Scenario button

Specifies a scenario-associated button shown in a toast. The scenario is specified in the parent commands element.

Show Source

• arguments(optional): string
  An argument string, which can be passed to the associated app to provide the specifics about the action that it should execute in response to the user action.
• id: string
  Specifies one command from the system-defined command list.

{
    "title":"Scenario button",
    "description":"Specifies a scenario-associated button shown in a toast. The scenario is specified in the parent commands element.",
    "properties":{
        "id":{
            "description":"Specifies one command from the system-defined command list.",
            "type":"string"
        },
        "arguments":{
            "description":"An argument string, which can be passed to the associated app to provide the specifics about the action that it should execute in response to the user action.",
            "type":"string"
        }
    },
    "required":[
        "id"
    ],
    "type":"object"
}

Nested Schema : Element properties

Type: object

Title: Element properties

Show Source

• binding(optional): object Toast template
  Title: Toast template
• version(optional): string
  The version of the toast XML schema that this particular payload was developed for.

{
    "title":"Element properties",
    "properties":{
        "binding":{
            "description":"Specifies the toast template.",
            "$ref":"#/definitions/wnsBinding"
        },
        "version":{
            "description":"The version of the toast XML schema that this particular payload was developed for.",
            "type":"string"
        }
    }
}

Nested Schema : parameters

Type: object

The template parameters. The required parameters are defined by the template.

Example Response (application/json)

{
    "message":"This is the alert message.",
    "id":1234,
    "createdOn":"2014-04-02T12:34:56.789Z",
    "platformCounts":[
        {
            "platform":"IOS",
            "deviceCount":1,
            "successCount":1
        }
    ],
    "status":"Sent",
    "tag":"Marketing",
    "notificationTokens":[
        "APNSdeviceToken"
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"/mobile/system/notifications/notifications/1234"
        },
        {
            "rel":"self",
            "href":"/mobile/system/notifications/notifications/1234"
        }
    ],
    "processedOn":"2014-04-01T12:34:56.789Z"
}

400 Response

The notification ID is missing.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. Included when the error is caused by multiple issues.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

404 Response

The notification ID wasn't found.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. Included when the error is caused by multiple issues.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Back to Top

Examples

This example shows how to retrieve a specific notification by submitting a GET request on the REST resource.

curl -i \
-X GET \ 
-u [e-mail]:password \
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce \
http://fif.cloud.oracle.com/mobile/system/notifications/notifications/5

Example of Response Header

Here's an example of the response header:

200 OK
Content-Type: application/json; charset=UTF-8
Date: Tue, 23 Jun 2015 00:28:16 GMT

Example of Response Body

This example shows the contents of the response body in JSON format:

{
  "id": 5,
  "message": "Incident service will be unavailable between 1:00 a.m. and 3:00 a.m. PST",
  "users": [ ],
  "roles": [ ],
  "notificationTokens": [ ],
  "sendOn": "2015-06-25T06:00Z",
  "tag": "System",
  "status": "Scheduled",
  "createdOn": "2015-06-23T00:27:05.175Z",
  "links": [
    {
      "rel": "canonical",
      "href": "/mobile/system/notifications/notifications/5"
    },
    {
      "rel": "self",
      "href": "/mobile/system/notifications/notifications/5"
    }
  ]
}

Back to Top