Hvl Mail Notification Server
Havelsan mail notification services info
Version: 4.1.0-SNAPSHOT
Apache License Version 2.0
https://www.apache.org/licenses/LICENSE-2.0
Access
[ Jump to Models ]
Table of Contents
Up
post /notification/mail/calendar-notify
Sends calendar notification request object (calendarNotify)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /notification/mail/notify
Sends notification event with mail request object (notify)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /notification/mail/notify-with-content
Sends notification event with mail request object (notifyWithContent)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /notification/mail/preview
Provides preview for mail content with attributes (preview1)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"updatedBy" : "updatedBy",
"subject" : "subject",
"uuid" : "uuid",
"version" : 0,
"content" : "content",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"sender" : "sender",
"id" : 6,
"contentType" : "STRING"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlNotificationTemplateContentModel
Up
post /notification/template/activate/by-uuid/{uuid}
Activates the mail template (activateByUuid)
Path parameters
uuid (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /notification/template/deactivate/by-uuid/{uuid}
Deactivates the mail template (deactivateByUuid)
Path parameters
uuid (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
delete /notification/template/by-uuid/{uuid}
Deletes notification template (delete)
Path parameters
uuid (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
get /notification/template/by-uuid/{uuid}
Gets the notification template with provided uuid (getByUuid)
Path parameters
uuid (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"updatedBy" : "updatedBy",
"code" : "code",
"contentMap" : {
"key" : {
"updatedBy" : "updatedBy",
"subject" : "subject",
"uuid" : "uuid",
"version" : 0,
"content" : "content",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"sender" : "sender",
"id" : 6,
"contentType" : "STRING"
}
},
"description" : "description",
"type" : "SMS",
"uuid" : "uuid",
"version" : 0,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"id" : 6
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlNotificationTemplateModel
Up
get /notification/template/enabled/by-code/{code}
Mail template is enabled (isEnabled)
Path parameters
code (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseBoolean
Up
post /notification/template/preview
Gets the notification template (preview)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"updatedBy" : "updatedBy",
"subject" : "subject",
"uuid" : "uuid",
"version" : 0,
"content" : "content",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"sender" : "sender",
"id" : 6,
"contentType" : "STRING"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlNotificationTemplateContentModel
Up
post /notification/template/data/page
Queries notification template as paginated according to criteria in query model (queryDataPage)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"data" : [ {
"updatedBy" : "updatedBy",
"code" : "code",
"description" : "description",
"type" : "SMS",
"uuid" : "uuid",
"version" : 5,
"enabled" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"id" : 2
}, {
"updatedBy" : "updatedBy",
"code" : "code",
"description" : "description",
"type" : "SMS",
"uuid" : "uuid",
"version" : 5,
"enabled" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"id" : 2
} ],
"totalPages" : 6,
"pageable" : {
"pageNumber" : 1,
"pageSize" : 5,
"sort" : {
"properties" : [ "properties", "properties" ],
"direction" : "ASC"
}
},
"totalElements" : 0
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlPageHvlNotificationTemplateDataModel
Up
post /notification/template
Saves notification template (save)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
put /notification/template
Updates notification template (update)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
[ Jump to Methods ]
Table of Contents
HvlCalendarHvlCalendarNotificationRequestModelHvlErrorDetailHvlMailAttachmentHvlNotificationMailRequestModelHvlNotificationMailRequestModelWithContentHvlNotificationPreviewModelHvlNotificationTemplateContentModelHvlNotificationTemplateDataModelHvlNotificationTemplateModelHvlNotificationTemplateQueryModelHvlNotificationTemplateQueryModel_localeHvlPageHvlNotificationTemplateDataModelHvlPageableHvlResponseBooleanHvlResponseHvlNotificationTemplateContentModelHvlResponseHvlNotificationTemplateModelHvlResponseHvlPageHvlNotificationTemplateDataModelHvlResponseVoidHvlSort
uid
startDate
endDate
description (optional)
summary
location (optional)
organizer
attendee
status (optional)
TENTATIVE
CONFIRMED
CANCELLED
NEEDS_ACTION
COMPLETED
IN_PROCESS
DRAFT
FINAL
code
toAddressList (optional)
ccAddressList (optional)
bccAddressList (optional)
locale (optional)
attributeMap (optional)
attachmentList (optional)
sendSync (optional)
reCheck (optional)
produceDate (optional)
calendar (optional)
uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
errorArguments (optional)
fileName (optional)
content (optional)
code
toAddressList (optional)
ccAddressList (optional)
bccAddressList (optional)
locale (optional)
attributeMap (optional)
attachmentList (optional)
sendSync (optional)
reCheck (optional)
produceDate (optional)
code
toAddressList (optional)
ccAddressList (optional)
bccAddressList (optional)
locale (optional)
attributeMap (optional)
attachmentList (optional)
sendSync (optional)
reCheck (optional)
produceDate (optional)
content
code
locale (optional)
attributeMap (optional)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
sender
subject
contentType
STRING
FILE
content
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
name (optional)
code (optional)
description (optional)
type (optional)
SMS
MAIL
BASE_MAIL
enabled (optional)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
name (optional)
code
description (optional)
type
SMS
MAIL
BASE_MAIL
contentMap (optional)
pageable (optional)
filters (optional)
id (optional)
uuid (optional)
code (optional)
name (optional)
locale (optional)
notificationType (optional)
SMS
MAIL
BASE_MAIL
deleted (optional)
enabled (optional)
language (optional)
displayName (optional)
country (optional)
variant (optional)
script (optional)
unicodeLocaleAttributes (optional)
unicodeLocaleKeys (optional)
displayLanguage (optional)
displayScript (optional)
displayCountry (optional)
displayVariant (optional)
extensionKeys (optional)
iso3Language (optional)
iso3Country (optional)
totalElements (optional)
totalPages (optional)
pageable (optional)
data (optional)
pageNumber (optional)
pageSize (optional)
sort (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
direction (optional)
ASC
DESC
UNSORTED
properties (optional)