Versions Compared

Old Version 6

changes.mady.by.user Ian Grabill (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user J Cobb (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
labelapi_docs_CONTROLLERTAG
NameCategories / Index
DescriptionReturn Obtain a list of global categoriesCategories that match given conditions
TypeGET
URL/v9/categories
Credential TypeAPI|User
Supports PaginationNo*

Long Description

Obtain a list of Categories that match given conditions.


Info

Because the list of Categories rarely changes and is not very large ALL Categories will be returned from this endpoint if no parameters are passed.


Parameters

Name
Description
Value Type
Required
LocationConditionals
nameName of the categorystringoptionalExact name of the CategoryStringOptionalQueryNo
parent_idThe ID of a parent Category.IntegeroptionalQueryNo
updated_atDate/time venue was updatedDate (ISO_8601)OptionalQueryYes

 

Examples

ruby

 

 

RequestResponse
/v9/categories?per_page=10 
Code Block
themeConfluence
language
Code Block
themeConfluence
languageruby
{
  "per_page": 10,
  "categories": [{
    "id": "123",
    "url": "/categories/123",
    "parent": {
      "id": "19",
      "url": "/categories/19",
      "parent": {
        "id": "1",
        "url": "/categories/1",
        "parent": null,
        "name": "Sports",
        "updated_at": "2011-04-15T05:39:23Z"
      },
      "name": "Football",
      "updated_at": "2011-04-15T05:39:23Z"
    },
    "name": "Lingerie Football League",
    "updated_at": "2012-06-15T18:57:19Z"
  }, {
    "id": "85",
    "url": "/categories/85",
    "parent": {
      "id": "54",
      "url": "/categories/54",
      "parent": null,
      "name": "Concerts",
      "updated_at": "2010-07-30T17:39:59Z"
    },
    "name": "Latin",
    "updated_at": "2011-05-31T19:24:25Z"
  }, {
    "id": "9",
    "url": "/categories/9",
    "parent": {
      "id": "7",
      "url": "/categories/7",
      "parent": {
        "id": "1",
        "url": "/categories/1",
        "parent": null,
        "name": "Sports",
        "updated_at": "2011-04-15T05:39:23Z"
      },
      "name": "Basketball",
      "updated_at": "2011-04-15T05:39:23Z"
    },
    "name": "WNBA",
    "updated_at": "2011-04-15T05:39:23Z"
  }, {
    "id": "47",
    "url": "/categories/47",
    "parent": {
      "id": "44",
      "url": "/categories/44",
      "parent": {
        "id": "1",
        "url": "/categories/1",
        "parent": null,
        "name": "Sports",
        "updated_at": "2011-04-15T05:39:23Z"
      },
      "name": "Fighting",
      "updated_at": "2011-04-15T16:06:02Z"
    },
    "name": "Boxing",
    "updated_at": "2011-04-15T16:01:42Z"
  }, {
    "id": "28",
    "url": "/categories/28",
    "parent": {
      "id": "27",
      "url": "/categories/27",
      "parent": {
        "id": "1",
        "url": "/categories/1",
        "parent": null,
        "name": "Sports",
        "updated_at": "2011-04-15T05:39:23Z"
      },
      "name": "Auto Racing",
      "updated_at": "2011-04-15T16:04:42Z"
    },
    "name": "NASCAR",
    "updated_at": "2011-04-15T15:57:21Z"
  }, {
    "id": "133",
    "url": "/categories/133",
    "parent": {
      "id": "24",
      "url": "/categories/24",
      "parent": {
        "id": "1",
        "url": "/categories/1",
        "parent": null,
        "name": "Sports",
        "updated_at": "2011-04-15T05:39:23Z"
      },
      "name": "Golf",
      "updated_at": "2011-04-15T16:06:12Z"
    },
    "name": "LPGA",
    "updated_at": "2013-02-19T22:22:12Z"
  }, {
    "id": "57",
    "url": "/categories/57",
    "parent": {
      "id": "54",
      "url": "/categories/54",
      "parent": null,
      "name": "Concerts",
      "updated_at": "2010-07-30T17:39:59Z"
    },
    "name": "Rock & Pop",
    "updated_at": "2011-05-31T19:26:08Z"
  }, {
    "id": "76",
    "url": "/categories/76",
    "parent": {
      "id": "73",
      "url": "/categories/73",
      "parent": null,
      "name": "Special Events",
      "updated_at": "2010-07-30T17:39:59Z"
    },
    "name": "Fundraisers",
    "updated_at": "2010-07-30T17:39:59Z"
  }, {
    "id": "19",
    "url": "/categories/19",
    "parent": {
      "id": "1",
      "url": "/categories/1",
      "parent": null,
      "name": "Sports",
      "updated_at": "2011-04-15T05:39:23Z"
    },
    "name": "Football",
    "updated_at": "2011-04-15T05:39:23Z"
  }, {
    "id": "38",
    "url": "/categories/38",
    "parent": {
      "id": "34",
      "url": "/categories/34",
      "parent": {
        "id": "1",
        "url": "/categories/1",
        "parent": null,
        "name": "Sports",
        "updated_at": "2011-04-15T05:39:23Z"
      },
      "name": "Soccer",
      "updated_at": "2011-04-15T05:39:23Z"
    },
    "name": "Scottish Premiere League",
    "updated_at": "2011-04-15T05:39:23Z"
  }],
  "total_entries": 10,
  "page": 1
}