Returns a set of data items of type notifications.
GET /api/dha/notifications
None
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| Subject | System.String | Read only: False | |
| ModuleName | System.String | Read only: False | |
| ResolveKey | System.String | Read only: False | |
| BodyHtml | System.String | Read only: False | |
| AccountName | System.String | Read only: False | |
| AdditionalMessageData | System.String | Read only: False | |
| TemplateSenderEmailAddress | System.String | Read only: False | |
| TemplateSenderName | System.String | Read only: False | |
| SystemMessage | System.String | Read only: False | |
| SystemUrl | System.String | Read only: False | |
| PlainTextVersion | System.String | Read only: False |
application/json
[
{
"Subject": "sample string 1",
"ModuleName": "sample string 2",
"ResolveKey": "sample string 3",
"BodyHtml": "sample string 4",
"AccountName": "sample string 5",
"AdditionalMessageData": "sample string 6",
"TemplateSenderEmailAddress": "sample string 7",
"TemplateSenderName": "sample string 8",
"SystemMessage": "sample string 9",
"SystemUrl": "sample string 10",
"PlainTextVersion": "sample string 11"
},
{
"Subject": "sample string 1",
"ModuleName": "sample string 2",
"ResolveKey": "sample string 3",
"BodyHtml": "sample string 4",
"AccountName": "sample string 5",
"AdditionalMessageData": "sample string 6",
"TemplateSenderEmailAddress": "sample string 7",
"TemplateSenderName": "sample string 8",
"SystemMessage": "sample string 9",
"SystemUrl": "sample string 10",
"PlainTextVersion": "sample string 11"
}
]Gets notifications item by id.
GET /api/dha/notifications({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| Subject | System.String | Read only: False | |
| ModuleName | System.String | Read only: False | |
| ResolveKey | System.String | Read only: False | |
| BodyHtml | System.String | Read only: False | |
| AccountName | System.String | Read only: False | |
| AdditionalMessageData | System.String | Read only: False | |
| TemplateSenderEmailAddress | System.String | Read only: False | |
| TemplateSenderName | System.String | Read only: False | |
| SystemMessage | System.String | Read only: False | |
| SystemUrl | System.String | Read only: False | |
| PlainTextVersion | System.String | Read only: False |
application/json
{
"Subject": "sample string 1",
"ModuleName": "sample string 2",
"ResolveKey": "sample string 3",
"BodyHtml": "sample string 4",
"AccountName": "sample string 5",
"AdditionalMessageData": "sample string 6",
"TemplateSenderEmailAddress": "sample string 7",
"TemplateSenderName": "sample string 8",
"SystemMessage": "sample string 9",
"SystemUrl": "sample string 10",
"PlainTextVersion": "sample string 11"
}Gets Id property from notifications item.
GET /api/dha/notifications({key})/property
| Name | Description | Type | Additional Information |
| key | System.Guid | Required | |
| property | System.String | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| Id | System.Guid | Read only: False |
application/json
{
"Id": "d3672516-a191-4e05-aa93-4af1b3450035"
}Creates a notifications item.
POST /api/dha/notifications
None
| Name | Description | Type | Additional Information |
| Subject | System.String | Read only: False | |
| ModuleName | System.String | Read only: False | |
| ResolveKey | System.String | Read only: False | |
| BodyHtml | System.String | Read only: False | |
| AccountName | System.String | Read only: False | |
| AdditionalMessageData | System.String | Read only: False | |
| TemplateSenderEmailAddress | System.String | Read only: False | |
| TemplateSenderName | System.String | Read only: False | |
| SystemMessage | System.String | Read only: False | |
| SystemUrl | System.String | Read only: False | |
| PlainTextVersion | System.String | Read only: False |
application/json
{
"Subject": "sample string 1",
"ModuleName": "sample string 2",
"ResolveKey": "sample string 3",
"BodyHtml": "sample string 4",
"AccountName": "sample string 5",
"AdditionalMessageData": "sample string 6",
"TemplateSenderEmailAddress": "sample string 7",
"TemplateSenderName": "sample string 8",
"SystemMessage": "sample string 9",
"SystemUrl": "sample string 10",
"PlainTextVersion": "sample string 11"
}Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| Subject | System.String | Read only: False | |
| ModuleName | System.String | Read only: False | |
| ResolveKey | System.String | Read only: False | |
| BodyHtml | System.String | Read only: False | |
| AccountName | System.String | Read only: False | |
| AdditionalMessageData | System.String | Read only: False | |
| TemplateSenderEmailAddress | System.String | Read only: False | |
| TemplateSenderName | System.String | Read only: False | |
| SystemMessage | System.String | Read only: False | |
| SystemUrl | System.String | Read only: False | |
| PlainTextVersion | System.String | Read only: False |
application/json
{
"Subject": "sample string 1",
"ModuleName": "sample string 2",
"ResolveKey": "sample string 3",
"BodyHtml": "sample string 4",
"AccountName": "sample string 5",
"AdditionalMessageData": "sample string 6",
"TemplateSenderEmailAddress": "sample string 7",
"TemplateSenderName": "sample string 8",
"SystemMessage": "sample string 9",
"SystemUrl": "sample string 10",
"PlainTextVersion": "sample string 11"
}Partial update for notifications item.
PATCH /api/dha/notifications({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
| Name | Description | Type | Additional Information |
| Subject | System.String | Read only: False | |
| ModuleName | System.String | Read only: False | |
| ResolveKey | System.String | Read only: False | |
| BodyHtml | System.String | Read only: False | |
| AccountName | System.String | Read only: False | |
| AdditionalMessageData | System.String | Read only: False | |
| TemplateSenderEmailAddress | System.String | Read only: False | |
| TemplateSenderName | System.String | Read only: False | |
| SystemMessage | System.String | Read only: False | |
| SystemUrl | System.String | Read only: False | |
| PlainTextVersion | System.String | Read only: False |
application/json
{
"Subject": "sample string 1",
"ModuleName": "sample string 2",
"ResolveKey": "sample string 3",
"BodyHtml": "sample string 4",
"AccountName": "sample string 5",
"AdditionalMessageData": "sample string 6",
"TemplateSenderEmailAddress": "sample string 7",
"TemplateSenderName": "sample string 8",
"SystemMessage": "sample string 9",
"SystemUrl": "sample string 10",
"PlainTextVersion": "sample string 11"
}Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Full update for notifications item.
PUT /api/dha/notifications({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
| Name | Description | Type | Additional Information |
| Subject | System.String | Read only: False | |
| ModuleName | System.String | Read only: False | |
| ResolveKey | System.String | Read only: False | |
| BodyHtml | System.String | Read only: False | |
| AccountName | System.String | Read only: False | |
| AdditionalMessageData | System.String | Read only: False | |
| TemplateSenderEmailAddress | System.String | Read only: False | |
| TemplateSenderName | System.String | Read only: False | |
| SystemMessage | System.String | Read only: False | |
| SystemUrl | System.String | Read only: False | |
| PlainTextVersion | System.String | Read only: False |
application/json
{
"Subject": "sample string 1",
"ModuleName": "sample string 2",
"ResolveKey": "sample string 3",
"BodyHtml": "sample string 4",
"AccountName": "sample string 5",
"AdditionalMessageData": "sample string 6",
"TemplateSenderEmailAddress": "sample string 7",
"TemplateSenderName": "sample string 8",
"SystemMessage": "sample string 9",
"SystemUrl": "sample string 10",
"PlainTextVersion": "sample string 11"
}Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Deletes a notifications item by Id.
DELETE /api/dha/notifications({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.