Skip to content

GET Project Data By ID

Ksenyia edited this page Feb 1, 2017 · 1 revision

Resource URI

/project/data/{id}

Resource Properties

Property Description
id A string that uniquely identifies the project.

Response Attribute

{
    errorList: Array,
    companies: [
        {
            _id: String,
            company_groups: Array,
            company_name: String
        }
    ],
    productions: [
        {
            _id: String,
            country: Array,
            production_commodity: {
                _id: String,
                commodity_id: String,
                commodity_name: String
            },
            production_level: String,
            production_price: String,
            production_price_unit: String,
            production_unit: String,
            production_volume: Integer,
            production_year: Integer,
            proj_site: {
                _id: String,
                name: String,
                type: String
            }
        }
    ],
    transfers: [
        {
            _id: String,
            company: {
                _id: String,
                company_name: String
            },
            country: {
                iso2: String,
                name: String
            },
            transfer_label: String,
            transfer_type: String,
            transfer_level: String,
            transfer_unit: String,
            transfer_value: Integer,
            transfer_year: Integer,
            proj_site: {
                _id: String,
                name: String,
                type: String
            }
        }
    ]
}   

HTTP GET

Default Request

curl -GET http://end-point-uri/projects/no-alvh-qlnuxr

Response

HTTP Status Code 200

{
    errorList: [
        {
            message: "productions not found",
            type: "Productions"
        },
        ...
    ],
    companies: [
        {
            _id: "585bb7b18bb3aa000f20a263",
            company_groups: [],
            company_name: "BP P.L.C."
        }
    ],
    productions: [],
    transfers: [
        {
            _id: "585bb7b68bb3aa000f20a504",
            company: {
                _id: "585bb7b18bb3aa000f20a263",
                company_name: "BP P.L.C."
            },
            country: {
                iso2: "TT",
                name: Trinidad and Tobago"
            },
            transfer_label: null,
            transfer_type: "Royalties",
            transfer_level: "project",
            transfer_unit: "USD",
            transfer_value: 90840809,
            transfer_year: 2015,
            proj_site: {
                _id: "tt-bptt-foghrm",
                name: "BPTT Blocks",
                type: "project"
            }
        }
    ]
}   
Clone this wiki locally