listRentalOffers

Offers are presented in descending order based on the creation date.

📘

You can try that method by clicking here

Parameters

Name

Type

Description

publisherToken*

string

You can find your publisher token at api-keys page.

criteria

object

No description

-active*

boolean

By default you get list of active offers. To get inactive offers, set this field to false.

offset*

integer

From which offer you want to get results. Helpful in pagination.

limit*

integer

Number of results you want to retrieve. E.g. if you want to display 10 offers per page, and you are on third, just set limit to 10 and offset to 20.

videoId

string

Unique identifier of your video asset.

API Request/Response

Request

{
  "method":"listRentalOffers",
  "params":{
   "publisherToken":"Xlrx-SjTLVMCsaRsOf2q2hvWKOlrF57yHknDRRRMX-13Fz-x",
   "criteria":{
     "active":"1"
   },
   "offset":"0",
   "limit":"2"
  },
  "jsonrpc":"2.0",
  "id":1
}

Response

{
  "result":{
    "items":[
      {
        "id":"R113110933_US",
        "publisherEmail":"[email protected]",
        "url":"http:\/\/demos.cleeng.com\/wordpress\/test\/",
        "title":"Lady GaGa - Interview with Barbara Walters on 2020",
        "description":"About Lady GaGa's misconceptions, sexuality and more - watch real honest answers from Lady GaGa herself.",
        "currency":"EUR",
        "videoId":"",
        "contentExternalId":"0",
        "contentExternalData":null,
        "averageRating":4,
        "active":1,
        "createdAt":1301479225,
        "updatedAt":1351701013,
        "price":0.45,
        "applicableTaxRate":0,
        "tags":[

        ],
        "period":"48"
      },
      {
        "id":"R999839789_US",
        "publisherEmail":"[email protected]",
        "url":"demos.cleeng.com\/bizdev\/colliderbox",
        "title":"Collider box office",
        "description":"See the complete analysis of the box office",
        "currency":"EUR",
        "videoId":"",
        "contentExternalId":"0",
        "contentExternalData":null,
        "averageRating":4,
        "active":1,
        "createdAt":1302613384,
        "updatedAt":1302613384,
        "price":0.35,
        "applicableTaxRate":0,
        "tags":[

        ],
        "period":"48"
      }
    ],
      "totalItemCount":59
  },
  "id":"1",
  "error":null,
  "jsonrpc":"2.0"
}

PHP Example

<?php
    $cleengApi = new Cleeng_Api();
    $cleengApi->setPublisherToken('TeurE3xRXcFtF7gSbhYCXx_qC1IrvnDWGejDv114-OE0cdZ9');

    $offerList = $cleengApi->listRentalOffers(array(), 0, 5);
    
?>