GET api/modules/supportdesk/conversations/notifications?pageIndex={pageIndex}&pageSize={pageSize}&filter={filter}&since={since}&until={until}&content={content}&sortColumn={sortColumn}&sortDirection={sortDirection}&supportDeskConfigurationId={supportDeskConfigurationId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
pageIndex | integer |
Required |
|
pageSize | integer |
Required |
|
filter | SupportDeskConversationsWidgetFilter |
Required |
|
since | decimal number |
None. |
|
until | decimal number |
None. |
|
content | string |
None. |
|
sortColumn | SupportDeskConversationsWidgetSortColumn |
Default value is AwaitingReplySince |
|
sortDirection | SortOrder |
Default value is Ascending |
|
supportDeskConfigurationId | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ReadSupportDeskConversationsNotificationsViewModelName | Description | Type | Additional information |
---|---|---|---|
Notifications | Collection of ReadSupportDeskConversationNotificationViewModel |
None. |
|
NumberOfUnsettledConversationsRelatedToMe | integer |
None. |
|
NumberOfUnsettledConversationsRelatedToNoone | integer |
None. |
|
NumberOfUnsettledConversationsRelatedToOrganization | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Notifications": [ { "AwaitingReplySince": 1.1, "Id": 2, "Subject": "sample string 3", "TicketEntityInstanceId": 4, "UnreadMessages": "sample string 5" }, { "AwaitingReplySince": 1.1, "Id": 2, "Subject": "sample string 3", "TicketEntityInstanceId": 4, "UnreadMessages": "sample string 5" } ], "NumberOfUnsettledConversationsRelatedToMe": 1, "NumberOfUnsettledConversationsRelatedToNoone": 2, "NumberOfUnsettledConversationsRelatedToOrganization": 3 }
application/xml, text/xml
Sample:
<ReadSupportDeskConversationsNotificationsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels"> <Notifications> <ReadSupportDeskConversationNotificationViewModel> <AwaitingReplySince>1.1</AwaitingReplySince> <Id>2</Id> <Subject>sample string 3</Subject> <TicketEntityInstanceId>4</TicketEntityInstanceId> <UnreadMessages>sample string 5</UnreadMessages> </ReadSupportDeskConversationNotificationViewModel> <ReadSupportDeskConversationNotificationViewModel> <AwaitingReplySince>1.1</AwaitingReplySince> <Id>2</Id> <Subject>sample string 3</Subject> <TicketEntityInstanceId>4</TicketEntityInstanceId> <UnreadMessages>sample string 5</UnreadMessages> </ReadSupportDeskConversationNotificationViewModel> </Notifications> <NumberOfUnsettledConversationsRelatedToMe>1</NumberOfUnsettledConversationsRelatedToMe> <NumberOfUnsettledConversationsRelatedToNoone>2</NumberOfUnsettledConversationsRelatedToNoone> <NumberOfUnsettledConversationsRelatedToOrganization>3</NumberOfUnsettledConversationsRelatedToOrganization> </ReadSupportDeskConversationsNotificationsViewModel>