Use this API operation to return a list of AdultWork.com newsfeed on the criteria you pass in.
GET
/v1/search/searchNewsFeeds
Property | Type | Description |
---|---|---|
PageSize |
integer | Sets the number of newsfeed on each page of the result set. Accepts values from 1 to 100 . Default is 50 . |
PageNumber |
integer | Returns a specific page in the result set. Accepts values from 1 onwards. |
UserID |
integer | Returns all newsfeed of the profile with the specified UserID. When the parameter is not supplied and IsHotlist is set to false , only the newsfeed of the last 24 hours will be returned. |
GenderIDs |
string | Returns newsfeed for profiles that have selected their Gender to one that relates to a Gender ID within GenderIDs . Accepts a comma delimited string of Gender IDs, for example: 1,2 . See the getGenders method. |
IsHotlist |
boolean | If set to true returns newsfeed of the profiles within the hotlist of the authenticated user using OAuth. Default is false . When UserID is not supplied and IsHotlist is set to false only the newsfeed of the last 24 hours will be returned. |
IsVerified |
boolean | If set to true the API returns newsfeed for profiles that are fully verified members. Default is false . |
ExcludeTVTS |
boolean | If set to true exclude from the result the newsfeed of profiles that have checked the option TV/TS in their profile details. |
DateFrom |
datetime | The start date of which the newsfeed took place. Format is yyyy-MM-dd . When UserID is not supplied and IsHotlist is set to false only the newsfeed of the last 24 hours will be returned. |
DateTo |
datetime | The end date of which the newsfeed took place. Format is yyyy-MM-dd . When UserID is not supplied and IsHotlist is set to false only the newsfeed of the last 24 hours will be returned. |
Parameters can be passed to this operation using the HTTP GET method with serialized JSON in the request body, or the HTTP GET method by passing parameters over the query string of the URI.
The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.
This endpoint has the following optional headers:
Headers | Value | |
---|---|---|
X-MaskImages |
1 |
What's this? |
Your API-Key is required with every request if you don't supply the Authorization header and can be passed in as a header or a query-string parameter. Don't have an API-Key? Get one now.
An Authorization header is optional with every request and must contain the access_token of the user. To let the API return news feed items of profiles in the logged in user's hotlist, this is required.
This endpoint does not require any additional scopes.
Property | Type | Description |
---|---|---|
PageCount |
integer | Represents the total number of pages in the result set. |
PageNumber |
integer | Represents the current page number. |
NewsFeedTotal |
integer | Represents the total number of newsfeed in the result set. |
PageSize |
integer | Represents how many newsfeed are listed on each page. |
NewsFeed |
Array of aws:NewsFeed | List of newsfeed data. |
The following example returns a single newsfeed.