POST v{version}/news
Gets paged result of news
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
query defition
NewsLimiterName | Description | Type | Additional information |
---|---|---|---|
PublishTypeIds | Collection of integer |
Required |
|
DateFrom |
This evaluates if the value of DateFrom is between start and end. Due to poor naming an additional property is added that does the same- DateBetweenStartAndEnd |
date |
Data type: Date |
DateBetweenStartAndEnd | date |
Data type: Date |
|
StartIsAfterOrEq | date |
Data type: Date |
|
CreatedAfterOrEq | date |
Data type: Date |
|
ID | integer |
None. |
|
Take | integer |
Range: inclusive between 0 and 200 |
|
Skip | integer |
Range: inclusive between 0 and 2147483647 |
|
Sort |
Available fields CreatedDate, Title, Firstname, Lastname |
string |
None. |
GetFormattetAndMappedSortString | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "PublishTypeIds": [ 1, 2 ], "DateFrom": "2025-03-12T04:45:20.3845549+01:00", "DateBetweenStartAndEnd": "2025-03-12T04:45:20.3845549+01:00", "StartIsAfterOrEq": "2025-03-12T04:45:20.3845549+01:00", "CreatedAfterOrEq": "2025-03-12T04:45:20.3845549+01:00", "ID": 1, "Take": 1, "Skip": 2, "Sort": "sample string 3" }
application/xml, text/xml
Sample:
<NewsLimiter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpeedadminApi.ViewModels"> <CreatedAfterOrEq>2025-03-12T04:45:20.3845549+01:00</CreatedAfterOrEq> <DateBetweenStartAndEnd>2025-03-12T04:45:20.3845549+01:00</DateBetweenStartAndEnd> <DateFrom>2025-03-12T04:45:20.3845549+01:00</DateFrom> <GetFormattetAndMappedSortString xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <ID>1</ID> <PublishTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </PublishTypeIds> <Skip>2</Skip> <Sort>sample string 3</Sort> <StartIsAfterOrEq>2025-03-12T04:45:20.3845549+01:00</StartIsAfterOrEq> <Take>1</Take> </NewsLimiter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
paged result
IPagedResultOfNewsViewModelName | Description | Type | Additional information |
---|---|---|---|
Results | Collection of NewsViewModel |
None. |
|
TotalResults | integer |
None. |
|
RequestResults | integer |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.