GET api/notifications/notifications?type={type}&page={page}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
type | string |
Required |
|
page | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
NotificationOutListByTypeName | Description | Type | Additional information |
---|---|---|---|
data | Collection of NotificationOutListItem |
None. |
|
TotalNewestCount | integer |
None. |
|
Total | integer |
None. |
|
Per_Page | integer |
None. |
|
Current_Page | integer |
None. |
|
Last_Page | integer |
None. |
|
From | integer |
None. |
|
To | integer |
None. |
|
_pageSkip | integer |
None. |
|
_pageSize | integer |
None. |
|
Success | boolean |
None. |
|
Errors | Collection of OutError |
None. |
Response Formats
application/json, text/json
Sample:
{ "data": [ { "Title": "sample string 1", "Description": "sample string 2", "CategoryId": "sample string 3", "DateCreated": "2024-11-28T01:50:17.8331141+08:00", "Status": "sample string 4", "IconPath": "sample string 5" }, { "Title": "sample string 1", "Description": "sample string 2", "CategoryId": "sample string 3", "DateCreated": "2024-11-28T01:50:17.8331141+08:00", "Status": "sample string 4", "IconPath": "sample string 5" } ], "TotalNewestCount": 1, "Total": 2, "Per_Page": 3, "Current_Page": 4, "Last_Page": 5, "From": 6, "To": 7, "_pageSkip": 8, "_pageSize": 9, "Success": true, "Errors": [ { "ErrorCode": "sample string 1", "ErrorMessage": "sample string 2" }, { "ErrorCode": "sample string 1", "ErrorMessage": "sample string 2" } ] }
application/xml, text/xml
Sample:
<Notiifcations.NotificationOutListByType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.EZTOneApp.Services.Models.ApiModels"> <Errors> <BaseApi.OutError> <ErrorCode>sample string 1</ErrorCode> <ErrorMessage>sample string 2</ErrorMessage> </BaseApi.OutError> <BaseApi.OutError> <ErrorCode>sample string 1</ErrorCode> <ErrorMessage>sample string 2</ErrorMessage> </BaseApi.OutError> </Errors> <Success>true</Success> <Current_Page>4</Current_Page> <From>6</From> <Last_Page>5</Last_Page> <Per_Page>3</Per_Page> <To>7</To> <Total>2</Total> <_pageSize>9</_pageSize> <_pageSkip>8</_pageSkip> <TotalNewestCount>1</TotalNewestCount> <data> <Notiifcations.NotificationOutListItem> <CategoryId>sample string 3</CategoryId> <DateCreated>2024-11-28T01:50:17.8331141+08:00</DateCreated> <Description>sample string 2</Description> <IconPath>sample string 5</IconPath> <Status>sample string 4</Status> <Title>sample string 1</Title> </Notiifcations.NotificationOutListItem> <Notiifcations.NotificationOutListItem> <CategoryId>sample string 3</CategoryId> <DateCreated>2024-11-28T01:50:17.8331141+08:00</DateCreated> <Description>sample string 2</Description> <IconPath>sample string 5</IconPath> <Status>sample string 4</Status> <Title>sample string 1</Title> </Notiifcations.NotificationOutListItem> </data> </Notiifcations.NotificationOutListByType>