mail-notifications
Operations addressed under /mail-notifications — 10 operations.
get-mail-notification-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<MailNotificationDto>.
| Field | Declared type | Nullable |
|---|---|---|
Severity | int? | yes |
Correlationid | Guid? | yes |
NotifyDatetime | DateTime? | yes |
Status | int? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-mail-notification-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-mail-notification
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
create-mail-notification › Request Body
correlationIdnotifyDateTimeseverityPermitted values — validated against the severity parameter.
| Value | Meaning |
|---|---|
1 | OTP |
2 | Transaction |
3 | Marketting |
Permitted values — validated against the severity parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | OTP | ar: رمز التحقق لمرة واحدة |
2 | Transaction | ar: عملية |
3 | Marketting | ar: التسويق |
statusPermitted values — validated against the notification_status parameter.
| Value | Meaning |
|---|---|
1 | Waiting |
2 | Success |
3 | Error |
Permitted values — validated against the notification_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Waiting | ar: نجاح |
2 | Success | ar: خطأ |
3 | Error | no label seeded |
create-mail-notification › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-mail-notification-detail-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<MailNotificationDetailDto>.
| Field | Declared type | Nullable |
|---|---|---|
NotifyDate | DateOnly | no |
MailNotificationId | Guid | no |
NotificationType | int | no |
TemplateDesignId | Guid? | yes |
DmsQueryId | Guid? | yes |
LanguageCode | string | no |
MailTo | string | no |
MailCc | string | no |
MailBcc | string | no |
MailSubject | string | no |
MailBody | string | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-mail-notification-detail-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
get-mail-notification-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as MailNotificationDto.
| Field | Declared type | Nullable |
|---|---|---|
Severity | int? | yes |
Correlationid | Guid? | yes |
NotifyDatetime | DateTime? | yes |
Status | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_6 | 400 | MAIL_NOTIFICATION_NOT_FOUND | Mail notification cannot be found. |
path Parameters
idget-mail-notification-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
correlationididnotifyDatetimeseverityPermitted values — validated against the severity parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | OTP | ar: رمز التحقق لمرة واحدة |
2 | Transaction | ar: عملية |
3 | Marketting | ar: التسويق |
statusPermitted values — validated against the notification_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Waiting | ar: نجاح |
2 | Success | ar: خطأ |
3 | Error | no label seeded |
update-mail-notification
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_6 | 400 | MAIL_NOTIFICATION_NOT_FOUND | Mail notification cannot be found. |
path Parameters
idupdate-mail-notification › Request Body
correlationIdnotifyDateTimeseverityPermitted values — validated against the severity parameter.
| Value | Meaning |
|---|---|
1 | OTP |
2 | Transaction |
3 | Marketting |
Permitted values — validated against the severity parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | OTP | ar: رمز التحقق لمرة واحدة |
2 | Transaction | ar: عملية |
3 | Marketting | ar: التسويق |
statusPermitted values — validated against the notification_status parameter.
| Value | Meaning |
|---|---|
1 | Waiting |
2 | Success |
3 | Error |
Permitted values — validated against the notification_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Waiting | ar: نجاح |
2 | Success | ar: خطأ |
3 | Error | no label seeded |
update-mail-notification › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-mail-notification
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_6 | 400 | MAIL_NOTIFICATION_NOT_FOUND | Mail notification cannot be found. |
path Parameters
iddelete-mail-notification › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
create-mail-notification-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_12 | 400 | LANGUAGE_CODE_NOT_FOUND | Language code cannot be found. |
ERR_NTFC_3 | 400 | RECORD_ALSO_FOUND | Record already found. |
ERR_NTFC_6 | 400 | MAIL_NOTIFICATION_NOT_FOUND | Mail notification cannot be found. |
path Parameters
idcreate-mail-notification-detail › Request Body
dmsQueryIdlanguageCodemailBodymailSubjectmailTonotificationTypePermitted values — validated against the notification_type parameter.
| Value | Meaning |
|---|---|
1 | Broadcast |
2 | Personalized |
Permitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Broadcast | en: Broadcast · ar: البث |
2 | Personalized | en: Personalized · ar: مُخصص |
notifyDatetemplateDesignIdmailBccmailCccreate-mail-notification-detail › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-mail-notification-detail-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as MailNotificationDetailDto.
| Field | Declared type | Nullable |
|---|---|---|
NotifyDate | DateOnly | no |
MailNotificationId | Guid | no |
NotificationType | int | no |
TemplateDesignId | Guid? | yes |
DmsQueryId | Guid? | yes |
LanguageCode | string | no |
MailTo | string | no |
MailCc | string | no |
MailBcc | string | no |
MailSubject | string | no |
MailBody | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_13 | 400 | MAIL_NOTIFICATION_DETAIL_NOT_FOUND | Mail notification detail cannot be found. |
ERR_NTFC_6 | 400 | MAIL_NOTIFICATION_NOT_FOUND | Mail notification cannot be found. |
path Parameters
idmailNotificationDetailIdget-mail-notification-detail-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-mail-notification-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_12 | 400 | LANGUAGE_CODE_NOT_FOUND | Language code cannot be found. |
ERR_NTFC_13 | 400 | MAIL_NOTIFICATION_DETAIL_NOT_FOUND | Mail notification detail cannot be found. |
ERR_NTFC_6 | 400 | MAIL_NOTIFICATION_NOT_FOUND | Mail notification cannot be found. |
path Parameters
idmailNotificationDetailIdupdate-mail-notification-detail › Request Body
dmsQueryIdlanguageCodemailBodymailSubjectmailTonotificationTypePermitted values — validated against the notification_type parameter.
| Value | Meaning |
|---|---|
1 | Broadcast |
2 | Personalized |
Permitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Broadcast | en: Broadcast · ar: البث |
2 | Personalized | en: Personalized · ar: مُخصص |
notifyDatetemplateDesignIdmailBccmailCcupdate-mail-notification-detail › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-mail-notification-detail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_NTFC_13 | 400 | MAIL_NOTIFICATION_DETAIL_NOT_FOUND | Mail notification detail cannot be found. |
ERR_NTFC_6 | 400 | MAIL_NOTIFICATION_NOT_FOUND | Mail notification cannot be found. |
path Parameters
idmailNotificationDetailIddelete-mail-notification-detail › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.