POST api/NewsAndAlerts/GetNewsandAlerts
To Get List of News and Alerts
Request Information
URI Parameters
None.
Body Parameters
NewsAndAlertsListInputModelName | Description | Type | Additional information |
---|---|---|---|
EffectiveStartDateFrom |
Gets or Sets Effective Start Date From |
date |
None. |
EffectiveStartDateTo |
Gets or Sets Effective Satart Date To |
date |
None. |
EffectiveEndDateFrom |
Gets or Sets Effective End Date From |
date |
None. |
EffectiveEndDateTo |
Gets or Sets Effective End Date To |
date |
None. |
Caption |
Gets or Sets News Caption |
string |
None. |
FileName |
Gets or Sets File Name |
string |
None. |
LanguageId |
Gets or Sets Language Id |
integer |
None. |
InstanceId |
Gets or Sets Instance Id |
integer |
None. |
SortParam |
Sort Param details |
integer |
None. |
PageIndex |
0 based index of the current page |
integer |
Required |
PageSize |
Page size |
integer |
Required |
SortFields |
List of Sort fields |
Collection of string |
None. |
Request Formats
application/json, text/json
{ "EffectiveStartDateFrom": "2024-04-24T23:29:21.6389792-07:00", "EffectiveStartDateTo": "2024-04-24T23:29:21.6389792-07:00", "EffectiveEndDateFrom": "2024-04-24T23:29:21.6389792-07:00", "EffectiveEndDateTo": "2024-04-24T23:29:21.6389792-07:00", "Caption": "sample string 1", "FileName": "sample string 2", "LanguageId": 1, "InstanceId": 1, "SortParam": 3, "PageIndex": 4, "PageSize": 5, "SortFields": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
<NewsAndAlertsListInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.API.Models"> <PageIndex>4</PageIndex> <PageSize>5</PageSize> <SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </SortFields> <Caption>sample string 1</Caption> <EffectiveEndDateFrom>2024-04-24T23:29:21.6389792-07:00</EffectiveEndDateFrom> <EffectiveEndDateTo>2024-04-24T23:29:21.6389792-07:00</EffectiveEndDateTo> <EffectiveStartDateFrom>2024-04-24T23:29:21.6389792-07:00</EffectiveStartDateFrom> <EffectiveStartDateTo>2024-04-24T23:29:21.6389792-07:00</EffectiveStartDateTo> <FileName>sample string 2</FileName> <InstanceId>1</InstanceId> <LanguageId>1</LanguageId> <SortParam>3</SortParam> </NewsAndAlertsListInputModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Collection of NewsAndAlertsListResponseViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Gets or Sets Id |
integer |
None. |
EffectiveStartDate |
Gets or Sets Effective Start Date |
string |
None. |
EffectiveEndDate |
Gets or Sets Effective End Date |
string |
None. |
InstanceId |
Gets or Sets Instance Id |
integer |
None. |
NewsAlertId |
Gets or Sets News Alert Id |
integer |
None. |
LanguageId |
Gets or Sets Language Id |
integer |
None. |
Caption |
Gets or Sets News Caption |
string |
None. |
TextContent |
Gets or Sets News Content |
string |
None. |
FileName |
Gets or Sets Attached File Name |
string |
None. |
SystemCode |
Gets or Sets System Code |
string |
None. |
SystemName |
Gets or Sets System Name |
string |
None. |
TotalCount |
Gets or Sets Total count of news and alerts |
integer |
None. |
CreatedDate |
Gets or Sets Created Date |
date |
None. |
CreatedUser |
Gets or Sets Created User |
string |
None. |
AdditionalInfo |
Gets or Sets Additional Info |
string |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.