POST api/v1/search/publishedarticles?next={next}&pageSize={pageSize}

Retrieves article ids.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
next

Token given from first request that specifies where to continue getting more. If not specified, gets the most recent items.

string

None.

pageSize

The maximum number of items to return. Defaults to 10.

integer

Default value is 10

Body Parameters

Params to retrieve from. E.g. query, pagesize, PublicationIds

SearchParams
NameDescriptionTypeAdditional information
Query

string

None.

Mode

SearchMode

None.

Page

integer

None.

PageSize

integer

None.

SortOrder

OrderBy

None.

PublicationIds

Collection of string

None.

CategoryIds

Collection of integer

None.

IsCloaked

boolean

None.

UserArticleFilter

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Query": "sample string 1",
  "Mode": 0,
  "Page": 2,
  "PageSize": 3,
  "SortOrder": 0,
  "PublicationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "CategoryIds": [
    1,
    2
  ],
  "IsCloaked": true,
  "UserArticleFilter": "sample string 5"
}

application/xml, text/xml

Sample:
<SearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Search.Core.Models">
  <CategoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CategoryIds>
  <IsCloaked>true</IsCloaked>
  <Mode>MatchAny</Mode>
  <Page>2</Page>
  <PageSize>3</PageSize>
  <PublicationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PublicationIds>
  <Query>sample string 1</Query>
  <SortOrder>Default</SortOrder>
  <UserArticleFilter>sample string 5</UserArticleFilter>
</SearchParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultsOfString
NameDescriptionTypeAdditional information
Count

integer

None.

Items

Collection of string

None.

Next

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    "sample string 1",
    "sample string 2"
  ],
  "Next": "sample string 1",
  "Count": 1
}

application/xml, text/xml

Sample:
<SearchResultsOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Search.Models">
  <Count>1</Count>
  <Items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Items>
  <Next>sample string 1</Next>
</SearchResultsOfstring>