/hilma/tenders

POST /api/hilma/tenders

Price: 20 credits

Get one Hilma notice by its id: title and description in Finnish, Swedish and English, notice kind and form, buyer, CPV and NUTS codes, estimated, awarded and framework values, winners, every lot with values and tender statistics, sustainability flags, the organisations with business id, address and contact, awards per lot with contract dates, lot deadlines, documents and award criteria, and the whole published notice.

How to use it

Pass the id of a hilma/tenders/search row: EF- for eForms notices, OLD- for notices on the earlier national forms, PLAN- for procurement plans. organisations, awards and lot_details come from the eForms body, so an OLD- or PLAN- notice carries its published body in notice only.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• tender string required — Hilma notice id (examples: "EF-57737", "OLD-160600", "PLAN-1280"; minLength: 1)

Response

• @type string (default: "HilmaTender")
• id string required
• notice_id string nullable
• notice_number string nullable
• procedure_id string nullable
• legacy_procedure_id string nullable
• plan_id string nullable
• eforms_id string nullable
• eforms_version_id string nullable
• contract_folder_id string nullable
• parent_notice_id string nullable
• previous_notice_ids array (default: [])
• previous_notice_numbers array (default: [])
• previous_ted_publication_ids array (default: [])
• previous_eforms_ids array (default: [])
• previous_eforms_version_ids array (default: [])
• previous_contract_folder_ids array (default: [])
• linked_ted_publication_ids array (default: [])
• ted_publication_id string nullable
• ojs_number string nullable
• referenced_notice_id string nullable
• form_type string nullable
• main_type string nullable
• stage string nullable
• titles object nullable
  • @type string (default: "HilmaText")
  • fi string nullable
  • sv string nullable
  • en string nullable
  • other string nullable
• description string nullable
• descriptions object nullable
  • @type string (default: "HilmaText")
  • fi string nullable
  • sv string nullable
  • en string nullable
  • other string nullable
• buyer object nullable
  • @type string (default: "HilmaBuyer")
  • name string nullable
  • names object nullable
    • @type string (default: "HilmaText")
    • fi string nullable
    • sv string nullable
    • en string nullable
    • other string nullable
  • business_id string nullable
  • department string nullable
  • address string nullable
  • nuts string nullable
  • organisation_type string nullable
• suppliers array (default: [])
  • @type string (default: "HilmaSupplier")
  • name string required
  • identifier string nullable
• cpv array (default: [])
• nuts array (default: [])
• contract_natures array (default: [])
• procedure_type string nullable
• value object nullable
  • @type string (default: "HilmaValue")
  • amount number nullable
  • currency string nullable
• awarded_value object nullable
  • @type string (default: "HilmaValue")
  • amount number nullable
  • currency string nullable
• framework_max_value object nullable
  • @type string (default: "HilmaValue")
  • amount number nullable
  • currency string nullable
• framework_approximate_value object nullable
  • @type string (default: "HilmaValue")
  • amount number nullable
  • currency string nullable
• dates object nullable
  • @type string (default: "HilmaDates")
  • published_at integer nullable
  • modified_at integer nullable
  • deadline_at integer nullable
  • expires_at integer nullable
• is_cancelled boolean nullable
• is_corrigendum boolean nullable
• is_eforms boolean nullable
• is_eu_procurement boolean nullable
• is_national_procurement boolean nullable
• is_national_small_value boolean nullable
• is_private_small_value boolean nullable
• is_plan boolean nullable
• is_latest boolean nullable
• is_tendering_in_hilma boolean nullable
• has_framework_agreement boolean nullable
• has_dynamic_purchasing_system boolean nullable
• estimated_opportunities string nullable
• documents_url string nullable
• sending_system string nullable
• sustainability object nullable
  • @type string (default: "HilmaSustainability")
  • has_biodiversity boolean nullable
  • has_circular_economy boolean nullable
  • has_code_of_conduct boolean nullable
  • has_employment_condition boolean nullable
  • has_end_user_involvement boolean nullable
  • has_energy_efficiency boolean nullable
  • has_innovation boolean nullable
  • has_just_working_conditions boolean nullable
  • has_listed_green_criteria boolean nullable
  • has_low_carbon boolean nullable
  • has_sme_participation boolean nullable
  • is_solution_new_to_buyer boolean nullable
  • is_solution_new_to_market boolean nullable
  • has_sustainable_food_production boolean nullable
