/pmda/drugs/versions

POST /api/pmda/drugs/versions

Price: 1 credit

List the versions of one Japanese package insert that the register still holds, up to the current one, with the document format the regulator holds each version in and whether an XML and a PDF exist for it. Version numbers the register no longer holds are skipped, so the list can start above 1 or miss a number in the middle.

How to use it

Call this before pmda/drugs/package_insert when a historical version matters: versions published before the register moved to XML carry `document_format` SGML, and the oldest carry no machine-readable document at all. `xml_url` and `pdf_url` are filled only on the current version, because the register publishes no addressable document for an older one — `has_xml` and `has_pdf` record what exists, not what can be fetched: every route the register's own interface builds for a historical version answers with an error page, so only the current version's document can actually be retrieved. Read `version` on each row rather than the row order to build a timeline: the register answers for some past version numbers that it no longer holds and those are dropped, so a run is complete only when the numbers run 1..current with none missing.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• doc_id string required — Package insert id from pmda/drugs/search, shaped {company}_{yj_code}_{bkno}_{version}, whose trailing number is the current version (examples: "430574_1149019C1149_1_13", "780075_1149019C1157_1_12"; minLength: 1)

Response

• @type string (default: "PmdaInsertVersion")
• id string required
• version integer (default: 0)
• is_current boolean (default: false)
• document_format string (default: "")
• has_xml boolean (default: false)
• has_pdf boolean (default: false)
• xml_url string nullable
• pdf_url string nullable

Errors

• 422 — doc_id did not end with a numeric version. 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 package insert carries 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.