Metadata

API change history

API that provides Metadata information.

Halo 5 - Requisition


Changelog

February 21, 2017:

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

Try it

Request

Request URL

Request parameters

  • string

    An ID that uniquely identifies a Requisition.

Request headers

  • (optional)
    string

    The desired language for the Metadata.

  • 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

// A list of requisitions for the title. There is no significance to the ordering.
[
  {
    // This lists all the game modes that this requisition is redeemable in. Options are:
    //   - Arena
    //   - Campaign
    //   - Custom
    //   - Warzone
    "supportedGameModes": [
      "string"
    ],

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

    // A localized description, suitable for display to users.
    "description": "string",

    // The non-localized rarity. Indicates the scarcity and thus rarity of the
    // requisition. The options are (in increasing order of rarity):
    //   - Common
    //   - Uncommon
    //   - Rare
    //   - UltraRare
    //   - Legendary
    "rarityType": "string",

    // The localized rarity suitable for display to users. Indicates the scarcity and
    // thus rarity of the requisition
    "rarity": "string",

    // Indicates if this requisition has been flagged as having 'mythic status'.
    "isMythic": "boolean",

    // Indicates if this item is a Certification. Certifications will always be durable
    // and are required to earn certain other requisitions.
    "isCertification": "boolean",

    // Indicates whether the requisition is wearable.
    "isWearable": "boolean",

    // Indicates if the requisition counts towards collection completion. If true, this
    // requisition will not be shown as unearned in the game. 
    // This behavior is typically used for specialty requisitions that aren't awarded
    // through normal progression flows.
    "hideIfNotAcquired": "boolean",

    // Indicates how the requisition card may be used. Options are:
    //   - Consumable
    //   - Durable
    //   - Boost
    //   - CreditGranting
    // Consumable: The requisition can be called in and used while in-game. When players
    // call in a consumable requisition it is removed from the players inventory.
    // Durable: The requisition is not usable in-game. Players can only earn one of each
    // durable requisition and it is used to model awards such as armor suits, helmets,
    // emblems or other items such as stickers. Durables are never removed from the
    // player inventory.
    // Boost: The requisition is used prior to a match beginning and will modify how many
    // XP or Credits the player will earn at the end of the match. When put into effect,
    // it is removed from the player inventory.
    // Credit Granting: When obtained, the requisition will grant the player some amount
    // of credits. Once the credits are granted the requisition is immediately removed
    // from the player inventory.
    "useType": "string",

    // A reference to a large image for icon use. This may be null if there is no image
    // defined.
    "largeImageUrl": "string",

    // A reference to a medium image for icon use. This may be null if there is no image
    // defined.
    "mediumImageUrl": "string",

    // A reference to a small image for icon use. This may be null if there is no image
    // defined.
    "smallImageUrl": "string",

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

    // Internal use. A non-localized name for the category of the requisition.
    "internalCategoryName": "string",

    // A localized name for the sub-category of the requisition, suitable for display to
    // users. The text is title cased.
    "subcategoryName": "string",

    // The order of the subcategory in the category.
    "subcategoryOrder": "int",

    // This field indicates how many credits the player will receive if they wish to
    // discard this requisition. When SellPrice is zero, the card cannot be sold back for
    // credits.
    "sellPrice": "int",

    // The energy level required in order to use this requisition in a Warzone game.
    "levelRequirement": "int",

    // For requisitions where the useType is CreditGranting, this field indicates how
    // many credits the player is rewarded with. When the requisition is not
    // CreditGranting, this value is zero.
    "creditsAwarded": "int",

    // If this is set, this is the ID of the Certification Requisition that is required
    // to earn this requisition.
    "certificationRequisitionId": "guid",

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

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

404 Not Found

Specified Requisition was not found.

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://www.haloapi.com/metadata/h5/metadata/requisitions/{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/requisitions/{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/requisitions/{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/requisitions/{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/requisitions/{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/requisitions/{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/requisitions/{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/requisitions/{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/requisitions/{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