Skip to content

Category API

jeffsb edited this page Feb 21, 2013 · 2 revisions

##Objects

###Object: Category

Field Type Description Value Constraints Nullable
id guid ScoreBig ID for this category. no
name string Category name. no
parent_category_id guid The ID of the parent category. yes

##Methods

###Method: GetCategories

######Description

Gets all categories.

######URI

/categories

######HTTP Method

GET

######Returns

Array of Category objects.

######Parameters

None at this time.

######Sample Request

GET https://api.developer.scorebig.com/1/categories?api_key=12345

######Sample Response

{
    "type" : "CategoryResult",
    "count" : 6,
    "results" : [{
            "id" : "00000000-0000-0000-0000-000000000050",
            "name" : "Sports",
            "parent_category_id" : null
        }, {
            "id" : "00000000-0000-0000-0000-000000000100",
            "name" : "NBA",
            "parent_category_id" : "00000000-0000-0000-0000-000000000050"
        }, {
            "id" : "00000000-0000-0000-0000-000000000200",
            "name" : "NHL",
            "parent_category_id" : "00000000-0000-0000-0000-000000000050"
        }, {
            "id" : "00000000-0000-0000-0000-000000000300",
            "name" : "Music",
            "parent_category_id" : null
        }, {
            "id" : "00000000-0000-0000-0000-000000000301",
            "name" : "Alternative Rock",
            "parent_category_id" : "00000000-0000-0000-0000-000000000300"
        }, {
            "id" : "3aaac217-c6bd-4786-9392-9f0f01200d06",
            "name" : "Baseball",
            "parent_category_id" : "00000000-0000-0000-0000-000000000050"
        }
    ]
}

Clone this wiki locally