get document id aspectId civixIndexId civixDocumentId xml search searchString - bclaws API | Specway Docs

GET

Retrieves a specific document from the BCLaws legislative repository with search text highlighted (XML format)

http://www.bclaws.ca/civix/document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml/search/{searchString}

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.

Access Token Required: API Key

Path Parameters

aspectIdstringrequiredDefault: complete

The identifier of the 'aspect' (content group) to search

Allowed:

civixIndexIdstringrequiredDefault: statreg

Index identification code

civixDocumentIdstringrequiredDefault: 01009_01

The document identification code for an index or directory

searchStringstringrequiredDefault: water

The text to search for within the document

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://www.bclaws.ca/civix/document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml/search/{searchString}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET