Metadata

API change history

API that provides Metadata information.

Halo Wars 2 - Spartan Ranks


Changelog

February 27, 2017:

  • Updated documentation to clarify the relationship between the Spartan Rank content item and the Spartan Rank Display Info content item.

February 21, 2017:

  • Added Endpoint.

Try it

Request

Request URL

Request parameters

  • (optional)
    number

    When specified, this indicates the index of the item to start at.

    When omitted, 0 is assumed.

    When the value contains a non-digit or is not a multiple of 100, HTTP 400 ("Bad Request") is returned.

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

{
  // Pagination information.
  "Paging": {

    // Index of the first item in this response in the collection of all available items
    // of this type.
    "StartAt": "int",

    // Count of items returned in this response.
    "InlineCount": "int",

    // Count of all available items of this type.
    "TotalCount": "int"
  },

  // Contents.
  "ContentItems": [
    {
      // Internal use.
      "Id": "int",

      // Name of the content type.
      // Contains the information for the content type.
      "View": {

        // Internal use.
        "Status": "Published",

        // Information common to all content types.
        "Common": {

          // Internal use.
          "Owner": "string",

          // Date the content was created. This is expressed as an ISO 8601 combined Date
          // and Time.
          "CreatedUtc": "string",

          // Date the content was last modified. This is expressed as an ISO 8601
          // combined Date and Time.
          "ModifiedUtc": "string",

          // Date the content was last published. This is expressed as an ISO 8601
          // combined Date and Time.
          "PublishedUtc": "string",

          // Internal use.
          "Container": "int"
        },

        // ID that identifies this content item in the Metadata API.
        "Identity": "guid",

        // Non-localized title of the content item. The title of the Spartan Rank content
        // item will be in sync with the Rank Number. For example, if the Rank Number is
        // 15, the title will be "Rank 15".
        "Title": "string",

        // Information about the Spartan Rank.
        "HW2SpartanRank": {

          // Minimum XP required to be this Spartan Rank.
          "StartXP": "int",

          // Packs awarded to players for earning this Spartan Rank.
          "Packs": [
            {
              // Internal use.
              "Id": "int",

              // Name of the content type.   
              "Type": "HW2Object",

              // ID that identifies this content item in the Metadata API.
              "Identity": "guid",

            }
          ],

          // Localized information for the content item that changes depending on the
          // "Accept-Language" Request Header. The progression of Spartan Ranks is set up
          // such that multiple Spartan Ranks might have the same name. This is modeled
          // in metadata by having multiple Spartan Rank content items use the same
          // Display Info content item. For example, at the time of writing this
          // documentation, Spartan Rank 15 and 16 are both named "Master Sergeant" and
          // will therefore use the same Display Info content item. 
          "DisplayInfo": {

            // Internal use.
            "Id": "int",

            // Name of the content type.
            "Type": "HW2SpartanRankDisplayInfo",

            // Contains the information for the content type.
            "View": {

              // Internal use.
              "Status": "string",

              // Information common to all content types.
              "Common": {

                // Internal use.
                "Owner": "string",

                // Date the content was created. This is expressed as an ISO 8601
                // combined Date and Time.
                "CreatedUtc": "string",

                // Date the content was last modified. This is expressed as an ISO 8601
                // combined Date and Time.
                "ModifiedUtc": "string",

                // Date the content was last published. This is expressed as an ISO 8601
                // combined Date and Time.
                "PublishedUtc": "string",

                // Internal use.
                "Container": "int"
              },

              // ID that identifies this content item in the Metadata API.
              "Identity": "guid",

              // Non-localized title of the content item. It is suggested to ignore this
              // title. Since multiple Spartan Rank content items may use the same
              // Display Info content item, this title might not be in agreement with the
              // title of the Spartan Rank content item that is using it. This title is
              // usually the title of the first Spartan Rank content item that used this
              // Display Info content item. For example, at the time of writing this
              // documentation, Spartan Rank 15 and 16 have the same name and will
              // therefore use the same Display Info content item with title "Rank 15".
              "Title": "string",

              // Internal use.
              "BatchLocalization": {

                "IsLocked": "bool"
              },

              // Localization information.
              "Localization": {

                // Localization culture.
                "Culture": "string",

                // Internal use.
                "MasterContentItemId": "guid"
              },

              // Localized information for the Spartan Rank.
              "HW2SpartanRankDisplayInfo": {

                // Localized name of the Spartan Rank. This is the name of the rank that
                // is displayed in the game in conjunction with the Rank Number. The same
                // name may be used for multiple Spartan Ranks. See the documentation for
                // the Display Info above for more information.
                "Name": "string"
              }
            }
          },

          // Rank number for this Spartan Rank. This is the number that appears in the
          // game that describes the rank.
          "RankNumber": "int"
        }
      },

      // Internal use.
      "Links": [{
        "Absolute": "bool",

        "Relation": "string",

        "URI": "string"
      }],

      // Internal use.
      "ChildrenCount": "int"
    }
  ]
}

Code samples

@ECHO OFF

curl -v -X GET "https://www.haloapi.com/metadata/hw2/spartan-ranks?startAt={number}"
-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}");

            // Request parameters
            queryString["startAt"] = "{number}";
            var uri = "https://www.haloapi.com/metadata/hw2/spartan-ranks?" + 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/hw2/spartan-ranks");

            builder.setParameter("startAt", "{number}");

            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
            "startAt": "{number}",
        };
      
        $.ajax({
            url: "https://www.haloapi.com/metadata/hw2/spartan-ranks?" + $.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/hw2/spartan-ranks";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"startAt={number}",
                      ];
    
    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/hw2/spartan-ranks');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'startAt' => '{number}',
);

$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({
    # Request parameters
    'startAt': '{number}',
})

try:
    conn = httplib.HTTPSConnection('www.haloapi.com')
    conn.request("GET", "/metadata/hw2/spartan-ranks?%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({
    # Request parameters
    'startAt': '{number}',
})

try:
    conn = http.client.HTTPSConnection('www.haloapi.com')
    conn.request("GET", "/metadata/hw2/spartan-ranks?%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/hw2/spartan-ranks')

query = URI.encode_www_form({
    # Request parameters
    'startAt' => '{number}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

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