/cejn/plans

POST /api/cejn/plans

Price: 20 credits

Get one published CeJN procurement plan by its id: the contracting authority with address and contacts, the plan year, responsible person, totals by currency, and every plan item with its description, CPV codes, subject and procedure type, budget account, source of finance, value and VAT.

How to use it

Pass the id of a cejn/plans/search row.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• plan string required — Plan id (examples: "26504")

Response

• @type string (default: "CejnPlan")
• id string required
• name string nullable
• plan_year integer nullable
• status string nullable
• buyer object nullable
  • @type string (default: "CejnOrganizationRef")
  • id string nullable
  • name string nullable
  • short_name string nullable
  • tax_number string nullable
  • registration_number string nullable
  • address object nullable
    • @type string (default: "CejnAddress")
    • street string nullable
    • house_number string nullable
    • postcode string nullable
    • city_id string nullable
    • country_id string nullable
  • email string nullable
  • phone string nullable
  • fax string nullable
  • website string nullable
  • buyer_type string nullable
  • organization_form string nullable
  • activity_code string nullable
  • url string nullable
• responsible_person string nullable
• contact_person string nullable
• is_approved boolean nullable
• is_centralised_procurement boolean nullable
• total_values array (default: [])
  • @type string (default: "CejnMoney")
  • amount number nullable
  • currency string nullable
• total_vat array (default: [])
  • @type string (default: "CejnMoney")
  • amount number nullable
  • currency string nullable
• line_items array (default: [])
  • @type string (default: "CejnPlanItem")
  • id string nullable
  • number integer nullable
  • description string nullable
  • cpvs array (default: [])
    • @type string (default: "CejnCpv")
    • code string nullable
    • name string nullable
  • subject_type string nullable
  • procedure_type string nullable
  • account_code string nullable
  • source_of_finance string nullable
  • value object nullable
    • @type string (default: "CejnMoney")
    • amount number nullable
    • currency string nullable
  • vat object nullable
    • @type string (default: "CejnMoney")
    • amount number nullable
    • currency string nullable
  • is_framework_agreement boolean nullable
  • framework_agreement_value object nullable
    • @type string (default: "CejnMoney")
    • amount number nullable
    • currency string nullable
  • framework_agreement_vat object nullable
    • @type string (default: "CejnMoney")
    • amount number nullable
    • currency string nullable
  • created_at integer nullable
• created_at integer nullable
• published_at integer nullable
• url 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 published plan with this id in CeJN 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.