/slegp/buyers/search

POST /api/slegp/buyers/search

Price: 1 credit

List the procuring entities registered on the Sierra Leone eGP (egp.nppa.gov.sl), optionally narrowed by name, short name or plan reference code. Each row carries the entity id, name, short name, codes, vote code, description, type, status, budget category and the address with email, telephone and fax.

How to use it

A row's `id` is the `buyer_id` that narrows slegp/plans/search to one entity's plan.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Part of the entity name, short name or plan reference code (examples: "Health", "SLRA"; minLength: 1)
• count integer required — Max number of procuring entities to return (min: 1)

Response

• @type string (default: "SlegpBuyer")
• id string required
• name string nullable
• short_name string nullable
• code string nullable
• plan_reference_code string nullable
• vote_code string nullable
• description string nullable
• organization_type string nullable
• organization_type_id string nullable
• status string nullable
• budget_category string nullable
• budget_year_type string nullable
• is_budget_check_needed boolean nullable
• address object nullable
  • @type string (default: "SlegpAddress")
  • street string nullable
  • email string nullable
  • telephone string nullable
  • fax string nullable
  • postal_code string nullable
  • region_id string nullable
  • district_id string nullable
• 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 — 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.