netexCloud - API de Web Services | Push notification web services

Create push notification

Creates (sends) a push notification.

  • Url: /integration/ws/management/rest/pushnotification
  • Method: POST
  • Headers:
    • Accept: version/format header
    • X-Cloud-Auth-Token*: authorization header
  • Parameters:
    • customer: key name of the cutomer to which the notified users belong to
    • commonId: user commonId of the user to which send the push notification. Mandatory when no registrationId is specified
    • registrationId: firebase registration id to which send the push notification. Mandatory when no username is specified
    • notification*: map with predefined parameters for the push notification (more information)
    • data: map with custom parameters for the push notification
    * If parameter registrationId is specified, the push notification will be sent to the device it represents. Otherwise, parameter username must be specified, and push notification will be sent to all user's devices.
  • Responses:
    • 200: OK. Content:
      • status: generic status
      • location: generic location of the resultant resource, if any
      • message: generic success or error message, if any
      • responsePlatforms: response for every platform it concerns. Each one with the content:
        • status: status in the platform
        • location: location of the resultant resource in the platform, if any
        • message: success or error message in the platform, if any
  • Url example: http://netex.dev.learningcloud.me/integration/ws/management/rest/pushnotification
  • Response example:
{
"location": null,
"message": "",
"responsePlatforms": {},
"status": 202
}