• lots array (default: [])
  • @type string (default: "HilmaLotSummary")
  • id string nullable
  • titles object nullable
    • @type string (default: "HilmaText")
    • fi string nullable
    • sv string nullable
    • en string nullable
    • other string nullable
  • description string nullable
  • descriptions object nullable
    • @type string (default: "HilmaText")
    • fi string nullable
    • sv string nullable
    • en string nullable
    • other string nullable
  • cpv array (default: [])
  • nuts array (default: [])
  • contract_natures array (default: [])
  • procedure_type string nullable
  • value object nullable
    • @type string (default: "HilmaValue")
    • amount number nullable
    • currency string nullable
  • awarded_value object nullable
    • @type string (default: "HilmaValue")
    • amount number nullable
    • currency string nullable
  • suppliers array (default: [])
    • @type string (default: "HilmaSupplier")
    • name string required
    • identifier string nullable
  • deadline_at integer nullable
  • expires_at integer nullable
  • has_framework_agreement boolean nullable
  • has_dynamic_purchasing_system boolean nullable
  • estimated_opportunities string nullable
  • statistics object nullable
    • @type string (default: "HilmaTenderStatistics")
    • received_tender_count integer nullable
    • received_application_count integer nullable
    • electronic_tender_count integer nullable
    • micro_tenderer_count integer nullable
    • small_tenderer_count integer nullable
    • medium_tenderer_count integer nullable
    • sme_tenderer_count integer nullable
    • other_eea_tenderer_count integer nullable
    • outside_eea_tenderer_count integer nullable
    • unverified_tender_count integer nullable
    • inadmissible_tender_count integer nullable
    • abnormally_low_tender_count integer nullable
  • sustainability object nullable
    • @type string (default: "HilmaSustainability")
    • has_biodiversity boolean nullable
    • has_circular_economy boolean nullable
    • has_code_of_conduct boolean nullable
    • has_employment_condition boolean nullable
    • has_end_user_involvement boolean nullable
    • has_energy_efficiency boolean nullable
    • has_innovation boolean nullable
    • has_just_working_conditions boolean nullable
    • has_listed_green_criteria boolean nullable
    • has_low_carbon boolean nullable
    • has_sme_participation boolean nullable
    • is_solution_new_to_buyer boolean nullable
    • is_solution_new_to_market boolean nullable
    • has_sustainable_food_production boolean nullable
• country string (default: "FI")
• url string required
• procedure_description string nullable
• organisations array (default: [])
  • @type string (default: "HilmaOrganisation")
  • id string nullable
  • name string nullable
  • business_id string nullable
  • department string nullable
  • street string nullable
  • city string nullable
  • postcode string nullable
  • nuts string nullable
  • country string nullable
  • contact_name string nullable
  • email string nullable
  • phone string nullable
  • website_url string nullable
  • size string nullable
  • roles array (default: [])
• awards array (default: [])
  • @type string (default: "HilmaAward")
  • lot_id string nullable
  • result_code string nullable
  • suppliers array (default: [])
    • @type string (default: "HilmaOrganisation")
    • id string nullable
    • name string nullable
    • business_id string nullable
    • department string nullable
    • street string nullable
    • city string nullable
    • postcode string nullable
    • nuts string nullable
    • country string nullable
    • contact_name string nullable
    • email string nullable
    • phone string nullable
    • website_url string nullable
    • size string nullable
    • roles array (default: [])
  • value object nullable
    • @type string (default: "HilmaValue")
    • amount number nullable
    • currency string nullable
  • tender_reference string nullable
  • contract_id string nullable
  • contract_reference string nullable
  • contract_date string nullable
  • award_date string nullable
  • received_tender_count integer nullable
• lot_details array (default: [])
  • @type string (default: "HilmaLotDetail")
  • id string nullable
  • internal_id string nullable
  • note string nullable
  • start_date string nullable
  • end_date string nullable
  • deadline_at integer nullable
  • questions_deadline_at integer nullable
  • opening_at integer nullable
  • documents_url string nullable
  • submission_url string nullable
  • submission_method string nullable
  • is_sme_suitable boolean nullable
  • award_criteria array (default: [])
    • @type string (default: "HilmaAwardCriterion")
    • criterion_type string nullable
    • name string nullable
    • description string nullable
• notice object 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 Hilma notice with this identifier 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.