-
Notifications
You must be signed in to change notification settings - Fork 0
GET Project By ID
Ksenyia edited this page Feb 1, 2017
·
5 revisions
It gives the data of project like project title, aliases, country, commodities and so on.
Resource URI
/projects/{id}
Resource Properties
Property | Description |
---|---|
id | A string that uniquely identifies the project. |
Response Attribute
{
errorList: Array,
project: {
_id: String,
proj_id: String,
proj_name: String,
proj_established_source:
{
_id: String,
source_type_name: String,
source_type_id: String,
source_type_authority: String,
source_type_examples: String,
source_type_url_type: String,
source_type_display: Boolean (true or false)
},
proj_status: [
{
source: String,
_id: String,
timestamp: Date,
string: String
}
],
proj_commodity: [
{
commodity_name: String,
commodity_type: String,
commodity_id: String,
_id: String,
commodity_aliases: Array
}
],
proj_country:[
{
iso2: String,
name: String,
_id: String,
country_aliases: Array
}
],
concessions:[
{
_id: String,
concession_name: String
}
],
contracts:[
{
_id: String,
contract_id: String
}
],
source_type:[
{
p: Boolean (true or false),
c: Boolean (true or false)
}
],
company_count: Integer,
production_count: Integer,
transfer_count: Integer,
queries: Array
}
}
HTTP GET
Default Request
curl -GET http://end-point-uri/projects/no-alvh-qlnuxr
Response
HTTP Status Code 200
{
errorList: Array,
project: {
_id: "56fcd58f641ff90100864fb1",
proj_id: "no-alvh-qlnuxr",
proj_name: "Alvheim",
proj_established_source:
{
_id: "56e8736944442a3824141429",
source_type_name: "UK Mandatory payment disclosure",
source_type_id: "ukdis",
source_type_authority: "disclosure",
source_type_examples: "Mandatory company disclosure
(eg. http://www.detnor.no/wp-content/uploads/2015/03/DETNOR-Annual-Report-2014.pdf?d5b1f2 )",
source_type_url_type: "Direct link to data in PDF report",
source_type_display: true
},
proj_commodity: [
{
commodity_name: "Ferrotitanium",
commodity_type: "mining",
commodity_id: "ferrotitanium",
_id: "56f8c98288a702461470900f",
commodity_aliases: [ ]
},
...
],
proj_country:[
{
iso2: "AD",
name: "Andorra",
_id: "56f8c98288a7024614708e98",
country_aliases: [ ]
}
],
concessions:[
{
_id: "56a2b8236e585b7316655794",
concession_name: "Block A"
},
...
],
contracts:[
{
_id: "56a2eb4345d114c30439ec20",
contract_id: "ocds-591adf-YE2702919895RC"
}
],
source_type:[
{
p: true,
c: false
}
],
company_count: 0,
production_count: 0,
transfer_count: 0,
queries: []
}
}