GET /Companies

Returns company information, searchable by id, sector or freetext.

Resource URL

http://api.climatecounts.org/1/Companies{.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

IncludeBrands optional

Specifies whether or not all associated brands are returned.

Default Value: False

Possible Value: True, False

IncludeScores optional

Specifies whether or not to include the latest yearly scores.

Default Value: False

Possible Value: True, False

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, Search

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

Search optional

Freetext search matches on company name and associated brand names.

Default Value: Ignored; No search

Example Values: Amer, American, erican

Priority: 2

StartsWith optional

Specificies if the search company/brand name begins with the freetext Search term.

Default Value: False

Possible Values: True, False

Example Request

[
   {
      "Brands":[
         "American Airlines",
         "American Eagle",
         "Trans World Airlines (TWA)"
      ],
      "CompanyID":3,
      "Name":"American Airlines",
      "Sector":"Airlines",
      "SectorCode":"A"
   }
]