Framework | Notification

Service to manage entities of type 'Notification'.

Overview

URL	api/{tenantKey}/{orgKey}/operations/notifications
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Notifications (odata)
  • GET Notification by identifier
  • GET Notification by key
• POST:
  • POST Notifications
  • POST Notification User
  • POST Notification Contact
  • POST Email Templates
• PUT:
  • PUT Set IsActive Notification
  • PUT Set NotificationKey Notification
  • PUT Set Description Notification
  • PUT Set ReceiptOption NotificationUser
  • PUT Set User NotificationUser
  • PUT Set ReceiptOption NotificationContact
  • PUT Set Contact NotificationContact
  • PUT Set EmailTemplate EmailTemplateList
  • PUT Set IsDefault EmailTemplateList
• DELETE:
  • DELETE Notification User by identifier
  • DELETE Notification Contact by identifier
  • DELETE Email Templates by identifier
  • DELETE Notification by identifier
  • DELETE Notification by key

All Resources

This service uses the following resources:

• ApiNotificationEmailTemplateListsResource
• ApiNotificationNotificationContactsResource
• ApiNotificationNotificationUsersResource
• ApiNotificationResource
• NotificationResource

All Enumerations

This service uses the following enumerations:

• NotificationReceiptOption

GET Operations

GET Notifications (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See NotificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Notification by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See NotificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Notification by key

Returns the entity record that matches the specified key.

The following elements are required:

notificationKey

(string) The key for the notification.

Response:

When successful, the response body contains the entity record. See NotificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST Notifications

Creates a new entity record.

The following elements are required:

notificationResource

(ApiNotificationResource) The request body should contain the entity record that should be created. See ApiNotificationResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiNotificationResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Notification User

Inserts a new 'Notification User' in the 'Notification'.

The following elements are required:

notificationKey	(string) The key for the notification.
value	(ApiNotificationNotificationUsersResource) The ApiNotificationNotificationUsersResource instance. See ApiNotificationNotificationUsersResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Notification Contact

Inserts a new 'Notification Contact' in the 'Notification'.

The following elements are required:

notificationKey	(string) The key for the notification.
value	(ApiNotificationNotificationContactsResource) The ApiNotificationNotificationContactsResource instance. See ApiNotificationNotificationContactsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Email Templates

Inserts a new 'Email Templates' in the 'Notification'.

The following elements are required:

notificationKey	(string) The key for the notification.
value	(ApiNotificationEmailTemplateListsResource) The ApiNotificationEmailTemplateListsResource instance. See ApiNotificationEmailTemplateListsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set Contact NotificationContact

Updates the value of attribute 'Contact' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Description Notification

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set EmailTemplate EmailTemplateList

Updates the value of attribute 'EmailTemplate' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive Notification

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set IsDefault EmailTemplateList

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The detail identifier.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set NotificationKey Notification

Updates the value of attribute 'NotificationKey' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ReceiptOption NotificationContact

Updates the value of attribute 'ReceiptOption' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The detail identifier.
value	(enum NotificationReceiptOption) The request body should contain the new value for the attribute. See NotificationReceiptOption.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ReceiptOption NotificationUser

Updates the value of attribute 'ReceiptOption' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The detail identifier.
value	(enum NotificationReceiptOption) The request body should contain the new value for the attribute. See NotificationReceiptOption.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set User NotificationUser

Updates the value of attribute 'User' in the specified entity record.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

DELETE Operations

DELETE Notification User by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Notification Contact by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Email Templates by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

notificationKey	(string) The key for the notification.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Notification by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Notification by key

Deletes the entity record that matches the specified key.

The following elements are required:

notificationKey

(string) The key for the notification.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiNotificationEmailTemplateListsResource

The following elements are required:

emailTemplate	(string) The email template for the email template list.
isDefault	(bool) The is default property choose which email template is by default for the notification.

ApiNotificationNotificationContactsResource

The following elements are required:

receiptOption	(enum NotificationReceiptOption) The receipt option. The notification option defines if the user group is "TO", "CC" or "BCC". See NotificationReceiptOption.
contact	(string) The contact for the notification contact.

ApiNotificationNotificationUsersResource

The following elements are required:

receiptOption	(enum NotificationReceiptOption) The receipt option. The notification option defines if the user is "TO", "CC" or "BCC". See NotificationReceiptOption.
user	(string) User.

ApiNotificationResource

The following elements are required:

notificationKey

(string) The key for the notification.

The following elements are optional:

description	(string) The description for the notification.
notificationUsers	(List of ApiNotificationNotificationUsersResource) The notification's users. See ApiNotificationNotificationUsersResource.
notificationContacts	(List of ApiNotificationNotificationContactsResource) The notification's contacts. See ApiNotificationNotificationContactsResource.
emailTemplateLists	(List of ApiNotificationEmailTemplateListsResource) The email templates. See ApiNotificationEmailTemplateListsResource.

NotificationResource

The following elements are required:

notificationKey

(string) The key for the notification.

The following elements are optional:

description	(string) The description for the notification.
notificationUsers	(List of NotificationUserResource) The notification's users. See NotificationUserResource.
notificationContacts	(List of NotificationContactResource) The notification's contacts. See NotificationContactResource.
emailTemplateLists	(List of EmailTemplateListResource) The email templates. See EmailTemplateListResource.

Enumerations

NotificationReceiptOption

1	To	The notification receipt option "To".
2	CC	The notification receipt option "CC".
3	Bcc	The notification receipt option "Bcc".