07399 456 959 [email protected]

Product Specification Object - Partial Request
Last updated: January 05 2022 11:19 PM

Fields Parameter Values Available For Products Specifications 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 products specifications object. A full list of fields value for the product specification object are shown below.

Use a comma-separated list to return multiple attributes. E.g, /?fields=products(weight,height,os)
Parameter Type Values Description and examples
fields
optional		 string os, family-os, weight, size, height, width, depth, screen-size, screen-pixel-density, screen-resolution, sim-type, display-type, handset-style, camera-front, camera-back, camera-flash, battery-type, chipset, cpu, gpu, nfc, sensors, fm-radio, 4g Returns individual or multiple product specifications

/?fields=products(os,size,weight)
/?fields=products(os,size,weight,height,width,depth)

Product Specification Object Partial Request Example

GET
https://api.uconvert.co.uk/deals/v1/products/?fields=products(os,sim-type)
  • Eample Response
  • PHP
  • cURL
  • Javascript
  • Ruby
{
  "products" : [
    {
      "id": "1044",
      "name": "Apple iPhone 6 16GB Space Grey",
      "slug": "apple-iphone-6-16gb-space-grey",
      "specs": {
        "os": "IOS 8.1",
        "simType": "Nano SIM"
      }
    }
  ]
}

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.uconvert.co.uk/deals/v1/products/?fields=products(os,sim-type)",
  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(os,sim-type)' \
  --header 'x-api-key: 123456'

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.uconvert.co.uk/deals/v1/products/?fields=products(os,sim-type)",
  "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(os,sim-type)")

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
Previous - Products Specification Object
Next - Products Deals Object