Skip to main content
07399 456 959 admin@uconvert.co.uk

Product Content Object - Partial Request
Last updated: December 07 2018 05:56 PM

Fields Parameter Values Available For Products Content Object

A way to improve the performance of your API request is by requesting a partial response receiving only the data that your application is interested in. This allows your application to perform more efficiently. By default, the server sends back the full representation of a resource you requested. For improved performance, you can request only the fields you need. To request a partial response, use the fields query parameter and specify the fields you want returned.

The fields query parameter is used to retrieve single or multiple fields in the response for the product content object. A full list of fields values for the product content object are shown below.

Use a comma-separated list to return multiple values. E.g, /?fields=products(heading,introduction)

Attribute Type Value Description and example
fields
optional
string heading A heading for the product

/?fields=products(heading)
fields
optional
string introduction An introduction for the product

/?fields=products(introduction)

Product Content Object Partial Request Example

GET
https://api.uconvert.co.uk/deals/v1/products/?fields=products(heading)
{
  "products" : [
    {
      "id": "1032",
      "name": "Apple iPhone 6 Plus 16GB Gold",
      "slug": "apple-iphone-6-plus-16gb-gold",
      "cheapestUpfrontCost": "20.00",
      "cheapestContractPrice": "26.12",
      "condition": "Refurbished",
      "colour": "Gold",
      "hexColour": "#d4ccc1",
      "capacity": "16GB",
      "content": {
        "heading": "Apple iPhone 6 Plus 16GB Gold mobile phone deals"
      }
    },
  ]
}
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.uconvert.co.uk/deals/v1/products/?fields=products(heading)",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "x-api-key: 123456"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
curl --request GET \
  --url 'https://api.uconvert.co.uk/deals/v1/products/?fields=products(heading)' \
  --header 'x-api-key: 123456'
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.uconvert.co.uk/deals/v1/products/?fields=products(heading)",
  "method": "GET",
  "headers": {
    "x-api-key": "123456"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
require 'uri'
require 'net/http'

url = URI("https://api.uconvert.co.uk/deals/v1/products/?fields=products(heading)")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '123456'

response = http.request(request)
puts response.read_body