Skip to content

GET Companies Table

Ksenyia edited this page May 17, 2016 · 3 revisions

Resource URI

/company_table/{type}/{id}

Resource Properties

Property Description
id A string that uniquely identifies.
type Collection type( for example, two requests for getting companies are called at country page. companies have following types type="country_of_incorporation" and type="countries_of_operation"). Possible variants of the types: project,site,field,concession,contract,commodity,country_of_incorporation,countries_of_operation.

Response Attribute

{
    companies: [
        {
            _id: String,
            company_name: String,
            company_groups: [
                {
                    _id: String,
                    company_group_name: String
                }
            ]
        }
    ],    
    query: Array
}   

HTTP GET

Default Request

curl -GET http://end-point-uri/company_table/project/57100216bd08c40100ac0751

Response

HTTP Status Code 200

{
    companies: [
        {
            _id: "57100215bd08c40100ac06a6",
            company_name: "Rio Tinto",
            company_groups: [
                {
                    _id: "571001e7bd08c40100abff2c",
                    company_group_name: "Rio Tinto"
                }
            ]
        },
        ...
    ],    
    query: [ ]
}   
Clone this wiki locally