get search aspectId fullsearch - bclaws API | Specway Docs

GET

A listing of metadata available for the specified aspect and search term from the BCLaws legislative repository

http://www.bclaws.ca/civix/search/{aspectId}/fullsearch

Access Token Required: API Key

Path Parameters

aspectIdstringrequiredDefault: complete

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

Allowed:

Query Params

qstringrequiredDefault: water

query term

sstringrequiredDefault: 0

first hit (start index)

eintegerrequiredDefault: 20

last hit (end index)

nFragintegerrequiredDefault: 5

number of fragment snippets to return (< 10)

lFragintegerrequiredDefault: 100

length of fragment snippets (< 200)

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

curl --request GET \
     --url 'http://www.bclaws.ca/civix/search/{aspectId}/fullsearch' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

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

GET