/ugandagpp/contracts/search

POST /api/ugandagpp/contracts/search

Price: 20 credits

Search the signed contracts published on the Uganda Government Procurement Portal by subject of procurement and procuring entity. Returns each contract with its supplier, amount, signing and completion dates, the procurement plan entry and the winning bid submission.

How to use it

The feed is a 2015-2019 slice of the register: rows come newest signing date first (page 1 signed 2019-03, the last page 2015-10) and nothing signed after 2019-03 is on it; there is no sort, date or provider filter, so narrow with `subject` and `buyer_id`, then read `signing_date`. `bid_invitation_id` is the id for ugandagpp/tenders. `final_contract_value` is filled only once the contract has closed out. `currency` is null when the source states an `exchange_rate` other than 1 without naming the currency.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• subject string nullable — Words in the subject of procurement (examples: "vehicle", "road"; minLength: 1)
• buyer_id integer nullable — Procuring entity id as returned by ugandagpp/buyers/search (examples: 386; min: 1)
• count integer required — Max number of contracts to return (min: 1; max: 1000)

Response

• @type string (default: "UgandagppContract")
• id integer required
• awarded_contract_id integer nullable
• bid_invitation_id integer nullable
• ocid string nullable
• buyer object nullable
  • @type string (default: "UgandagppPde")
  • id integer required
  • name string nullable
  • abbreviation string nullable
  • category string nullable
  • address string nullable
• supplier object nullable
  • @type string (default: "UgandagppProvider")
  • id integer required
  • name string required
• contract_amount number nullable
• final_contract_value number nullable
• currency string nullable (default: "UGX")
• exchange_rate number nullable
• final_contract_value_currency string nullable
• final_contract_value_exchange_rate number nullable
• signing_date string nullable
• commencement_date string nullable
• completion_date string nullable
• actual_completion_date string nullable
• contract_manager string nullable
• performance_rating integer nullable
• is_terminated boolean nullable
• is_direct_procurement boolean nullable
• is_emergency_procurement boolean nullable
• has_sub_contractors boolean nullable
• financial_year string nullable
• plan_entry object nullable
  • @type string (default: "UgandagppPlanEntry")
  • id integer required
  • subject string nullable
  • procurement_method object nullable
    • @type string (default: "UgandagppProcurementMethod")
    • id integer required
    • code string nullable
    • name string nullable
    • description string nullable
    • bidding_period_days integer nullable
  • procurement_category object nullable
    • @type string (default: "UgandagppProcurementCategory")
    • id integer required
    • code string nullable
    • name string nullable
    • ocds_code string nullable
  • funding_source object nullable
    • @type string (default: "UgandagppFundingSource")
    • id integer required
    • name string nullable
  • estimated_amount number nullable
  • currency string (default: "UGX")
  • quantity integer nullable
  • rationale string nullable
  • has_reservation_schemes boolean nullable
• bid_submission object nullable
  • @type string (default: "UgandagppBidSubmission")
  • id integer required
  • bid_invitation_id integer nullable
  • ocid string nullable
  • provider object nullable
    • @type string (default: "UgandagppProvider")
    • id integer required
    • name string required
  • is_best_evaluated_bidder boolean nullable
  • is_approved boolean nullable
  • is_joint_venture boolean nullable
  • nationality string nullable
  • nationality_status string nullable
  • read_out_price number nullable
  • currency string nullable (default: "UGX")
  • received_by string nullable
  • received_date string nullable
  • reservation_beneficiary string nullable
  • financial_year string nullable
  • created_at integer nullable
• country string (default: "UG")
• created_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.