/iec/publications

POST /api/iec/publications

Price: 10 credits

Get IEC Webstore publications by id, up to 20 in one call. Returns the catalogue record: reference and its parsed parts, title, abstract, edition, status, publication date, ISBN, page count, list price in Swiss francs, the languages and file formats on sale, the technical committee and subcommittee, ICS codes with their titles, keyword and Sustainable Development Goal classifications, the full edition and amendment lifecycle, sibling publications and the publications that cite this one.

How to use it

The id is the number in a webstore URL such as webstore.iec.ch/en/publication/4028, and this endpoint takes a list, so resolve several publications in one call rather than looping. A reference string like 'IEC 60335-1:2020' is not an id — put it in the `query` of /iec/publications/search and read the id off the result. Withdrawn, revised and replaced publications resolve here exactly like published ones, so read `status` rather than assuming a hit means the document is current; `lifecycle` lists every edition and amendment of the same base reference with its own id and status, which is how you walk from an old edition to the current one. The record is catalogue metadata only — `deliverables[].location` names the paywalled PDF path but its content is not returned. `abstract` is populated on most records overall, but fill varies sharply by publisher and deliverable type rather than by date — expect it on published, TRF and withdrawn documents, and expect it missing more often on IECEx/IECQ conformity deliverables and CISPR publications.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• publications array required — IEC Webstore publication ids. Accepts the bare numeric id, the `iec:pub:{id}` URN, or a webstore publication URL containing it (examples: ["4028"], ["4028","2519"], ["https://webstore.iec.ch/en/publication/91954"], ["iec:pub:66118"]; minItems: 1; maxItems: 20)

Response

• @type string (default: "IecPublication")
• id string required
• urn string nullable
• url string nullable
• art_num string nullable
• reference string nullable
• reference_parts object nullable
  • @type string (default: "IecReferenceParts")
  • head string nullable
  • number string nullable
  • part string nullable
  • section string nullable
  • amendment string nullable
  • corrigendum string nullable
  • version string nullable
  • issue string nullable
• publication_title string nullable
• abstract string nullable
• edition string nullable
• status string nullable
• document_form string nullable
• publication_date string nullable
• isbn string nullable
• page_count integer nullable
• price object nullable
  • @type string (default: "IecPrice")
  • amount number nullable
  • currency string nullable
• available_formats array (default: [])
• available_files array (default: [])
  • @type string (default: "IecAvailableFile")
  • file_format string nullable
  • language string nullable
  • file_type string nullable
  • has_full_pdf boolean nullable
  • has_supporting_content boolean nullable
  • has_zipped_document boolean nullable
• preview_languages array (default: [])
• deliverables array (default: [])
  • @type string (default: "IecDeliverable")
  • art_num string nullable
  • deliverable_type string nullable
  • location string nullable
  • languages array (default: [])
  • last_update string nullable
• committee object nullable
  • @type string (default: "IecCommittee")
  • level_1 string nullable
  • level_1_title string nullable
  • level_2 string nullable
  • level_2_title string nullable
• ics array (default: [])
  • @type string (default: "IecIcsCode")
  • level_1 string nullable
  • level_1_title string nullable
  • level_2 string nullable
  • level_2_title string nullable
  • level_3 string nullable
  • level_3_title string nullable
• classifications array (default: [])
  • @type string (default: "IecClassification")
  • classification_type string nullable
  • value string nullable
• lifecycle array (default: [])
  • @type string (default: "IecLifecycleEntry")
  • id string nullable
  • reference string nullable
  • edition string nullable
  • publication_date string nullable
  • forecast_publication_date string nullable
  • status string nullable
  • stage string nullable
  • is_in_progress boolean nullable
  • is_national_committee_only boolean nullable
• related_publications array (default: [])
  • @type string (default: "IecRelatedPublication")
  • id string nullable
  • reference string nullable
  • status string nullable
  • url string nullable
• referenced_by array (default: [])
  • @type string (default: "IecRelatedPublication")
  • id string nullable
  • reference string nullable
  • status string nullable
  • url string nullable

Errors

• 422 — An input could not be parsed as an IEC publication id 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 — None of the supplied ids exist in the IEC catalogue 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.