/comprasal/awards

POST /api/comprasal/awards

Price: 10 credits

The contract report of one El Salvador public procurement award by award id: contract name, method, term, planned and certified amounts, publication, opening, closing and signature dates, budget codes, bidders, offer upload times, contract modifications, goods receptions, payments and final beneficiaries.

How to use it

Takes the award `id` from comprasal/awards/search, never its `process_id`: the two number ranges overlap, so a process id can resolve to an unrelated award. The search row carries the supplier, buyer and awarded amount that this report does not repeat. `bids` lists each bidder once by trade name; `offer_upload_times` are the distinct offer upload times recorded on the process and are not attributed to any bidder.

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 id as returned by comprasal/awards/search, or its page URL (examples: "502319", "https://www.comprasal.gob.sv/procesos-publicos/143766"; minLength: 1)

Response

• @type string (default: "ComprasalAwardReport")
• id string required
• contract_name string nullable
• method string nullable
• term_days integer nullable
• planned_amount number nullable
• certified_amount number nullable
• currency string (default: "USD")
• published_at integer nullable
• opening_at integer nullable
• closing_at integer nullable
• signed_at integer nullable
• process_status string nullable
• budget_codes array (default: [])
• bids array (default: [])
  • @type string (default: "ComprasalBid")
  • bidder_name string required
• offer_upload_times array (default: [])
• modifications array (default: [])
  • @type string (default: "ComprasalModification")
  • kind_id string nullable
  • kind string nullable
  • created_at integer nullable
  • is_active boolean nullable
  • previous_term_days integer nullable
  • term_days integer nullable
  • previous_quantity number nullable
  • quantity number nullable
  • previous_amount number nullable
  • amount number nullable
• receptions array (default: [])
  • @type string (default: "ComprasalMilestone")
  • name string nullable
  • amount number nullable
  • occurred_at integer nullable
• payments array (default: [])
  • @type string (default: "ComprasalMilestone")
  • name string nullable
  • amount number nullable
  • occurred_at integer nullable
• beneficiaries array (default: [])
  • @type string (default: "ComprasalBeneficiary")
  • person object required
    • @type string (default: "ComprasalPerson")
    • id string nullable
    • name string required
    • first_name string nullable
    • second_name string nullable
    • third_name string nullable
    • first_surname string nullable
    • second_surname string nullable
    • married_surname string nullable
    • nationality string nullable
  • registered_at integer nullable
• url string required

Errors

• 422 — The id is not a numeric award id 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 COMPRASAL award 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.