{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:bclaws-ca-bclaws/get-content-aspect-id":{"get":{"operationId":"open_data_bclaws_ca_bclaws_get_content_aspect_id","summary":"Describes the documents and directories available within a specific 'aspect' (content group) of the BCLaws…","description":"GET /content/{aspectId}","tags":["open-data"],"parameters":[{"name":"aspectId","in":"query","required":true,"description":"The identifier of the 'aspect' (content group) to search","schema":{"type":"string","enum":["complete","corpreg","bcgaz1","bcgaz2","oic","psl","ecb","hscr","arch_oic"],"default":"complete","description":"The identifier of the 'aspect' (content group) to search"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bclaws-ca-bclaws/get-content-aspect-id-civix-document-id":{"get":{"operationId":"open_data_bclaws_ca_bclaws_get_content_aspect_id_civix_document_id","summary":"Lists the metadata available for the specified index or directory from the BCLaws legislative respository","description":"GET /content/{aspectId}/{civixDocumentId}","tags":["open-data"],"parameters":[{"name":"aspectId","in":"query","required":true,"description":"The identifier of the 'aspect' (content group) to search","schema":{"type":"string","enum":["complete","corpreg","bcgaz1","bcgaz2","oic","psl","ecb","hscr","arch_oic"],"default":"complete","description":"The identifier of the 'aspect' (content group) to search"}},{"name":"civixDocumentId","in":"query","required":true,"description":"The document identification code for an index or directory","schema":{"type":"string","default":"statreg","description":"The document identification code for an index or directory"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bclaws-ca-bclaws/get-document-id-aspect-id-civix-index-id-civix-document-id":{"get":{"operationId":"open_data_bclaws_ca_bclaws_get_document_id_aspect_id_civix_index_id_civix_document_id","summary":"Retrieves a specific document from the BCLaws legislative repository (HTML format)","description":"GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}","tags":["open-data"],"parameters":[{"name":"aspectId","in":"query","required":true,"description":"The identifier of the 'aspect' (content group) to search","schema":{"type":"string","enum":["complete","corpreg","bcgaz1","bcgaz2","oic","psl","ecb","hscr","arch_oic"],"default":"complete","description":"The identifier of the 'aspect' (content group) to search"}},{"name":"civixIndexId","in":"query","required":true,"description":"Index identification code","schema":{"type":"string","default":"statreg","description":"Index identification code"}},{"name":"civixDocumentId","in":"query","required":true,"description":"The document identification code for an index or directory","schema":{"type":"string","default":"01009_01","description":"The document identification code for an index or directory"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bclaws-ca-bclaws/get-document-id-aspect-id-civix-index-id-civix-document-id-s":{"get":{"operationId":"open_data_bclaws_ca_bclaws_get_document_id_aspect_id_civix_index_id_civix_document_id_s","summary":"Retrieves a specific document from the BCLaws legislative repository with search text highlighted (HTML…","description":"GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/search/{searchString}","tags":["open-data"],"parameters":[{"name":"aspectId","in":"query","required":true,"description":"The identifier of the 'aspect' (content group) to search","schema":{"type":"string","enum":["complete","corpreg","bcgaz1","bcgaz2","oic","psl","ecb","hscr","arch_oic"],"default":"complete","description":"The identifier of the 'aspect' (content group) to search"}},{"name":"civixIndexId","in":"query","required":true,"description":"Index identification code","schema":{"type":"string","default":"statreg","description":"Index identification code"}},{"name":"civixDocumentId","in":"query","required":true,"description":"The document identification code for an index or directory","schema":{"type":"string","default":"01009_01","description":"The document identification code for an index or directory"}},{"name":"searchString","in":"query","required":true,"description":"The text to search for within the document","schema":{"type":"string","default":"water","description":"The text to search for within the document"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bclaws-ca-bclaws/get-document-id-aspect-id-civix-index-id-civix-document-id-x":{"get":{"operationId":"open_data_bclaws_ca_bclaws_get_document_id_aspect_id_civix_index_id_civix_document_id_x","summary":"Retrieves a specific document from the BCLaws legislative repository (XML format)","description":"GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml","tags":["open-data"],"parameters":[{"name":"aspectId","in":"query","required":true,"description":"The identifier of the 'aspect' (content group) to search","schema":{"type":"string","enum":["complete","corpreg","bcgaz1","bcgaz2","oic","psl","ecb","hscr","arch_oic"],"default":"complete","description":"The identifier of the 'aspect' (content group) to search"}},{"name":"civixIndexId","in":"query","required":true,"description":"Index identification code","schema":{"type":"string","default":"statreg","description":"Index identification code"}},{"name":"civixDocumentId","in":"query","required":true,"description":"The document identification code for an index or directory","schema":{"type":"string","default":"01009_01","description":"The document identification code for an index or directory"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bclaws-ca-bclaws/get-document-id-aspect-id-civix-index-id-civix-document-id-x-2":{"get":{"operationId":"open_data_bclaws_ca_bclaws_get_document_id_aspect_id_civix_index_id_civix_document_id_x_2","summary":"Retrieves a specific document from the BCLaws legislative repository with search text highlighted (XML format)","description":"GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml/search/{searchString}","tags":["open-data"],"parameters":[{"name":"aspectId","in":"query","required":true,"description":"The identifier of the 'aspect' (content group) to search","schema":{"type":"string","enum":["complete","corpreg","bcgaz1","bcgaz2","oic","psl","ecb","hscr","arch_oic"],"default":"complete","description":"The identifier of the 'aspect' (content group) to search"}},{"name":"civixIndexId","in":"query","required":true,"description":"Index identification code","schema":{"type":"string","default":"statreg","description":"Index identification code"}},{"name":"civixDocumentId","in":"query","required":true,"description":"The document identification code for an index or directory","schema":{"type":"string","default":"01009_01","description":"The document identification code for an index or directory"}},{"name":"searchString","in":"query","required":true,"description":"The text to search for within the document","schema":{"type":"string","default":"water","description":"The text to search for within the document"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:bclaws-ca-bclaws/get-search-aspect-id-fullsearch":{"get":{"operationId":"open_data_bclaws_ca_bclaws_get_search_aspect_id_fullsearch","summary":"A listing of metadata available for the specified aspect and search term from the BCLaws legislative…","description":"GET /search/{aspectId}/fullsearch","tags":["open-data"],"parameters":[{"name":"aspectId","in":"query","required":true,"description":"The identifier of the 'aspect' (content group) to search","schema":{"type":"string","enum":["complete","corpreg","bcgaz1","bcgaz2","oic","psl","ecb","hscr","arch_oic"],"default":"complete","description":"The identifier of the 'aspect' (content group) to search"}},{"name":"q","in":"query","required":true,"description":"query term","schema":{"type":"string","default":"water","description":"query term"}},{"name":"s","in":"query","required":true,"description":"first hit (start index)","schema":{"type":"string","default":"0","description":"first hit (start index)"}},{"name":"e","in":"query","required":true,"description":"last hit (end index)","schema":{"type":"integer","default":20,"description":"last hit (end index)"}},{"name":"nFrag","in":"query","required":true,"description":"number of fragment snippets to return (< 10)","schema":{"type":"integer","default":5,"description":"number of fragment snippets to return (< 10)"}},{"name":"lFrag","in":"query","required":true,"description":"length of fragment snippets (< 200)","schema":{"type":"integer","default":100,"description":"length of fragment snippets (< 200)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}