/twpcc/awards

POST /api/twpcc/awards

Price: 25 credits

One Taiwan government procurement award or non-award notice by id or URL: the agency, case number and name, the linked tender id, methods, budget and total award, award and notice dates, contract number, every bidder with supplier code, address, award flag, amount and staffing, each awarded item with its winning and losing bidders, the evaluation committee, labelled notice sections and history.

How to use it

Takes the `id` of a twpcc/awards/search row or the notice URL. `is_awarded` is false for a notice that the procurement could not be awarded, with `non_award_reason`. `tender_id` goes to twpcc/tenders and a bidder's `supplier_id` to twpcc/suppliers. On a notice too large to list in full on one page (such as a common supply contract with hundreds of bidders and thousands of items), each bidder carries only its supplier code, name and award flag, and each line item its number and name without its bidders.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Award or non-award notice id or URL (examples: "71290736", "https://web.pcc.gov.tw/tps/atm/AtmAwardWithoutSso/QueryAtmAwardDetail?pkAtmMain=NzEyOTA3MzY="; minLength: 1)

Response

• @type string (default: "TwpccAward")
• id string required
• url string required
• is_awarded boolean required
• case_number string nullable
• tender_id string nullable
• org_id string nullable
• org_name string nullable
• unit_name string nullable
• org_address string nullable
• contact_name string nullable
• contact_phone string nullable
• contact_fax string nullable
• tender_method string nullable
• award_method string nullable
• category string nullable
• amount_tier string nullable
• budget_amount number nullable
• total_awarded_amount number nullable
• currency string nullable
• transmission_number string nullable
• notice_number string nullable
• opening_at integer nullable
• original_announced_date string nullable
• awarded_date string nullable
• announced_date string nullable
• contract_number string nullable
• non_award_reason string nullable
• bidder_count integer nullable
• bidders array (default: [])
  • @type string (default: "TwpccBidder")
  • supplier_id string nullable
  • name string nullable
  • name_en string nullable
  • is_winner boolean nullable
  • organization_type string nullable
  • industry string nullable
  • address string nullable
  • address_en string nullable
  • phone string nullable
  • awarded_amount number nullable
  • country string nullable
  • is_sme boolean nullable
  • sme_subcontract_amount number nullable
  • performance_period string nullable
  • employee_count integer nullable
  • indigenous_employee_count integer nullable
  • disabled_employee_count integer nullable
  • other_fields array (default: [])
    • @type string (default: "TwpccField")
    • label string required
    • value string nullable
• line_items array (default: [])
  • @type string (default: "TwpccAwardItem")
  • number integer required
  • name string nullable
  • awarded_amount number nullable
  • bidders array (default: [])
    • @type string (default: "TwpccItemBidder")
    • is_winner boolean required
    • name string nullable
    • participated_in_evaluation boolean nullable
    • rank_or_score string nullable
    • estimated_quantity string nullable
    • original_bid_amount number nullable
    • awarded_amount number nullable
    • bid_amount number nullable
    • is_qualified boolean nullable
    • reason string nullable
    • origin string nullable
    • origins array (default: [])
    • other_fields array (default: [])
  • other_fields array (default: [])
    • @type string (default: "TwpccField")
    • label string required
    • value string nullable
• committee array (default: [])
  • @type string (default: "TwpccCommitteeMember")
  • name string required
  • attended boolean nullable
  • occupation string nullable
  • experience string nullable
• corrections array (default: [])
  • @type string (default: "TwpccCorrection")
  • label string nullable
  • value string nullable
  • previous_value string nullable
• sections array (default: [])
  • @type string (default: "TwpccSection")
  • name string nullable
  • fields array (default: [])
    • @type string (default: "TwpccField")
    • label string required
    • value string nullable
• history array (default: [])
  • @type string (default: "TwpccHistoryEntry")
  • kind string nullable
  • transmission_number string nullable
  • correction_number string nullable
  • documents_changed boolean nullable
  • announced_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 — No award or non-award notice 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.