Skip to main content

POST User Notifications

Overview


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

POST User Notification
MethodPOST
URL or Endpoint/api/organizations/organizationId/user-notifications
ParametersorganizationId, api-version
BodyCheck request body below.

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
orgaizationIdNostringUnique Id of the organization.
api-versionNostringThe 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 NameTypeDescription
titlestringThe title of the user notification.
descriptionstringThe description of the user notification..
userNotificationTypeIdintegerThe unique Id of the user notification type.
userNotificationDateIdintegerThe unique Id of the user notification date.
timestringThe time of the user notification.
periodicboolThe periodic occurence of user notifications.
messagestringThe message of the user notification.
activeboolIndicates whether the user is active.
recepientsobjectReturns the receipents as an object.
emailstringThe email of the user.
usageVolumeTypesobjectReturns the usage volume types as an object.
usageNotificationVolumeIdintegerThe unique Id of the usage notification volume.
thresholdintegerThe 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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the user notification.
titlestringThe title of the user notification.
descriptionstringThe description of the user notification.
userNotificationDateIdintegerThe date Id of the user notification.
timestringThe time of the user notification.
periodicboolThe periodic occurence of user notifications.
messagestringThe message of the user notification.
activeboolIndicates whether the user is active.
emailSentboolIndicates whether the email has been sent.
recepientsarray[Object]Returns the recepients object.
idinteger($int32)The id of the recepient.
emailstringThe email of the recepient.
usageVolumeTypesarray[Object]Returns the usage volume types object.
idinteger($int32)The Id of the usage volume types.
emailParagraphstringThe email paragraph of the usage volume type.
usageNotificationVolumeIdintegerThe Id of the usage notification volume.
thresholdintegerThe threshold of the usage volume type.
resultInfostringReturns extra information about the result.
statusCodeinteger($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