GET /Scores

Returns company-specific yearly scores, individually or by sector or progress.

Resource URL

http://api.climatecounts.org/1/Scores{.format}


Data

Response Formats

Specifies the format of the results response. Can be overriden by appending (.xml, .json) to Resource URL. For JSONP, include callback querystring parameter.

Default Value: Determined by HTTP Media-type header

Possible Values: xml, json

Parameters

Year optional

Specifies the year for which scores are to be returned.

Default Value: Latest year that scores are available eg. 2011

Example Value: 2011, 2010, All (returns all years)

CompanyID optional

Returns results only for the company with the CompanyID specified.

Default Value: Ignored; Any company

Possible Values: Stuck, Starting, Striding

Priority: 1 - Trumps: SectorCode, Progress

SectorCode optional

Returns results only for companies in specified sector.

Default Value: Ignored; Any sector

Example Values: MC - See sectors to return all possible values.

Priority: 2 - Trumps: Progress

Progress optional

Returns results only for companies classified to be at one of the progress stages.

Default Value: Ignored; Any progress

Possible Values: Stuck, Starting, Striding

Priority: 3

SortBy optional

Returns results oredered by a specific property.

Default Value: Company

Possible Values: Total, Review, Reduce, PolicyStance, Report, Change, Progress, Sector

SortDirection optional

If OrderBy parameter is included, specifies direcion of ordering.

Default Value: Asc (Ascending)

Possible Values: Asc, Desc (Ascending, Descending)

Limit optional

Specifies the number of results to return.

Default Value: All

Possible Values: 10, 25 Any positive integer value

Offset optional

Specifies the offset for the results in order to page dataset.

Default Value: 0

Possible Values: 10, 25 Any positive integer value

Example Request

[
    {
        "Change":0,
        "Company":"AirTran",
        "CompanyID":1,
        "PolicyStance":0,
        "Progress":"Stuck",
        "Reduce":5,
        "Report":0,
        "Review":0,
        "Sector":"Airlines",
        "SectorCode":"A",
        "Total":5,
        "Year":2011
    }
]