/ugandagpp/buyers

POST /api/ugandagpp/buyers

Price: 1 credit

One Ugandan procuring and disposing entity by id: its category, type, sector, region, address and contacts, and the financial years it has published a procurement plan for.

How to use it

`financial_years` lists the years with a procurement plan and `procurement_plans_count` their number; the plan entries themselves are not public. The officer in charge and the phone come from ugandagpp/buyers/search, which carries them for most entities while this record often has none.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id integer required — Procuring entity id as returned by ugandagpp/buyers/search (examples: 386; min: 1)

Response

• @type string (default: "UgandagppBuyer")
• id integer required
• name string required
• abbreviation string nullable
• category string nullable
• buyer_type string nullable
• sector string nullable
• region string nullable
• address string nullable
• locality string nullable
• postal_code string nullable
• country_name string nullable
• email string nullable
• telephone string nullable
• website string nullable
• contact_name string nullable
• ppda_officer_responsible string nullable
• identifier_scheme string nullable
• identifier_legal_name string nullable
• identifier_uri string nullable
• is_active boolean nullable
• is_hse boolean nullable
• procurement_plans_count integer nullable
• financial_years array (default: [])
• country string (default: "UG")
• created_at integer nullable
• updated_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 — No procuring entity under that id 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.