@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api BC Laws
@base http://www.bclaws.ca/civix
@version 1.0.0
@common_fields {aspectId: str(complete/corpreg/bcgaz1/bcgaz2/oic/psl/ecb/hscr/arch_oic)=complete}
@endpoints 7
@toc content(2), document(4), search(1)

@group content
@endpoint GET /content/{aspectId}
@returns(200)

@endpoint GET /content/{aspectId}/{civixDocumentId}
@required {civixDocumentId: str=statreg}
@returns(200)

@endgroup

@group document
@endpoint GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}
@required {civixIndexId: str=statreg, civixDocumentId: str=01009_01}
@returns(200)

@endpoint GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml
@required {civixIndexId: str=statreg, civixDocumentId: str=01009_01}
@returns(200)

@endpoint GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/search/{searchString}
@required {civixIndexId: str=statreg, civixDocumentId: str=01009_01, searchString: str=water}
@returns(200)

@endpoint GET /document/id/{aspectId}/{civixIndexId}/{civixDocumentId}/xml/search/{searchString}
@required {civixIndexId: str=statreg, civixDocumentId: str=01009_01, searchString: str=water}
@returns(200)

@endgroup

@group search
@endpoint GET /search/{aspectId}/fullsearch
@required {q: str=water, s: str=0, e: int=20, nFrag: int=5, lFrag: int=100}
@returns(200)

@endgroup

@end