/twpcc/suppliers

POST /api/twpcc/suppliers

Price: 5 credits

Compliance status of one Taiwan government supplier by supplier code: whether it is on the in-force list of suppliers barred from government contracts, with each listing's agency and effective and end dates, and whether it holds excellent-supplier or globalised-supplier status.

How to use it

Takes the 8-digit supplier code that twpcc/awards lists for each bidder. `is_debarred` is true while at least one debarment is in force.

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 code (examples: "28925854", "02750963"; minLength: 2)
• supplier_type string — Kind of supplier (default: "company"; one of: "company", "business", "factory", "foundation", "foreign_supplier", "person", "other")

Response

• @type string (default: "TwpccSupplier")
• id string required
• supplier_type string required (one of: "company", "business", "factory", "foundation", "foreign_supplier", "person", "other")
• is_debarred boolean required
• is_excellent_supplier boolean nullable
• is_global_supplier boolean nullable
• debarments array (default: [])
  • @type string (default: "TwpccDebarment")
  • id string required
  • supplier_id string nullable
  • supplier_name string nullable
  • principal_name string nullable
  • parent_company string nullable
  • note string nullable
  • agency_name string nullable
  • effective_date string nullable
  • end_date string 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.