POST User Notifications

Overview

---

The following table contains important information about the POST method in regards to the managing process.

POST User Notification
Method	POST
URL or Endpoint	/api/organizations/organizationId/user-notifications
Parameters	organizationId, api-version
Body	Check request body below.

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
orgaizationId	No	string	Unique Id of the organization.
api-version	No	string	The api version to use.

Request Body

{
  "title": "string",
  "description": "string",
  "userNotificationTypeId": 0,
  "userNotificationDateId": 0,
  "time": "string",
  "periodic": true,
  "message": "string",
  "active": true,
  "recipients": [
    {
      "email": "string"
    }
  ],
  "usageVolumeTypes": [
    {
      "usageNotificationVolumeId": 0,
      "threshold": 0
    }
  ]
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
title	string	The title of the user notification.
description	string	The description of the user notification..
userNotificationTypeId	integer	The unique Id of the user notification type.
userNotificationDateId	integer	The unique Id of the user notification date.
time	string	The time of the user notification.
periodic	bool	The periodic occurence of user notifications.
message	string	The message of the user notification.
active	bool	Indicates whether the user is active.
recepients	object	Returns the receipents as an object.
email	string	The email of the user.
usageVolumeTypes	object	Returns the usage volume types as an object.
usageNotificationVolumeId	integer	The unique Id of the usage notification volume.
threshold	integer	The threshold of usage volume types.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "id": 0,
    "title": "string",
    "description": "string",
    "userNotificationDateId": 0,
    "time": "string",
    "periodic": true,
    "message": "string",
    "active": true,
    "emailSent": true,
    "recipients": [
      {
        "id": 0,
        "email": "string"
      }
    ],
    "usageVolumeTypes": [
      {
        "id": 0,
        "emailParagraph": "string",
        "usageNotificationVolumeId": 0,
        "threshold": 0
      }
    ]
  },
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	The id of the user notification.
title	string	The title of the user notification.
description	string	The description of the user notification.
userNotificationDateId	integer	The date Id of the user notification.
time	string	The time of the user notification.
periodic	bool	The periodic occurence of user notifications.
message	string	The message of the user notification.
active	bool	Indicates whether the user is active.
emailSent	bool	Indicates whether the email has been sent.
recepients	array[Object]	Returns the recepients object.
id	integer($int32)	The id of the recepient.
email	string	The email of the recepient.
usageVolumeTypes	array[Object]	Returns the usage volume types object.
id	integer($int32)	The Id of the usage volume types.
emailParagraph	string	The email paragraph of the usage volume type.
usageNotificationVolumeId	integer	The Id of the usage notification volume.
threshold	integer	The threshold of the usage volume type.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed