UGC

API change history

API that provides Metadata about User-Generated Content (Maps and Game Variants).

Halo 5 - Player Game Variant

Retrieves Metadata about a Player-created Game Variant.


Changelog

February 21, 2017:

  • Renamed Endpoint from "Get Game Variant" to "Halo 5 - Player Game Variant".
  • Removed "{title}" Request Parameter.

August 5, 2016:

  • Added Endpoint.

Try it

Request URL

Request parameters

string

The Gamertag of the Player that owns the Game Variant.

string

The ID for the Game Variant.

Request headers

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

Request body

Response 200

The response body will contain the Metadata for the Player-created Game Variant.

{
  // Internal use only. This will always be 1.
  "BaseGameEngineType": "int",

  // Internal use only. This will always be 1.
  "GameType": "int",

  // The base game variant on which this variant is created.
  "BaseGame": {

    // The resource type. 8 indicates base game variant.
    "ResourceType": 8,

    // The ID of the base game variant.
    "ResourceId": "guid",

    // The source of the base game variant. will always be 3 (Official) for the BaseGame.
    "OwnerType": "int",

    // The gamertag of the user that created the base game variant if this is a
    // user-generated game variant, or null otherwise.
    "Owner": "string"
  },

  // The minimum score necessary for a player to win the match. A value of 0 indicates
  // the base game variant's default value is used.
  "ScoreToWin": "int",

  // The number of lives allowed. A value of 0 indicates the base game variant's default
  // value is used.
  "NumberOfLives": "int",

  // Maximum runtime of the match in seconds. A value of 0 indicates the base game
  // variant's default value is used.
  "MatchDurationInSeconds": "int",

  // The number of rounds in the match. A value of 0 indicates the base game variant's
  // default value is used.
  "NumberOfRounds": "int",

  // The name of the game variant.
  "Name": "sring",

  // The description of the game variant.
  "Description": "string",

  // Indicates the restrictions for access that apply to the game variant. possible
  // values are:
  //   Listed (game variant will show up in search results) = 0,
  //   Unlisted (game variant won't show up in search results) = 1,
  //   Unknown = 2.
  "AccessControl": "int",

  // Internal use only.
  "Links": "links",

  // The date that the game variant was created. The time component of this date is
  // always set to "00:00:00". This is expressed as an ISO 8601 combined Date and Time.
  "CreationTimeUtc": {

    "ISO8601Date": "string"
  },

  // The date that the game variant was last modified. The time component of this date is
  // always set to "00:00:00". This is expressed as an ISO 8601 combined Date and Time.
  "LastModifiedTimeUtc": {

    "ISO8601Date": "string"
  },

  // A flag indicating whether this file has been banned or not.
  "Banned": "boolean",

  // The identity of the game variant.
  "Identity": {

    // The resource type. 2 inidicates game variant.
    "ResourceType": 2,

    // The ID of the game varaint.
    "ResourceId": "guid",

    // The source of the game variant. will always be 1 (user generated).
    "OwnerType": 1,

    // The gamertag of the user that created the game variant.
    "Owner": "string"
  },

  // The set of aggregate statistics associated with this game variant.
  "Stats": {

    // The current number of active bookmarks on this game variant.
    "BookmarkCount": "int",

    // Internal use only. This will always be false.
    "HasCallerBookmarked": false
  }
}

Response 400

Specified Gamertag is malformed or the Game Variant ID is malformed.

Response 404

The player does not exist or the Game Variant does not exist in the provided Player's file share.

Response 500

Internal Server Error

Code samples

@ECHO OFF

curl -v -X GET "https://www.haloapi.com/ugc/h5/players/{player}/gamevariants/{variant}"
-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.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://www.haloapi.com/ugc/h5/players/{player}/gamevariants/{variant}?" + 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/ugc/h5/players/{player}/gamevariants/{variant}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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/ugc/h5/players/{player}/gamevariants/{variant}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                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/ugc/h5/players/{player}/gamevariants/{variant}";
    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:@"{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/ugc/h5/players/{player}/gamevariants/{variant}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    '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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('www.haloapi.com')
    conn.request("GET", "/ugc/h5/players/{player}/gamevariants/{variant}?%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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('www.haloapi.com')
    conn.request("GET", "/ugc/h5/players/{player}/gamevariants/{variant}?%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/ugc/h5/players/{player}/gamevariants/{variant}')

request = Net::HTTP::Get.new(uri.request_uri)
# 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