Metadata

API change history

API that provides Metadata information.

Halo 5 - Requisition Pack

Changelog

February 21, 2017:

Renamed Endpoint from "Requisition Packs" to "Halo 5 - Requisition Pack".
Removed "{title}" Request Parameter.
Documented "Accept-Language" Request Header.

Try it

Request

Request URL

https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}

Request parameters

id

string

An ID that uniquely identifies a Requisition Pack.

Request headers

Accept-Language (optional)

string

The desired language for the Metadata.
Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

The response body will contain the requested Metadata.

Representations

application/json

// A requisition pack for the title.
{
  // A localized name for the pack, suitable for display to users. The text is title
  // cased. 
  "name": "string",

  // A localized description, suitable for display to users.
  "description": "Your achievement on the field of battle will not go unrewarded.",

  // A large image for the pack.
  "largeImageUrl": "string",

  // A medium image for the pack.
  "mediumImageUrl": "string",

  // A small image for the pack.
  "smallImageUrl": "string",

  // Internal use. Whether the item should be featured ahead of others.
  "isFeatured": "boolean",

  // Internal use. Whether the item should be labeled as "new!"
  "isNew": "boolean",

  // If the pack is purchasable via credits, this value contains the number of credits a
  // player must spend to acquire one pack. This value is zero when
  // isPurchasableWithCredits is false.
  "creditPrice": "int",

  // If the pack is currently available for purchase by spending credits, then this value
  // is true.
  "isPurchasableWithCredits": "boolean",

  // If the pack might be obtainable through the Xbox Live Marketplace, then this value
  // is true.
  "isPurchasableFromMarketplace": "boolean",

  // If this pack might be obtainable through the Xbox Live Marketplace, this is the
  // product ID. Note: Pricing and availability within the Xbox Live marketplace is
  // controlled independently of this value. The presence of an Id in this field is not a
  // guarantee the product is purchasable. There may be geographic restrictions
  // restricting purchase in certain regions, or the item may not be currently
  // purchasable at all.
  "xboxMarketplaceProductId": "guid",

  // If this pack might be obtainable through the Xbox Live Marketplace, this is the URL
  // to the product.
  "xboxMarketplaceProductUrl": "string",

  // Internal use. The order in which packs are shown for merchandising purposes.
  "merchandisingOrder": "int",

  // Internal use. Indicates the visual treatment of the pack. This is one of the
  // following options:
  //   - None
  //   - New
  //   - Hot
  //   - LeavingSoon
  //   - MaximumValue
  //   - LimitedTime
  //   - Featured
  //   - BestSeller
  //   - Popular
  "flair": "string",

  // The ID that uniquely identifies this pack.
  "id": "guid",

  // Internal use only. Do not use.
  "contentId": "guid"
}

404 Not Found

Specified Requisition Pack was not found.

Representations

application/json

500 Internal Server Error

Internal Server Error

Representations

application/json

Code samples

@ECHO OFF

curl -v -X GET "https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}"
-H "Accept-Language: en"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.AcceptLanguage.Add(StringWithQualityHeaderValue.Parse("en"));
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Accept-Language", "en");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Accept-Language","en");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"en" forHTTPHeaderField:@"Accept-Language"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Accept-Language' => 'en',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Accept-Language': 'en',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('www.haloapi.com')
    conn.request("GET", "/metadata/h5/metadata/requisition-packs/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Accept-Language': 'en',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('www.haloapi.com')
    conn.request("GET", "/metadata/h5/metadata/requisition-packs/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://www.haloapi.com/metadata/h5/metadata/requisition-packs/{id}')

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Accept-Language'] = 'en'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body