{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:gov-bc-ca-gwells/aquifer-codes-demand-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifer_codes_demand_list","summary":"return a list of aquifer demand codes","description":"GET /aquifer-codes/demand/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifer-codes-materials-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifer_codes_materials_list","summary":"return a list of aquifer material codes","description":"GET /aquifer-codes/materials/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifer-codes-productivity-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifer_codes_productivity_list","summary":"return a list of aquifer productivity codes","description":"GET /aquifer-codes/productivity/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifer-codes-quality-concerns-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifer_codes_quality_concerns_list","summary":"return a list of quality concern codes","description":"GET /aquifer-codes/quality-concerns/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifer-codes-subtypes-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifer_codes_subtypes_list","summary":"return a list of aquifer subtype codes","description":"GET /aquifer-codes/subtypes/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifer-codes-vulnerability-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifer_codes_vulnerability_list","summary":"return a list of aquifer vulnerability codes","description":"GET /aquifer-codes/vulnerability/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifer-codes-water-use-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifer_codes_water_use_list","summary":"return a list of water use codes","description":"GET /aquifer-codes/water-use/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifers-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifers_list","summary":"return a list of aquifers","description":"GET /aquifers/","tags":["open-data"],"parameters":[{"name":"aquifer_id","in":"query","required":false,"schema":{"type":"number"}},{"name":"ordering","in":"query","required":false,"description":"Which field to use when ordering the results.","schema":{"type":"string","description":"Which field to use when ordering the results."}},{"name":"search","in":"query","required":false,"description":"A search term.","schema":{"type":"string","description":"A search term."}},{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifers-names-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifers_names_list","summary":"List all aquifers in a simplified format","description":"GET /aquifers/names/","tags":["open-data"],"parameters":[{"name":"search","in":"query","required":false,"description":"A search term.","schema":{"type":"string","description":"A search term."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifers-read":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifers_read","summary":"return details of aquifers","description":"GET /aquifers/{aquifer_id}/","tags":["open-data"],"parameters":[{"name":"aquifer_id","in":"query","required":true,"description":"A unique integer value identifying this aquifer.","schema":{"type":"integer","description":"A unique integer value identifying this aquifer."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/aquifers-files-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_aquifers_files_list","summary":"list files found for the aquifer identified in the uri","description":"GET /aquifers/{aquifer_id}/files","tags":["open-data"],"parameters":[{"name":"aquifer_id","in":"query","required":true,"schema":{"type":"string"}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/cities-drillers-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_cities_drillers_list","summary":"returns a list of cities with a qualified, registered operator (driller or installer)","description":"GET /cities/drillers/","tags":["open-data"],"parameters":[],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/cities-installers-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_cities_installers_list","summary":"returns a list of cities with a qualified, registered operator (driller or installer)","description":"GET /cities/installers/","tags":["open-data"],"parameters":[],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/config-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_config_list","summary":"serves general configuration","description":"GET /config","tags":["open-data"],"parameters":[],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/drillers-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_drillers_list","summary":"Returns a list of all person records","description":"GET /drillers/","tags":["open-data"],"parameters":[{"name":"search","in":"query","required":false,"description":"A search term.","schema":{"type":"string","description":"A search term."}},{"name":"ordering","in":"query","required":false,"description":"Which field to use when ordering the results.","schema":{"type":"string","description":"Which field to use when ordering the results."}},{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/drillers-names-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_drillers_names_list","summary":"Search for a person in the Register","description":"GET /drillers/names/","tags":["open-data"],"parameters":[{"name":"search","in":"query","required":false,"description":"A search term.","schema":{"type":"string","description":"A search term."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/drillers-files-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_drillers_files_list","summary":"list files found for the aquifer identified in the uri","description":"GET /drillers/{person_guid}/files/","tags":["open-data"],"parameters":[{"name":"person_guid","in":"query","required":true,"schema":{"type":"string"}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/keycloak-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_keycloak_list","summary":"serves keycloak config","description":"GET /keycloak","tags":["open-data"],"parameters":[],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/submissions-options-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_submissions_options_list","summary":"Options required for submitting activity report forms","description":"GET /submissions/options/","tags":["open-data"],"parameters":[],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/surveys-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_surveys_list","summary":"returns a list of active surveys","description":"GET /surveys/","tags":["open-data"],"parameters":[],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/wells-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_wells_list","summary":"returns a list of wells","description":"GET /wells/","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return per page.","schema":{"type":"integer","description":"Number of results to return per page."}},{"name":"offset","in":"query","required":false,"description":"The initial index from which to return the results.","schema":{"type":"integer","description":"The initial index from which to return the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/wells-tags-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_wells_tags_list","summary":"seach for wells by tag or owner","description":"GET /wells/tags/","tags":["open-data"],"parameters":[{"name":"search","in":"query","required":false,"description":"A search term.","schema":{"type":"string","description":"A search term."}},{"name":"ordering","in":"query","required":false,"description":"Which field to use when ordering the results.","schema":{"type":"string","description":"Which field to use when ordering the results."}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/wells-files-list":{"get":{"operationId":"open_data_gov_bc_ca_gwells_wells_files_list","summary":"list files found for the well identified in the uri","description":"GET /wells/{tag}/files","tags":["open-data"],"parameters":[{"name":"tag","in":"query","required":true,"schema":{"type":"string"}}],"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":"byok"}},"/v1/open-data:gov-bc-ca-gwells/wells-read":{"get":{"operationId":"open_data_gov_bc_ca_gwells_wells_read","summary":"Return well detail. This view is open to all, and has no permissions.","description":"GET /wells/{well_tag_number}","tags":["open-data"],"parameters":[{"name":"well_tag_number","in":"query","required":true,"description":"A unique integer value identifying this well.","schema":{"type":"integer","description":"A unique integer value identifying this well."}}],"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":"byok"}}},"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"}}}}}}}