Recombee API Client
Public Member Functions | Properties | List of all members
Recombee.ApiClient.ApiRequests.ListItems Class Reference

List items More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.ListItems:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.ApiRequests.ListItems:
Collaboration graph
[legend]

Public Member Functions

 ListItems (string filter=null, long?count=null, long?offset=null, bool?returnProperties=null, string[] includedProperties=null)
 Construct the request More...
 
override string Path ()
 
Returns
URI to the endpoint including path parameters
More...
 
override Dictionary< string, object > QueryParameters ()
 Get query parameters More...
 
override Dictionary< string, object > BodyParameters ()
 Get body parameters More...
 
- Public Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
 Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false)
 Construct the request More...
 

Properties

string Filter [get]
 Boolean-returning ReQL expression, which allows you to filter items to be listed. Only the items for which the expression is true will be returned. More...
 
long Count [get]
 The number of items to be listed. More...
 
long Offset [get]
 Specifies the number of items to skip (ordered by itemId). More...
 
bool ReturnProperties [get]
 With returnProperties=true, property values of the listed items are returned along with their IDs in a JSON dictionary. Example response:

[
{
"itemId": "tv-178",
"description": "4K TV with 3D feature",
"categories": ["Electronics", "Televisions"],
"price": 342,
"url": "myshop.com/tv-178"
},
{
"itemId": "mixer-42",
"description": "Stainless Steel Mixer",
"categories": ["Home & Kitchen"],
"price": 39,
"url": "myshop.com/mixer-42"
}
]
More...
 
string[] IncludedProperties [get]
 Allows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=description,price:

[
{
"itemId": "tv-178",
"description": "4K TV with 3D feature",
"price": 342
},
{
"itemId": "mixer-42",
"description": "Stainless Steel Mixer",
"price": 39
}
]
More...
 
- Properties inherited from Recombee.ApiClient.ApiRequests.Request
TimeSpan Timeout [get, set]
 Timeout for the request in milliseconds More...
 
bool EnsureHttps [get]
 If true, HTTPS must be chosen over HTTP for this request More...
 
HttpMethod RequestHttpMehod [get]
 Used HTTP method More...
 

Additional Inherited Members

- Protected Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
double ConvertToUnixTimestamp (DateTime date)
 
Returns
Converts DateTime to UNIX timestamp (epoch)
More...
 

Detailed Description

List items

Gets a list of IDs of items currently present in the catalog.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.ListItems.ListItems ( string  filter = null,
long?  count = null,
long?  offset = null,
bool?  returnProperties = null,
string[]  includedProperties = null 
)
inline

Construct the request

Parameters
filterBoolean-returning ReQL expression, which allows you to filter items to be listed. Only the items for which the expression is true will be returned.
countThe number of items to be listed.
offsetSpecifies the number of items to skip (ordered by itemId).
returnPropertiesWith returnProperties=true, property values of the listed items are returned along with their IDs in a JSON dictionary. Example response:
[
{
"itemId": "tv-178",
"description": "4K TV with 3D feature",
"categories": ["Electronics", "Televisions"],
"price": 342,
"url": "myshop.com/tv-178"
},
{
"itemId": "mixer-42",
"description": "Stainless Steel Mixer",
"categories": ["Home & Kitchen"],
"price": 39,
"url": "myshop.com/mixer-42"
}
]
includedPropertiesAllows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=description,price:
[
{
"itemId": "tv-178",
"description": "4K TV with 3D feature",
"price": 342
},
{
"itemId": "mixer-42",
"description": "Stainless Steel Mixer",
"price": 39
}
]

Member Function Documentation

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.ListItems.BodyParameters ( )
inlinevirtual

Get body parameters

Returns
Dictionary containing values of body parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

override string Recombee.ApiClient.ApiRequests.ListItems.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.ListItems.QueryParameters ( )
inlinevirtual

Get query parameters

Returns
Dictionary containing values of query parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

long Recombee.ApiClient.ApiRequests.ListItems.Count
get

The number of items to be listed.

string Recombee.ApiClient.ApiRequests.ListItems.Filter
get

Boolean-returning ReQL expression, which allows you to filter items to be listed. Only the items for which the expression is true will be returned.

string [] Recombee.ApiClient.ApiRequests.ListItems.IncludedProperties
get

Allows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=description,price:

[
{
"itemId": "tv-178",
"description": "4K TV with 3D feature",
"price": 342
},
{
"itemId": "mixer-42",
"description": "Stainless Steel Mixer",
"price": 39
}
]

long Recombee.ApiClient.ApiRequests.ListItems.Offset
get

Specifies the number of items to skip (ordered by itemId).

bool Recombee.ApiClient.ApiRequests.ListItems.ReturnProperties
get

With returnProperties=true, property values of the listed items are returned along with their IDs in a JSON dictionary. Example response:

[
{
"itemId": "tv-178",
"description": "4K TV with 3D feature",
"categories": ["Electronics", "Televisions"],
"price": 342,
"url": "myshop.com/tv-178"
},
{
"itemId": "mixer-42",
"description": "Stainless Steel Mixer",
"categories": ["Home & Kitchen"],
"price": 39,
"url": "myshop.com/mixer-42"
}
]


The documentation for this class was generated from the following file: