{ "openapi": "3.0.0", "info": { "title": "Groundwater Wells, Aquifers and Registry API", "description": "The groundwater wells, aquifers and registry API contains information related to groundwater wells and aquifers as well as a register of qualified well drillers and well pump installers registered to operate in B.C.", "termsOfService": "http://www2.gov.bc.ca/gov/content?id=D1EE0A405E584363B205CD4353E02C88", "contact": { "email": "groundwater@gov.bc.ca" }, "license": { "name": "Open Government License - British Columbia", "url": "https://www2.gov.bc.ca/gov/content?id=A519A56BC2BF44E4A008B33FCF527F61" }, "version": "v1" }, "security": [ { "Bearer": [] } ], "paths": { "/api-token-auth/": { "parameters": [] }, "/aquifer-codes/demand/": { "get": { "operationId": "aquifer-codes_demand_list", "description": "return a list of aquifer demand codes", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AquiferDemand" } } } } } } } }, "tags": [ "aquifer-codes" ] }, "parameters": [] }, "/aquifer-codes/materials/": { "get": { "operationId": "aquifer-codes_materials_list", "description": "return a list of aquifer material codes", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AquiferMaterial" } } } } } } } }, "tags": [ "aquifer-codes" ] }, "parameters": [] }, "/aquifer-codes/productivity/": { "get": { "operationId": "aquifer-codes_productivity_list", "description": "return a list of aquifer productivity codes", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AquiferProductivity" } } } } } } } }, "tags": [ "aquifer-codes" ] }, "parameters": [] }, "/aquifer-codes/quality-concerns/": { "get": { "operationId": "aquifer-codes_quality-concerns_list", "description": "return a list of quality concern codes", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/QualityConcern" } } } } } } } }, "tags": [ "aquifer-codes" ] }, "parameters": [] }, "/aquifer-codes/subtypes/": { "get": { "operationId": "aquifer-codes_subtypes_list", "description": "return a list of aquifer subtype codes", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AquiferSubtype" } } } } } } } }, "tags": [ "aquifer-codes" ] }, "parameters": [] }, "/aquifer-codes/vulnerability/": { "get": { "operationId": "aquifer-codes_vulnerability_list", "description": "return a list of aquifer vulnerability codes", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AquiferVulnerability" } } } } } } } }, "tags": [ "aquifer-codes" ] }, "parameters": [] }, "/aquifer-codes/water-use/": { "get": { "operationId": "aquifer-codes_water-use_list", "description": "return a list of water use codes", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WaterUse" } } } } } } } }, "tags": [ "aquifer-codes" ] }, "parameters": [] }, "/aquifers/": { "get": { "operationId": "aquifers_list", "description": "return a list of aquifers", "parameters": [ { "name": "aquifer_id", "in": "query", "description": "", "required": false, "schema": { "type": "number" } }, { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Aquifer" } } } } } } } }, "tags": [ "aquifers" ] }, "parameters": [] }, "/aquifers/names/": { "get": { "operationId": "aquifers_names_list", "description": "List all aquifers in a simplified format", "parameters": [ { "name": "search", "in": "query", "description": "A search term.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AquiferSerializerBasic" } } } } } }, "tags": [ "aquifers" ] }, "parameters": [] }, "/aquifers/{aquifer_id}/": { "get": { "operationId": "aquifers_read", "description": "return details of aquifers", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Aquifer" } } } } }, "tags": [ "aquifers" ] }, "parameters": [ { "name": "aquifer_id", "in": "path", "description": "A unique integer value identifying this aquifer.", "required": true, "schema": { "type": "integer" } } ] }, "/aquifers/{aquifer_id}/files": { "get": { "operationId": "aquifers_files_list", "description": "list files found for the aquifer identified in the uri", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "public": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } }, "private": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } } } } } } } }, "tags": [ "aquifers" ] }, "parameters": [ { "name": "aquifer_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/cities/drillers/": { "get": { "operationId": "cities_drillers_list", "description": "returns a list of cities with a qualified, registered operator (driller or installer)", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityList" } } } } } }, "tags": [ "cities" ] }, "parameters": [] }, "/cities/installers/": { "get": { "operationId": "cities_installers_list", "description": "returns a list of cities with a qualified, registered operator (driller or installer)", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityList" } } } } } }, "tags": [ "cities" ] }, "parameters": [] }, "/config": { "get": { "operationId": "config_list", "description": "serves general configuration", "responses": { "200": { "description": "" } }, "tags": [ "config" ] }, "parameters": [] }, "/drillers/": { "get": { "operationId": "drillers_list", "description": "Returns a list of all person records", "parameters": [ { "name": "search", "in": "query", "description": "A search term.", "required": false, "schema": { "type": "string" } }, { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonList" } } } } } }, "tags": [ "drillers" ] }, "parameters": [] }, "/drillers/names/": { "get": { "operationId": "drillers_names_list", "description": "Search for a person in the Register", "parameters": [ { "name": "search", "in": "query", "description": "A search term.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonName" } } } } } }, "tags": [ "drillers" ] }, "parameters": [] }, "/drillers/options/": { "parameters": [] }, "/drillers/{person_guid}/files/": { "get": { "operationId": "drillers_files_list", "description": "list files found for the aquifer identified in the uri", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "public": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } }, "private": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } } } } } } } }, "tags": [ "drillers" ] }, "parameters": [ { "name": "person_guid", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/keycloak": { "get": { "operationId": "keycloak_list", "description": "serves keycloak config", "responses": { "200": { "description": "" } }, "tags": [ "keycloak" ] }, "parameters": [] }, "/submissions/options/": { "get": { "operationId": "submissions_options_list", "description": "Options required for submitting activity report forms", "responses": { "200": { "description": "" } }, "tags": [ "submissions" ] }, "parameters": [] }, "/surveys/": { "get": { "operationId": "surveys_list", "description": "returns a list of active surveys", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Survey" } } } } } }, "tags": [ "surveys" ] }, "parameters": [] }, "/wells/": { "get": { "operationId": "wells_list", "description": "returns a list of wells", "parameters": [ { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri" }, "previous": { "type": "string", "format": "uri" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WellList" } } } } } } } }, "tags": [ "wells" ] }, "parameters": [] }, "/wells/extracts": { "parameters": [] }, "/wells/tags/": { "get": { "operationId": "wells_tags_list", "description": "seach for wells by tag or owner", "parameters": [ { "name": "search", "in": "query", "description": "A search term.", "required": false, "schema": { "type": "string" } }, { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellTagSearch" } } } } } }, "tags": [ "wells" ] }, "parameters": [] }, "/wells/{tag}/files": { "get": { "operationId": "wells_files_list", "description": "list files found for the well identified in the uri", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "public": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } }, "private": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } } } } } } } } }, "tags": [ "wells" ] }, "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/wells/{well_tag_number}": { "get": { "operationId": "wells_read", "description": "Return well detail.\nThis view is open to all, and has no permissions.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WellDetail" } } } } }, "tags": [ "wells" ] }, "parameters": [ { "name": "well_tag_number", "in": "path", "description": "A unique integer value identifying this well.", "required": true, "schema": { "type": "integer" } } ] } }, "servers": [ { "url": "https://apps.nrs.gov.bc.ca/gwells/api/v1/" } ], "components": { "securitySchemes": { "Bearer": { "type": "apiKey", "name": "JWT", "in": "header" } }, "schemas": { "AquiferDemand": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "maxLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 100 } } }, "AquiferMaterial": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "maxLength": 10 }, "description": { "title": "Description", "type": "string", "maxLength": 100 } } }, "AquiferProductivity": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "maxLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 100 } } }, "QualityConcern": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "maxLength": 2 }, "description": { "title": "Description", "type": "string", "maxLength": 100 } } }, "AquiferSubtype": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "maxLength": 3 }, "description": { "title": "Description", "type": "string" } } }, "AquiferVulnerability": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "maxLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 100 } } }, "WaterUse": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "maxLength": 2 }, "description": { "title": "Description", "type": "string", "maxLength": 100 } } }, "Aquifer": { "type": "object", "properties": { "aquifer_id": { "title": "Aquifer ID Number", "type": "integer", "readOnly": true }, "aquifer_name": { "title": "Aquifer name", "type": "string", "maxLength": 100 }, "area": { "title": "Size (square km)", "type": "string", "format": "decimal" }, "demand_description": { "title": "Demand description", "type": "string", "readOnly": true }, "demand": { "title": "Demand Reference", "type": "string" }, "known_water_use_description": { "title": "Known water use description", "type": "string", "readOnly": true }, "known_water_use": { "title": "Known Water Use Reference", "type": "string" }, "litho_stratographic_unit": { "title": "Lithographic Stratographic Unit", "type": "string", "maxLength": 100 }, "location_description": { "title": "Description of Location", "type": "string", "maxLength": 100 }, "mapping_year": { "title": "Date of Mapping", "description": "Use the following format: ", "type": "integer", "maximum": 2019, "minimum": 1990 }, "material_description": { "title": "Material description", "type": "string", "readOnly": true }, "material": { "title": "Material Reference", "type": "string" }, "notes": { "title": "Notes on Aquifer, for internal use only.", "type": "string", "maxLength": 2000 }, "productivity_description": { "title": "Productivity description", "type": "string", "readOnly": true }, "productivity": { "title": "Productivity Reference", "type": "string" }, "quality_concern_description": { "title": "Quality concern description", "type": "string", "readOnly": true }, "quality_concern": { "title": "Quality Concern Reference", "type": "string" }, "subtype_description": { "title": "Subtype description", "type": "string", "readOnly": true }, "subtype": { "title": "Subtype Reference", "type": "string" }, "vulnerability_description": { "title": "Vulnerability description", "type": "string", "readOnly": true }, "vulnerability": { "title": "Aquifer Vulnerabiliy", "type": "string" } } }, "AquiferSerializerBasic": { "type": "object", "properties": { "aquifer_id": { "title": "Aquifer ID Number", "type": "integer", "readOnly": true }, "description": { "title": "Description", "type": "string", "readOnly": true } } }, "Organization": { "title": "Organization", "required": [ "name", "province_state" ], "type": "object", "properties": { "org_guid": { "title": "Organization UUID", "type": "string", "format": "uuid", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 200 }, "org_verbose_name": { "title": "Org verbose name", "type": "string", "readOnly": true }, "street_address": { "title": "Street Address", "type": "string", "maxLength": 100 }, "city": { "title": "Town/City", "type": "string", "maxLength": 50 }, "province_state": { "title": "Province/State", "type": "string" }, "postal_code": { "title": "Postal Code", "type": "string", "maxLength": 10 }, "main_tel": { "title": "Telephone number", "type": "string", "maxLength": 15 }, "fax_tel": { "title": "Fax number", "type": "string", "maxLength": 15 }, "email": { "title": "Email adddress", "type": "string", "format": "email", "maxLength": 254 }, "website_url": { "title": "Website", "type": "string", "format": "uri", "maxLength": 200 } } }, "CityList": { "required": [ "organization" ], "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/Organization" } } }, "Qualification": { "required": [ "well_class" ], "type": "object", "properties": { "well_class": { "title": "Well class", "type": "string" }, "description": { "title": "Description", "type": "string", "readOnly": true } } }, "Subactivity": { "title": "Subactivity", "required": [ "description" ], "type": "object", "properties": { "registries_subactivity_code": { "title": "Registries subactivity code", "type": "string", "readOnly": true }, "description": { "title": "Description", "type": "string", "maxLength": 100 }, "qualification_set": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" }, "readOnly": true } } }, "ApplicationStatusCode": { "title": "Current status", "required": [ "description" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "readOnly": true }, "description": { "title": "Description", "type": "string", "maxLength": 100 } } }, "ApplicationList": { "required": [ "subactivity" ], "type": "object", "properties": { "qualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" }, "readOnly": true }, "subactivity": { "$ref": "#/components/schemas/Subactivity" }, "cert_authority": { "title": "Cert authority", "type": "string", "readOnly": true }, "removal_date": { "title": "Removal date", "type": "string", "format": "date" }, "certificate": { "title": "Certificate", "type": "string", "readOnly": true }, "display_status": { "title": "Display status", "type": "string", "readOnly": true }, "current_status": { "$ref": "#/components/schemas/ApplicationStatusCode" } } }, "OrganizationList": { "title": "Organization", "required": [ "name", "province_state" ], "type": "object", "properties": { "org_guid": { "title": "Organization UUID", "type": "string", "format": "uuid", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 200 }, "org_verbose_name": { "title": "Org verbose name", "type": "string", "readOnly": true }, "street_address": { "title": "Street Address", "type": "string", "maxLength": 100 }, "city": { "title": "Town/City", "type": "string", "maxLength": 50 }, "province_state": { "title": "Province/State", "type": "string" }, "postal_code": { "title": "Postal Code", "type": "string", "maxLength": 10 }, "main_tel": { "title": "Telephone number", "type": "string", "maxLength": 15 }, "fax_tel": { "title": "Fax number", "type": "string", "maxLength": 15 }, "email": { "title": "Email adddress", "type": "string", "format": "email", "maxLength": 254 }, "website_url": { "title": "Website", "type": "string", "format": "uri", "maxLength": 200 } } }, "RegistrationsList": { "required": [ "organization" ], "type": "object", "properties": { "activity": { "title": "Activity", "type": "string", "readOnly": true }, "activity_description": { "title": "Activity description", "type": "string", "readOnly": true }, "registration_no": { "title": "Registration no", "type": "string", "maxLength": 15 }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationList" }, "readOnly": true }, "organization": { "$ref": "#/components/schemas/OrganizationList" } } }, "PersonList": { "required": [ "first_name", "surname" ], "type": "object", "properties": { "person_guid": { "title": "Person UUID", "type": "string", "format": "uuid", "readOnly": true }, "first_name": { "title": "First name", "type": "string", "maxLength": 100 }, "surname": { "title": "Surname", "type": "string", "maxLength": 100 }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/RegistrationsList" }, "readOnly": true }, "contact_tel": { "title": "Contact telephone number", "type": "string", "maxLength": 15 }, "contact_cell": { "title": "Contact cell number", "type": "string", "maxLength": 15 }, "contact_email": { "title": "Email address", "type": "string", "format": "email", "maxLength": 254 } } }, "RegistrationsNumber": { "required": [ "registries_activity" ], "type": "object", "properties": { "registration_no": { "title": "Registration no", "type": "string", "maxLength": 15 }, "registries_activity": { "title": "Registries activity", "type": "string" } } }, "PersonName": { "type": "object", "properties": { "name": { "title": "Name", "type": "string", "readOnly": true }, "person_guid": { "title": "Person UUID", "type": "string", "format": "uuid", "readOnly": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/RegistrationsNumber" }, "readOnly": true } } }, "Survey": { "type": "object", "properties": { "survey_guid": { "title": "Survey guid", "type": "string", "format": "uuid", "readOnly": true }, "survey_introduction_text": { "title": "Introduction Text", "type": "string", "maxLength": 250 }, "survey_link": { "title": "Link", "type": "string", "maxLength": 100 }, "survey_page": { "title": "Page", "type": "string", "enum": [ "w", "r", "s", "a" ] } } }, "WellList": { "required": [ "owner_full_name" ], "type": "object", "properties": { "well_guid": { "title": "Well guid", "type": "string", "format": "uuid", "readOnly": true }, "well_tag_number": { "title": "Well Tag Number", "type": "integer", "readOnly": true }, "identification_plate_number": { "title": "Well Identification Plate Number", "type": "integer", "maximum": 2147483647, "minimum": 0 }, "owner_full_name": { "title": "Owner Name", "type": "string", "maxLength": 200 }, "well_class": { "title": "Well Class", "type": "string" }, "well_subclass": { "title": "Well Subclass", "type": "string", "format": "uuid" }, "intended_water_use": { "title": "Intended Water Use", "type": "string" }, "well_status": { "title": "Well Status", "type": "string" }, "licenced_status": { "title": "Licenced Status", "type": "string" }, "street_address": { "title": "Street Address", "type": "string", "maxLength": 100 }, "city": { "title": "Town/City", "type": "string", "maxLength": 50 }, "legal_lot": { "title": "Lot", "type": "string", "maxLength": 10 }, "legal_plan": { "title": "Plan", "type": "string", "maxLength": 20 }, "legal_district_lot": { "title": "District Lot", "type": "string", "maxLength": 20 }, "legal_block": { "title": "Block", "type": "string", "maxLength": 10 }, "legal_section": { "title": "Section", "type": "string", "maxLength": 10 }, "legal_township": { "title": "Township", "type": "string", "maxLength": 20 }, "legal_range": { "title": "Range", "type": "string", "maxLength": 10 }, "land_district": { "title": "Land District", "type": "string" }, "legal_pid": { "title": "Property Identification Description (PID)", "type": "integer", "maximum": 2147483647, "minimum": 0 }, "well_location_description": { "title": "Description of Well Location", "type": "string", "maxLength": 500 }, "construction_start_date": { "title": "Construction Start Date", "type": "string", "format": "date" }, "construction_end_date": { "title": "Construction Date", "type": "string", "format": "date" }, "alteration_end_date": { "title": "Alteration Date", "type": "string", "format": "date" }, "decommission_start_date": { "title": "Decommission Start Date", "type": "string", "format": "date" }, "decommission_end_date": { "title": "Decommission Date", "type": "string", "format": "date" }, "drilling_company": { "title": "Drilling Company", "type": "string", "format": "uuid" }, "well_identification_plate_attached": { "title": "Well Identification Plate Is Attached", "type": "string", "maxLength": 500 }, "id_plate_attached_by": { "title": "Well identification plate attached by", "type": "string", "maxLength": 100 }, "water_supply_system_name": { "title": "Water Supply System Name", "type": "string", "maxLength": 80 }, "water_supply_system_well_name": { "title": "Water Supply System Well Name", "type": "string", "maxLength": 80 }, "latitude": { "title": "Latitude", "type": "string", "format": "decimal" }, "longitude": { "title": "Longitude", "type": "string", "format": "decimal" }, "coordinate_acquisition_code": { "title": "Location Accuracy Code", "type": "string" }, "ground_elevation": { "title": "Ground Elevation", "type": "string", "format": "decimal" }, "ground_elevation_method": { "title": "Elevation Determined By", "type": "string" }, "drilling_method": { "title": "Drilling Method", "type": "string" }, "other_drilling_method": { "title": "Specify Other Drilling Method", "type": "string", "maxLength": 50 }, "well_orientation": { "title": "Orientation of Well", "type": "boolean", "enum": [ true, false ] }, "surface_seal_material": { "title": "Surface Seal Material", "type": "string" }, "surface_seal_length": { "title": "Surface Seal Length", "type": "string", "format": "decimal" }, "surface_seal_thickness": { "title": "Surface Seal Thickness", "type": "string", "format": "decimal" }, "surface_seal_method": { "title": "Surface Seal Installation Method", "type": "string" }, "surface_seal_depth": { "title": "Surface Seal Depth", "type": "string", "format": "decimal" }, "backfill_type": { "title": "Backfill Material Above Surface Seal", "type": "string", "maxLength": 250 }, "backfill_depth": { "title": "Backfill Depth", "type": "string", "format": "decimal" }, "liner_material": { "title": "Liner Material", "type": "string" }, "liner_diameter": { "title": "Liner Diameter", "type": "string", "format": "decimal" }, "liner_thickness": { "title": "Liner Thickness", "type": "string", "format": "decimal" }, "liner_from": { "title": "Liner From", "type": "string", "format": "decimal" }, "liner_to": { "title": "Liner To", "type": "string", "format": "decimal" }, "screen_intake_method": { "title": "Intake Method", "type": "string" }, "screen_type": { "title": "Type", "type": "string" }, "screen_material": { "title": "Material", "type": "string" }, "other_screen_material": { "title": "Specify Other Screen Material", "type": "string", "maxLength": 50 }, "screen_opening": { "title": "Opening", "type": "string" }, "screen_bottom": { "title": "Bottom", "type": "string" }, "other_screen_bottom": { "title": "Specify Other Screen Bottom", "type": "string", "maxLength": 50 }, "screen_information": { "title": "Screen Information", "type": "string", "maxLength": 300 }, "filter_pack_from": { "title": "Filter Pack From", "type": "string", "format": "decimal" }, "filter_pack_to": { "title": "Filter Pack To", "type": "string", "format": "decimal" }, "filter_pack_thickness": { "title": "Filter Pack Thickness", "type": "string", "format": "decimal" }, "filter_pack_material": { "title": "Filter Pack Material", "type": "string" }, "filter_pack_material_size": { "title": "Filter Pack Material Size", "type": "string" }, "development_method": { "title": "Developed By", "type": "string" }, "development_hours": { "title": "Development Total Duration", "type": "string", "format": "decimal" }, "development_notes": { "title": "Development Notes", "type": "string", "maxLength": 255 }, "yield_estimation_method": { "title": "Estimation Method", "type": "string" }, "yield_estimation_rate": { "title": "Estimation Rate", "type": "string", "format": "decimal" }, "yield_estimation_duration": { "title": "Estimation Duration", "type": "string", "format": "decimal" }, "well_yield_unit": { "title": "Well yield unit", "type": "string" }, "static_level_before_test": { "title": "SWL Before Test", "type": "string", "format": "decimal" }, "drawdown": { "title": "Drawdown", "type": "string", "format": "decimal" }, "hydro_fracturing_performed": { "title": "Hydro-fracturing Performed?", "type": "boolean", "enum": [ false, true ] }, "hydro_fracturing_yield_increase": { "title": "Well Yield Increase Due to Hydro-fracturing", "type": "string", "format": "decimal" }, "recommended_pump_depth": { "title": "Recommended pump depth", "type": "string", "format": "decimal" }, "recommended_pump_rate": { "title": "Recommended pump rate", "type": "string", "format": "decimal" }, "water_quality_characteristics": { "type": "array", "items": { "title": "Obvious Water Quality Characteristics", "type": "string" }, "uniqueItems": true }, "water_quality_colour": { "title": "Water Quality Colour", "type": "string", "maxLength": 60 }, "water_quality_odour": { "title": "Water Quality Odour", "type": "string", "maxLength": 60 }, "total_depth_drilled": { "title": "Total Depth Drilled", "type": "string", "format": "decimal" }, "finished_well_depth": { "title": "Finished Well Depth", "type": "string", "format": "decimal" }, "final_casing_stick_up": { "title": "Final Casing Stick Up", "type": "string", "format": "decimal" }, "bedrock_depth": { "title": "Depth to Bedrock", "type": "string", "format": "decimal" }, "static_water_level": { "title": "Static Water Level (BTOC)", "type": "string", "format": "decimal" }, "well_yield": { "title": "Estimated Well Yield", "type": "string", "format": "decimal" }, "artesian_flow": { "title": "Artesian Flow", "type": "string", "format": "decimal" }, "artesian_pressure": { "title": "Artesian Pressure", "type": "string", "format": "decimal" }, "well_cap_type": { "title": "Well Cap", "type": "string", "maxLength": 40 }, "well_disinfected": { "title": "Well Disinfected", "type": "boolean", "enum": [ false, true ] }, "comments": { "title": "Comments", "type": "string", "maxLength": 3000 }, "alternative_specs_submitted": { "title": "Alternative specs submitted (if required)", "type": "boolean", "enum": [ false, true ] }, "diameter": { "title": "Diameter", "type": "string", "maxLength": 9 }, "observation_well_number": { "title": "Observation Well Number", "type": "string", "maxLength": 30 }, "observation_well_status": { "title": "Observation Well Status", "type": "string" }, "ems": { "title": "Environmental Monitoring System (EMS) ID", "type": "string", "maxLength": 10 }, "aquifer": { "title": "Aquifer ID Number", "type": "integer" }, "utm_zone_code": { "title": "Zone", "type": "string", "maxLength": 10 }, "utm_northing": { "title": "UTM Northing", "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "utm_easting": { "title": "UTM Easting", "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "bcgs_id": { "title": "BCGS Mapsheet Number", "type": "integer" }, "decommission_reason": { "title": "Reason for Decommission", "type": "string", "maxLength": 250 }, "decommission_method": { "title": "Method of Decommission", "type": "string" }, "sealant_material": { "title": "Sealant Material", "type": "string", "maxLength": 100 }, "backfill_material": { "title": "Backfill Material", "type": "string", "maxLength": 100 }, "decommission_details": { "title": "Decommission Details", "type": "string", "maxLength": 250 }, "aquifer_vulnerability_index": { "title": "AVI", "type": "string", "format": "decimal" }, "storativity": { "title": "Storativity", "type": "string", "format": "decimal" }, "transmissivity": { "title": "Transmissivity", "type": "string", "format": "decimal" }, "hydraulic_conductivity": { "title": "Hydraulic Conductivity", "type": "string", "maxLength": 100 }, "specific_storage": { "title": "Specific Storage", "type": "string", "maxLength": 100 }, "specific_yield": { "title": "Specific Yield", "type": "string", "format": "decimal" }, "testing_method": { "title": "Testing Method", "type": "string", "maxLength": 100 }, "testing_duration": { "title": "Testing duration", "type": "integer", "maximum": 2147483647, "minimum": 0 }, "analytic_solution_type": { "title": "Analytic Solution Type", "type": "string", "format": "decimal" }, "boundary_effect": { "title": "Boundary Effect", "type": "string", "format": "decimal" } } }, "WellTagSearch": { "required": [ "owner_full_name" ], "type": "object", "properties": { "well_tag_number": { "title": "Well Tag Number", "type": "integer", "readOnly": true }, "owner_full_name": { "title": "Owner Name", "type": "string", "maxLength": 200 } } }, "PersonBasic": { "title": "Person responsible", "type": "object", "properties": { "person_guid": { "title": "Person UUID", "type": "string", "format": "uuid", "readOnly": true }, "name": { "title": "Name", "type": "string", "readOnly": true } } }, "OrganizationNameList": { "title": "Company of person responsible", "required": [ "name" ], "type": "object", "properties": { "org_guid": { "title": "Organization UUID", "type": "string", "format": "uuid", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 200 }, "org_verbose_name": { "title": "Org verbose name", "type": "string", "readOnly": true } } }, "Casing": { "required": [ "start", "end", "diameter" ], "type": "object", "properties": { "start": { "title": "From", "type": "string", "format": "decimal" }, "end": { "title": "To", "type": "string", "format": "decimal" }, "diameter": { "title": "Diameter", "type": "string", "format": "decimal" }, "casing_code": { "title": "Casing Type Code", "type": "string" }, "casing_material": { "title": "Casing Material Code", "type": "string" }, "drive_shoe": { "title": "Drive Shoe", "type": "boolean", "enum": [ false, true ] }, "wall_thickness": { "title": "Wall Thickness", "type": "string", "format": "decimal" } } }, "Screen": { "required": [ "start", "end", "assembly_type" ], "type": "object", "properties": { "start": { "title": "From", "type": "string", "format": "decimal" }, "end": { "title": "To", "type": "string", "format": "decimal" }, "internal_diameter": { "title": "Diameter", "type": "string", "format": "decimal" }, "assembly_type": { "title": "Assembly type", "type": "string" }, "slot_size": { "title": "Slot Size", "type": "string", "format": "decimal" } } }, "LinerPerforation": { "required": [ "start", "end" ], "type": "object", "properties": { "start": { "title": "Perforated From", "type": "string", "format": "decimal" }, "end": { "title": "Perforated To", "type": "string", "format": "decimal" } } }, "DecommissionDescription": { "required": [ "start", "end", "material" ], "type": "object", "properties": { "start": { "title": "Decommissioned From", "type": "string", "format": "decimal" }, "end": { "title": "Decommissioned To", "type": "string", "format": "decimal" }, "material": { "title": "Material", "type": "string" }, "observations": { "title": "Observations", "type": "string", "maxLength": 255 } } }, "LithologyDescription": { "type": "object", "properties": { "lithology_from": { "title": "From", "type": "string", "format": "decimal" }, "lithology_to": { "title": "To", "type": "string", "format": "decimal" }, "lithology_raw_data": { "title": "Raw Data", "type": "string", "maxLength": 250 }, "lithology_colour": { "title": "Colour", "type": "string" }, "lithology_hardness": { "title": "Hardness", "type": "string" }, "lithology_moisture": { "title": "Moisture", "type": "string" }, "water_bearing_estimated_flow": { "title": "Water Bearing Estimated Flow", "type": "string", "format": "decimal" } } }, "WellDetail": { "required": [ "well", "owner_full_name", "person_responsible", "company_of_person_responsible", "casing_set", "screen_set", "linerperforation_set", "decommission_description_set", "lithologydescription_set" ], "type": "object", "properties": { "well_guid": { "title": "Well guid", "type": "string", "format": "uuid", "readOnly": true }, "well": { "title": "Well", "type": "integer" }, "well_tag_number": { "title": "Well Tag Number", "type": "integer", "readOnly": true }, "identification_plate_number": { "title": "Well Identification Plate Number", "type": "integer", "maximum": 2147483647, "minimum": 0 }, "owner_full_name": { "title": "Owner Name", "type": "string", "maxLength": 200 }, "well_class": { "title": "Well Class", "type": "string" }, "well_subclass": { "title": "Well Subclass", "type": "string", "format": "uuid" }, "intended_water_use": { "title": "Intended Water Use", "type": "string" }, "well_status": { "title": "Well Status", "type": "string" }, "licenced_status": { "title": "Licenced Status", "type": "string" }, "street_address": { "title": "Street Address", "type": "string", "maxLength": 100 }, "city": { "title": "Town/City", "type": "string", "maxLength": 50 }, "legal_lot": { "title": "Lot", "type": "string", "maxLength": 10 }, "legal_plan": { "title": "Plan", "type": "string", "maxLength": 20 }, "legal_district_lot": { "title": "District Lot", "type": "string", "maxLength": 20 }, "legal_block": { "title": "Block", "type": "string", "maxLength": 10 }, "legal_section": { "title": "Section", "type": "string", "maxLength": 10 }, "legal_township": { "title": "Township", "type": "string", "maxLength": 20 }, "legal_range": { "title": "Range", "type": "string", "maxLength": 10 }, "land_district": { "title": "Land District", "type": "string" }, "legal_pid": { "title": "Property Identification Description (PID)", "type": "integer", "maximum": 2147483647, "minimum": 0 }, "well_location_description": { "title": "Description of Well Location", "type": "string", "maxLength": 500 }, "construction_start_date": { "title": "Construction Start Date", "type": "string", "format": "date" }, "construction_end_date": { "title": "Construction Date", "type": "string", "format": "date" }, "alteration_end_date": { "title": "Alteration Date", "type": "string", "format": "date" }, "decommission_start_date": { "title": "Decommission Start Date", "type": "string", "format": "date" }, "decommission_end_date": { "title": "Decommission Date", "type": "string", "format": "date" }, "person_responsible": { "$ref": "#/components/schemas/PersonBasic" }, "company_of_person_responsible": { "$ref": "#/components/schemas/OrganizationNameList" }, "drilling_company": { "title": "Drilling Company", "type": "string", "format": "uuid" }, "well_identification_plate_attached": { "title": "Well Identification Plate Is Attached", "type": "string", "maxLength": 500 }, "id_plate_attached_by": { "title": "Well identification plate attached by", "type": "string", "maxLength": 100 }, "water_supply_system_name": { "title": "Water Supply System Name", "type": "string", "maxLength": 80 }, "water_supply_system_well_name": { "title": "Water Supply System Well Name", "type": "string", "maxLength": 80 }, "latitude": { "title": "Latitude", "type": "string", "format": "decimal" }, "longitude": { "title": "Longitude", "type": "string", "format": "decimal" }, "coordinate_acquisition_code": { "title": "Location Accuracy Code", "type": "string" }, "ground_elevation": { "title": "Ground Elevation", "type": "string", "format": "decimal" }, "ground_elevation_method": { "title": "Elevation Determined By", "type": "string" }, "drilling_method": { "title": "Drilling Method", "type": "string" }, "other_drilling_method": { "title": "Specify Other Drilling Method", "type": "string", "maxLength": 50 }, "well_orientation": { "title": "Orientation of Well", "type": "boolean", "enum": [ true, false ] }, "surface_seal_material": { "title": "Surface Seal Material", "type": "string" }, "surface_seal_length": { "title": "Surface Seal Length", "type": "string", "format": "decimal" }, "surface_seal_thickness": { "title": "Surface Seal Thickness", "type": "string", "format": "decimal" }, "surface_seal_method": { "title": "Surface Seal Installation Method", "type": "string" }, "surface_seal_depth": { "title": "Surface Seal Depth", "type": "string", "format": "decimal" }, "backfill_type": { "title": "Backfill Material Above Surface Seal", "type": "string", "maxLength": 250 }, "backfill_depth": { "title": "Backfill Depth", "type": "string", "format": "decimal" }, "liner_material": { "title": "Liner Material", "type": "string" }, "liner_diameter": { "title": "Liner Diameter", "type": "string", "format": "decimal" }, "liner_thickness": { "title": "Liner Thickness", "type": "string", "format": "decimal" }, "liner_from": { "title": "Liner From", "type": "string", "format": "decimal" }, "liner_to": { "title": "Liner To", "type": "string", "format": "decimal" }, "screen_intake_method": { "title": "Intake Method", "type": "string" }, "screen_type": { "title": "Type", "type": "string" }, "screen_material": { "title": "Material", "type": "string" }, "other_screen_material": { "title": "Specify Other Screen Material", "type": "string", "maxLength": 50 }, "screen_opening": { "title": "Opening", "type": "string" }, "screen_bottom": { "title": "Bottom", "type": "string" }, "other_screen_bottom": { "title": "Specify Other Screen Bottom", "type": "string", "maxLength": 50 }, "screen_information": { "title": "Screen Information", "type": "string", "maxLength": 300 }, "filter_pack_from": { "title": "Filter Pack From", "type": "string", "format": "decimal" }, "filter_pack_to": { "title": "Filter Pack To", "type": "string", "format": "decimal" }, "filter_pack_thickness": { "title": "Filter Pack Thickness", "type": "string", "format": "decimal" }, "filter_pack_material": { "title": "Filter Pack Material", "type": "string" }, "filter_pack_material_size": { "title": "Filter Pack Material Size", "type": "string" }, "development_method": { "title": "Developed By", "type": "string" }, "development_hours": { "title": "Development Total Duration", "type": "string", "format": "decimal" }, "development_notes": { "title": "Development Notes", "type": "string", "maxLength": 255 }, "water_quality_characteristics": { "type": "array", "items": { "title": "Obvious Water Quality Characteristics", "type": "string" }, "uniqueItems": true }, "water_quality_colour": { "title": "Water Quality Colour", "type": "string", "maxLength": 60 }, "water_quality_odour": { "title": "Water Quality Odour", "type": "string", "maxLength": 60 }, "total_depth_drilled": { "title": "Total Depth Drilled", "type": "string", "format": "decimal" }, "finished_well_depth": { "title": "Finished Well Depth", "type": "string", "format": "decimal" }, "final_casing_stick_up": { "title": "Final Casing Stick Up", "type": "string", "format": "decimal" }, "bedrock_depth": { "title": "Depth to Bedrock", "type": "string", "format": "decimal" }, "static_water_level": { "title": "Static Water Level (BTOC)", "type": "string", "format": "decimal" }, "well_yield": { "title": "Estimated Well Yield", "type": "string", "format": "decimal" }, "artesian_flow": { "title": "Artesian Flow", "type": "string", "format": "decimal" }, "artesian_pressure": { "title": "Artesian Pressure", "type": "string", "format": "decimal" }, "well_cap_type": { "title": "Well Cap", "type": "string", "maxLength": 40 }, "well_disinfected": { "title": "Well Disinfected", "type": "boolean", "enum": [ false, true ] }, "comments": { "title": "Comments", "type": "string", "maxLength": 3000 }, "alternative_specs_submitted": { "title": "Alternative specs submitted (if required)", "type": "boolean", "enum": [ false, true ] }, "well_yield_unit": { "title": "Well yield unit", "type": "string" }, "diameter": { "title": "Diameter", "type": "string", "maxLength": 9 }, "observation_well_number": { "title": "Observation Well Number", "type": "string", "maxLength": 30 }, "observation_well_status": { "title": "Observation Well Status", "type": "string" }, "ems": { "title": "Environmental Monitoring System (EMS) ID", "type": "string", "maxLength": 10 }, "aquifer": { "title": "Aquifer ID Number", "type": "integer" }, "utm_zone_code": { "title": "Zone", "type": "string", "maxLength": 10 }, "utm_northing": { "title": "UTM Northing", "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "utm_easting": { "title": "UTM Easting", "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "bcgs_id": { "title": "BCGS Mapsheet Number", "type": "integer" }, "decommission_reason": { "title": "Reason for Decommission", "type": "string", "maxLength": 250 }, "decommission_method": { "title": "Method of Decommission", "type": "string" }, "sealant_material": { "title": "Sealant Material", "type": "string", "maxLength": 100 }, "backfill_material": { "title": "Backfill Material", "type": "string", "maxLength": 100 }, "decommission_details": { "title": "Decommission Details", "type": "string", "maxLength": 250 }, "aquifer_vulnerability_index": { "title": "AVI", "type": "string", "format": "decimal" }, "storativity": { "title": "Storativity", "type": "string", "format": "decimal" }, "transmissivity": { "title": "Transmissivity", "type": "string", "format": "decimal" }, "hydraulic_conductivity": { "title": "Hydraulic Conductivity", "type": "string", "maxLength": 100 }, "specific_storage": { "title": "Specific Storage", "type": "string", "maxLength": 100 }, "specific_yield": { "title": "Specific Yield", "type": "string", "format": "decimal" }, "testing_method": { "title": "Testing Method", "type": "string", "maxLength": 100 }, "testing_duration": { "title": "Testing duration", "type": "integer", "maximum": 2147483647, "minimum": 0 }, "analytic_solution_type": { "title": "Analytic Solution Type", "type": "string", "format": "decimal" }, "boundary_effect": { "title": "Boundary Effect", "type": "string", "format": "decimal" }, "yield_estimation_method": { "title": "Estimation Method", "type": "string" }, "yield_estimation_rate": { "title": "Estimation Rate", "type": "string", "format": "decimal" }, "yield_estimation_duration": { "title": "Estimation Duration", "type": "string", "format": "decimal" }, "static_level_before_test": { "title": "SWL Before Test", "type": "string", "format": "decimal" }, "drawdown": { "title": "Drawdown", "type": "string", "format": "decimal" }, "hydro_fracturing_performed": { "title": "Hydro-fracturing Performed?", "type": "boolean", "enum": [ false, true ] }, "hydro_fracturing_yield_increase": { "title": "Well Yield Increase Due to Hydro-fracturing", "type": "string", "format": "decimal" }, "recommended_pump_depth": { "title": "Recommended pump depth", "type": "string", "format": "decimal" }, "recommended_pump_rate": { "title": "Recommended pump rate", "type": "string", "format": "decimal" }, "casing_set": { "type": "array", "items": { "$ref": "#/components/schemas/Casing" } }, "screen_set": { "type": "array", "items": { "$ref": "#/components/schemas/Screen" } }, "linerperforation_set": { "type": "array", "items": { "$ref": "#/components/schemas/LinerPerforation" } }, "decommission_description_set": { "type": "array", "items": { "$ref": "#/components/schemas/DecommissionDescription" } }, "lithologydescription_set": { "type": "array", "items": { "$ref": "#/components/schemas/LithologyDescription" } } } } } } }