/marchescm/procurement-plans

POST /api/marchescm/procurement-plans

Price: 5 credits

Get one procurement plan of a Cameroonian public buyer from the national e-procurement system (COLEPS) by its id, with the budget year, project owner, region, department, district and locality, funding source, estimated cost in words, tender board, nature of service, procedure, single-source request, and the lots with their execution and guarantee periods.

How to use it

Pass the id of a marchescm/procurement-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_id string required — Plan id from marchescm/procurement-plans/search (examples: "P20260800623-00"; pattern: ^P\d{11}-\d{2}$)

Response

• @type string (default: "MarchescmPlan")
• id string required
• project_number string required
• modification_number string required
• examination_count integer nullable
• registration_status string nullable
• fiscal_year integer nullable
• name string nullable
• owner_name string nullable
• region string nullable
• department string nullable
• district string nullable
• locality string nullable
• budget_line string nullable
• estimated_cost_in_words string nullable
• funding_source string nullable
• priority string nullable
• annuality string nullable
• lot_structure string nullable
• program_code string nullable
• program_name string nullable
• action_code string nullable
• action_name string nullable
• budget_project_code string nullable
• budget_project_name string nullable
• task_code string nullable
• task_name string nullable
• tender_board string nullable
• control_committee string nullable
• service_category string nullable
• procedure_type string nullable
• competent_authority string nullable
• is_single_source_requested boolean nullable
• single_source_reasons string nullable
• single_source_case string nullable
• single_source_authorisation_reference string nullable
• single_source_companies string nullable
• commission string nullable
• procedure_track string nullable
• lots array (default: [])
  • @type string (default: "MarchescmPlanLot")
  • lot_number integer nullable
  • name string nullable
  • budget_line string nullable
  • locality string nullable
  • execution_period string nullable
  • guarantee_period 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 procurement plan with this id on the Cameroon public procurement portal 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.