Skip to content

GET Concession data By ID

Ksenyia edited this page Feb 2, 2017 · 1 revision

Resource URI

/concession/data/{id}

Resource Properties

Property Description
id A string that uniquely identifies the concession.

Response Attribute

{
  errorList: [
    {
      type: String,
      message: String
    }
  ],
  companies: [
    {
      _id: String,
      company_name: String,
      company_groups: [
        {
          _id: String,
          company_group_name: String,
          company_group_record_established: String,
          country_of_incorporation: Array,
          company_group_aliases: Array
        }
      ]
    }
  ],
  projects: [
    {
      _id: String,
      proj_id: String,
      proj_name: String,
      proj_commodity: [
        {
          _id: String,
          commodity_name: String,
          commodity_type: String,
          commodity_id: String,
          commodity_aliases: Array
        }
      ],
      proj_country: [
        {
          _id: String,
          iso2: String,
          name: String,
          country_aliases: Array
        }
      ],
      proj_status: [
        {
          source: String,
          _id: String,
          timestamp: Date,
          string: String
        }
      ],
      proj_site: {
        _id: String
      },
      companies_count: Integer,
      companies: Array
    }
  ],
  sites: [
    {
      _id: String,
      field: Boolean (true or false),
      site_name: String,
      site_status: String,
      site_commodity: Array,
      site_country: {
        _id: String,
        iso2: String,
        name: String,
        country_aliases: Array
      }
    }
  ],
  productions: Array,
  transfers: Array,
  production: [
    {
      _id: String,
      production_year: Integer,
      production_volume: Integer,
      production_unit: String,
      production_price: String,
      production_price_unit: String,
      production_level: String,
      country: String,
      production_commodity: {
        _id: String,
        commodity_name: String,
        commodity_id: String
      },
      proj_site: {
        _id: String,
        name: String,
        type: String
      }
    }
  ]
}
  

HTTP GET

Default Request

curl -GET http://end-point-uri/concession/data/56fcd3bcbe65cd01000bd563

Response

HTTP Status Code 200

{
  errorList: [
    {
      type: "Transfers",
      message: "transfers not found"
    }
  ],
  companies: [
    {
      _id: "585bb9098bb3aa000f21163b",
      company_name: "Oando",
      company_groups: [
        {
          _id: "585bb9088bb3aa000f211572",
          company_group_name: "Oando",
          company_group_record_established: "585bb9088bb3aa000f21155b",
          country_of_incorporation: [],
          company_group_aliases: []
        }
      ]
    }
  ],
  projects: [
    {
      _id: "ng-opl--gz5y7q",
      proj_id: "ng-opl--gz5y7q",
      proj_name: "OPL-321",
      proj_commodity: [
        {
          _id: "5808851f5e0ba42fc79bd511",
          commodity_name: "Oil",
          commodity_type: "oil_and_gas",
          commodity_id: "oil",
          commodity_aliases: []
        }
      ],
      proj_country: [
        {
          _id: "5808851f5e0ba42fc79bd5b7",
          iso2: "NG",
          name: "Nigeria",
          country_aliases: []
        }
      ],
      proj_status: [
        {
          source: "585bb9088bb3aa000f211567",
          _id: "585bb9108bb3aa000f2118af",
          timestamp: "2011-01-01T00:00:00.000Z",
          string: "exploration"
        }
      ],
      proj_site: {
        _id: "ng-opl--gz5y7q"
      },
      companies_count: 0,
      companies: []
    }
  ],
  sites: [
    {
      _id: "585bb9118bb3aa000f2118e1",
      field: true,
      site_name: "Okwori",
      site_status: null,
      site_commodity: [],
      site_country: {
        _id: "5808851f5e0ba42fc79bd5b7",
        iso2: "NG",
        name: "Nigeria",
        country_aliases: []
      }
    }
  ],
  productions: [],
  transfers: [],
  production: [
    {
      _id: "585bb9239cf560e6b32e140d",
      production_year: 2010,
      production_volume: 17704675,
      production_unit: "barrels",
      production_price: null,
      production_price_unit: null,
      production_level: "field",
      country: null,
      production_commodity: {
        _id: "5808851f5e0ba42fc79bd511",
        commodity_name: "Oil",
        commodity_id: "oil"
      },
      proj_site: {
        _id: "585bb9118bb3aa000f2118d5",
        name: "Okono",
        type: "field"
      }
    }
  ]
}
  
Clone this wiki locally