EmailGatewayResource

REST end point to manipulate individual channel-specific notification gateways.

The following resources are part of this group:

/notification/channel/email/gateway

Mount Point: /api/notification/channel/email/gateway

POST

This end point will add a new notification channel gateway to the application.

Request Body

element: emailGateway
media types: application/xml
application/json

this end point expects a single emailGateway element containing the gateway to be added

Response Body

element: emailGateway
media types: application/xml
application/json

this end point returns a single emailGateway element containing the gateway that was just added

Status Codes

code description
400 The given gateway was invalid
401 Authentication required
403 Authorization required - access forbidden

/notification/channel/email/gateway/{identity}

Mount Point: /api/notification/channel/email/gateway/{identity}

The following operations are supported on this resource:

GET

This end point will return the notification channel gateway that has the given identity.

Parameters

name description type default
identity the ID of the gateway to be fetched path

Response Body

element: emailGateway
media types: application/xml
application/json

this end point returns a single emailGateway element

Status Codes

code description
404 Gateway with the given ID was not found
401 Authentication required
403 Authorization required - access forbidden

DELETE

This end point will delete the notification channel gateway with the given identity.

Parameters

name description type default
identity the ID of the channel gateway to be deleted path

Status Codes

code description
404 Gateway with the given ID was not found
401 Authentication required
403 Authorization required - access forbidden

PUT

This end point will update the notification gateway with the given identity.

Parameters

name description type default
identity the ID of the gateway to be updated path

Request Body

element: emailGateway
media types: */*
application/xml

this end point expects a single emailGateway element containing the gateway to be updated

Response Body

element: emailGateway
media types: application/xml
application/json

this end point returns a single emailGateway element containing the gateway that was just updated

Status Codes

code description
400 The given gateway was invalid
404 Gateway with the given ID was not found
401 Authentication required
403 Authorization required - access forbidden

/notification/channel/email/gateway/{gatewayId}/sendEmail/{destinationId}

Mount Point: /api/notification/channel/email/gateway/{gatewayId}/sendEmail/{destinationId}

PUT

Sends a test email to the recipient via the gateway specified within the call

Parameters

name description type default
gatewayId (no documentation provided) path
destinationId (no documentation provided) path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
401 Authentication required
403 Authorization required - access forbidden