/slegp/suppliers

POST /api/slegp/suppliers

Price: 1 credit

One supplier approved on the Sierra Leone eGP (egp.nppa.gov.sl) by id: the search row's name, TIN, registration numbers, country, legal form and ownership type, plus every registered line of supply (goods, services, works) with its expiry date. A supplier whose TIN, registration numbers, legal form, ownership type and status could not be read is served without them and marked by an X-Warning header.

How to use it

Takes the `id` of a slegp/suppliers/search row, never its `aggregator_id`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Supplier id (examples: "01dcd1e8-b30e-44a1-957b-4ba1572d5f52"; minLength: 1)

Response

• @type string (default: "SlegpSupplier")
• id string required
• aggregator_id string nullable
• name string nullable
• tin string nullable
• business_registration_number string nullable
• egp_registration_number string nullable
• country_of_registration string nullable
• form_of_entity string nullable
• ownership_type string nullable
• status string nullable
• registrations array (default: [])
  • @type string (default: "SlegpRegistration")
  • id string nullable
  • supply_type string nullable
  • expiry_date string nullable

Errors

• 422 — The id is not a supplier uuid 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 approved supplier 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.