GET api/article/articles
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| currentPage | integer |
None. |
|
| categories | Collection of integer |
None. |
|
| colours | Collection of string |
None. |
|
| keywords | string |
None. |
|
| lang | string |
Required |
|
| pageSize | integer |
None. |
|
| segments | Collection of integer |
None. |
|
| types | Collection of integer |
None. |
|
| isFrench | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
ArticlesAndFiltersViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| count | integer |
Required |
|
| filters | FiltersListViewModel |
Required |
|
| items | Collection of ArticleViewModel |
Required |
Response Formats
application/json, text/json
Sample:
{
"count": 1,
"filters": {
"categories": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
],
"colours": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
],
"segments": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
],
"types": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
]
},
"items": [
{
"colours": [
"sample string 1",
"sample string 2"
],
"id": 1,
"name": "sample string 2",
"imageUrl": "sample string 3"
},
{
"colours": [
"sample string 1",
"sample string 2"
],
"id": 1,
"name": "sample string 2",
"imageUrl": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<results xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel.ViewModel">
<count>1</count>
<filters>
<categories>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
</categories>
<colours>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
</colours>
<segments>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
</segments>
<types>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
<filter>
<id>sample string 1</id>
<name>sample string 2</name>
</filter>
</types>
</filters>
<items>
<article>
<colours xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</colours>
<id>1</id>
<imageUrl>sample string 3</imageUrl>
<name>sample string 2</name>
</article>
<article>
<colours xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</colours>
<id>1</id>
<imageUrl>sample string 3</imageUrl>
<name>sample string 2</name>
</article>
</items>
</results>