07399 456 959 [email protected]

Gift Categories Content Object - Partial Request
Last updated: January 05 2022 11:19 PM

Fields Parameter Values Available For Gift Categories 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 a gift category or gift categories. A full list of fields query parameters for the gift categories content object are shown below.

Use a comma-separated list within the brackets to return multiple attributes. E.g, /?fields=giftcategories(heading,introduction)
Parameter Type Values Description and examples
fields
optional		 string heading Returns a heading for a gift category or gift categorires

/?fields=giftcategories(heading)
fields
optional		 string introduction Returns an introduction for a gift category or gift categorires


/?fields=giftcategories(introduction)

Gift Categories Content Object Partial Request Example

GET
https://api.uconvert.co.uk/deals/v1/gifts/categories/?fields=giftcategories(heading)
  • Eample Response
  • PHP
  • cURL
  • Javascript
  • Ruby
{
  "giftCategories" : [
    {
      "id": "2",
      "name": "Games Consoles Deals",
      "slug": "games-consoles-deals",
      "content": {
        "heading": "FREE games console with a mobile phone contract"
      }
    },
    {
      "id": "4",
      "name": "Laptops Deals",
      "slug": "laptops-deals",
      "content": {
        "heading": "FREE laptop with a mobile phone contract"
      }
    }
    {},
    {},
    {}
  ]
}

$curl = curl_init();

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

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.uconvert.co.uk/deals/v1/gifts/categories/?fields=giftcategories(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/gifts/categories/?fields=giftcategories(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
Previous - Gift Categories Content Object
Next - Gift Categories Meta Data Object