Skip to content

GET Sites Table

Ksenyia edited this page Nov 2, 2016 · 3 revisions

Resource URI

/site_table/{type}/{id}

Resource Properties

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

Response Attribute

{
    sites: [
        {
            _id: String,
            field: Boolean (true or false),
            site_name: String,
            site_country: [
                {
                    source: String,
                    country:
                       {
                           iso2: String,
                           name: String,
                           _id: String,
                           country_aliases: Array
                        }
                    timestamp: Date
                }
            ],
            site_commodity:[
                {
                    source: String,
                    commodity: 
                        {
                            _id: String,
                            commodity_name: String,
                            commodity_type: String,
                            commodity_id: String,
                            commodity_aliases: Array
                         },
                    timestamp: Date     
                }   
            ],
            site_status:[
                {
                    source: String,
                    _id: String,
                    timestamp: Date,
                    string: String     
                }
            ],        
            companies: Integer
        }
    ]
}    

HTTP GET

Default Request

curl -GET http://end-point-uri/site_table/country/57100133bd08c40100abf6de

Response

HTTP Status Code 200

{
    sites: [
        {
            _id: "57100216bd08c40100ac0779",
            field: false,
            site_name: "Bayside",
            site_country: [
                {
                    source: "57100211bd08c40100ac0489",
                    country:
                       {
                           iso2: "ZA",
                           name: "South Africa",
                           _id: "57100133bd08c40100abf6de",
                           country_aliases: [ ]
                        }
                    timestamp: "2016-04-14T20:44:33.814Z"
                }
            ],
            site_commodity:[
                {
                    source: "57100211bd08c40100ac0489",
                    commodity: 
                        {
                            _id: "57100132bd08c40100abf54b",
                            commodity_name: "Aluminum",
                            commodity_type: "mining",
                            commodity_id: "aluminum",
                            commodity_aliases: [ ]
                         },
                    timestamp: "2016-04-14T20:44:33.814Z"     
                }   
            ],
            site_status:[
                {
                    source: "57100211bd08c40100ac0489",
                    _id: "57100216bd08c40100ac077a",
                    timestamp: null,
                    string: "production"     
                }
            ],        
            companies: 0
        },
        ...
    ]
}       
Clone this wiki locally