@datafire/haloapi_ugc

Client library for UGC

Installation and Usage

npm install --save @datafire/haloapi_ugc

let haloapi_ugc = require('@datafire/haloapi_ugc').create({
  apiKeyHeader: "",
  apiKeyQuery: ""
});

.then(data => {
  console.log(data);
});

Description

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

Actions

58acde292109180bdcacc40d

haloapi_ugc.58acde292109180bdcacc40d({
  "player": ""
}, context)

Input

• input object
  • player required string: The Gamertag of the Player that owns the listed Game Variants.
  • start number: When specified, this indicates the starting index (0-based) for which the list of results will begin at.
  • count number: When specified, this indicates the maximum quantity of items the caller would like returned in the response.
  • sort number: When specified, this indicates what field should be used to sort the results as the primary sort order. When omitted, "modified" (descending) is the assumed primary sort order. Allowed sort fields are: name, description, accessibility, created, modified, bookmarkCount.
  • order number: When specified, this indicates the ordering that will be applied. When omitted, "desc" is assumed. Allowed order values are: asc, desc.

Output

Output schema unknown

58acde292109180bdcacc40c

haloapi_ugc.58acde292109180bdcacc40c({
  "player": "",
  "variant": ""
}, context)

Input

• input object
  • player required string: The Gamertag of the Player that owns the Game Variant.
  • variant required string: The ID for the Game Variant.

Output

Output schema unknown

58acde292109180bdcacc40f

haloapi_ugc.58acde292109180bdcacc40f({
  "player": ""
}, context)

Input

• input object
  • player required string: The Gamertag of the Player that owns the listed Map Variants.
  • start number: When specified, this indicates the starting index (0-based) for which the list of results will begin at.
  • count number: When specified, this indicates the maximum quantity of items the caller would like returned in the response.
  • sort number: When specified, this indicates what field should be used to sort the results as the primary sort order. When omitted, "modified" (descending) is the assumed primary sort order. Allowed sort fields are: name, description, accessibility, created, modified, bookmarkCount.
  • order number: When specified, this indicates the ordering that will be applied. When omitted, "desc" is assumed. Allowed order values are: asc, desc.

Output

Output schema unknown

58acde292109180bdcacc40e

haloapi_ugc.58acde292109180bdcacc40e({
  "player": "",
  "variant": ""
}, context)

Input

• input object
  • player required string: The Gamertag of the Player that owns the Map Variant.
  • variant required string: The ID for the Map Variant.

Output

Output schema unknown

Definitions

This integration has no definitions