GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml/search/{searchString}
Summary: Retrieves a specific document from the BCLaws legislative repository with search text highlighted (XML format)
Operation ID: —
Auth: none
Operation ID: —
Auth: none
Description
The /document API allows you to retrieve actual documents from the BCLaws legislative repository. To retrieve a document from the repository you need the aspect identifier and two other specific pieces of information about the document: the index identifier and the document identifier. These unique identifiers can be retrieved from the /content API.
Parameters (4)
aspectId
(string, path, required, default: complete)
The identifier of the 'aspect' (content group) to search
Constraints: {'enum': ['complete', 'corpreg', 'bcgaz1', 'bcgaz2', 'oic', 'psl', 'ecb', 'hscr', 'arch_oic']}
civixDocumentId
(string, path, required, default: 01009_01)
The document identification code for an index or directory
civixIndexId
(string, path, required, default: statreg)
Index identification code
searchString
(string, path, required, default: water)
The text to search for within the document
Examples (1)
| Title | Type | URL | Action |
|---|---|---|---|
| Search for water in Drinking Water Protection Act (XML) | probe-gate |
https://www.bclaws.ca/civix/document/id/complete/statreg/01009_01/xml/search/water |
No probe data for this endpoint yet.