Skip to content

GET Contract By ID

Ksenyia edited this page Nov 1, 2016 · 9 revisions

It gives the data of contract like contract title, concessions, country and so on.

Resource URI

/contracts/{id}

Resource Properties

Property Description
id A string that uniquely identifies the contract.

Response Attribute

{
  _id: String,
  contract_id: String,
  contract_title: String,
  contract_url: String,
  rc_info: 
    {
      contract_name: String,
      contract_country:
        {
          code: String,
          name: String
        },
      contract_commodity: Array,
      contract_type: Array
    },
  commodities: Array,
  commodity: 
    {
      commodity_name: String,
      _id: String,
      commodity_id: String
    },
  concessions: [
    {
      _id: String,
      concession_name: String,
      concession_country:
        {
          iso2: String,
          name: String,
          _id: String,
          country_aliases: Array
        },
      concession_commodities: [
        {
          source: String,
          commodity: 
            {
              commodity_name: String,
              commodity_type: String,
              commodity_id: String,
              _id: String,
              commodity_aliases: Array
            },
          _id: String,
          timestamp: Date
        }
      ],
      concession_status: [
        {
          source: String,
          _id: String,
          timestamp: Date,
          string: String
        }
      ],
      concession_polygon: [
        {
          loc: Array,
          _id: String,
          timestamp: Date
        }
      ]
    },
  ],
  location: [
    {
      lat: Number,
      lng: Number,
      message: String,
      timestamp: Date,
      type: String,
      id: String
    }
  ]
}

HTTP GET

Default Request

curl -GET http://end-point-uri/contracts/ocds-591adf-GH1577304824RC

Response

HTTP Status Code 200

{
  _id: "56fcd5f0641ff90100865675",
  contract_id: "ocds-591adf-GH1577304824RC",
  contract_title: "ocds-591adf-GH1577304824RC",
  contract_url: "ocds-591adf-GH1577304824RC",
  rc_info: 
    {
      contract_name: "Tullow, Sabre, Kosmos, Ghana, 2006",
      contract_country:
        {
          code: "GH",
          name: "Ghana"
        },
      contract_commodity: [ "Hydrocarbons" ],
      contract_type: [ "Concession Agreement" ]
    },
  commodities: [ "Hydrocarbons" ],
  commodity: 
    {
      commodity_name: "Hydrocarbons",
      _id: "56fcd1e3be65cd01000bd2dc",
      commodity_id: "hydrocarbons"
    },
  concessions: [
    {
      _id: "56fcd5f0641ff90100865678",
      concession_name: "Deepwater Tano Block",
      concession_country:
        {
          iso2: "GH",
          name: "Ghana",
          _id: "56fcd1e4be65cd01000bd32e",
          country_aliases: [ ]
        },
      concession_type: 
        {
          source: "56747e060e8cc07115200ee5",
          string: "offshore",
          _id: "56f8c98288a7024614708ff7",
          timestamp: "2016-03-28T06:04:49.711Z"
        },
      concession_commodities: [ ],
      concession_status: [ ],
      concession_polygon: [ ]
    },
  ],
  location: [ ]
}
Clone this wiki locally