/marchesmr/purchase-plans

POST /api/marchesmr/purchase-plans

Price: 20 credits

Get one Mauritanian annual purchase plan (PAA) by its id, with the title, year, buyer, publication date, revision count, the plan document and every planned purchase with its object, estimated cost in ouguiya, contract type, procurement method, funding source ids and planned launch and award dates.

How to use it

Pass the id of a marchesmr/purchase-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 — Purchase plan id from marchesmr/purchase-plans/search (examples: "69cd2a7d7516e08a8e6f076c")

Response

• @type string (default: "MarchesmrPurchasePlan")
• id string required
• year integer nullable
• buyer object nullable
  • @type string (default: "MarchesmrBuyer")
  • id string required
  • name string nullable
  • name_ar string nullable
  • abbreviation string nullable
  • cncmp_abbreviation string nullable
  • parent_id string nullable
  • parent_name string nullable
  • image string nullable
• published_at integer nullable
• revision_count integer nullable
• source string nullable
• document object nullable
  • @type string (default: "MarchesmrFile")
  • name string nullable
  • url string required
• created_at integer nullable
• updated_at integer nullable
• activity_count integer nullable
• activities array (default: [])
  • @type string (default: "MarchesmrActivity")
  • id string required
  • title_ar string nullable
  • position integer nullable
  • contract_type object nullable
    • @type string (default: "MarchesmrCode")
    • id string nullable
    • code string nullable
    • name string nullable
    • name_ar string nullable
  • procurement_method object nullable
    • @type string (default: "MarchesmrCode")
    • id string nullable
    • code string nullable
    • name string nullable
    • name_ar string nullable
  • estimated_value object nullable
    • @type string (default: "MarchesmrAmount")
    • amount number nullable
    • currency string nullable
    • foreign_amount number nullable
    • foreign_currency string nullable
    • tax_basis string nullable
  • launch_at integer nullable
  • award_at integer nullable
  • start_at integer nullable
  • completion_at integer nullable
  • funding_source_ids array (default: [])
  • donor_ids array (default: [])
  • budget_line_ids array (default: [])
  • created_at integer nullable
  • updated_at integer 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 record with this id on the Mauritania 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.