Recombee API Client
|
Insert to series More...
Public Member Functions | |
InsertToSeries (string seriesId, string itemType, string itemId, double time, bool? cascadeCreate=null) | |
Construct the request More... | |
override string | Path () |
| |
override Dictionary< string, object > | QueryParameters () |
Get query parameters More... | |
override Dictionary< string, object > | BodyParameters () |
Get body parameters More... | |
![]() | |
Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false) | |
Construct the request More... | |
Properties | |
string | SeriesId [get] |
ID of the series to be inserted into. More... | |
string | ItemType [get] |
item iff the regular item from the catalog is to be inserted, series iff series is inserted as the item. More... | |
string | ItemId [get] |
ID of the item iff itemType is item . ID of the series iff itemType is series . More... | |
double | Time [get] |
Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time. More... | |
bool? | CascadeCreate [get] |
Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the seriesId and the itemId . If cascadeCreate is set true, the behavior also depends on the itemType . Either item or series may be created if not present in the database. More... | |
![]() | |
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 | |
![]() | |
double | ConvertToUnixTimestamp (DateTime date) |
| |
Insert to series
Inserts an existing item/series into series of given seriesId at position determined by time.
|
inline |
Construct the request
seriesId | ID of the series to be inserted into. |
itemType | item iff the regular item from the catalog is to be inserted, series iff series is inserted as the item. |
itemId | ID of the item iff itemType is item . ID of the series iff itemType is series . |
time | Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time. |
cascadeCreate | Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the seriesId and the itemId . If cascadeCreate is set true, the behavior also depends on the itemType . Either item or series may be created if not present in the database. |
|
inlinevirtual |
Get body parameters
Implements Recombee.ApiClient.ApiRequests.Request.
|
inlinevirtual |
Implements Recombee.ApiClient.ApiRequests.Request.
|
inlinevirtual |
Get query parameters
Implements Recombee.ApiClient.ApiRequests.Request.
|
get |
Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the seriesId
and the itemId
. If cascadeCreate
is set true, the behavior also depends on the itemType
. Either item or series may be created if not present in the database.
|
get |
ID of the item iff itemType
is item
. ID of the series iff itemType
is series
.
|
get |
item
iff the regular item from the catalog is to be inserted, series
iff series is inserted as the item.
|
get |
ID of the series to be inserted into.
|
get |
Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.