diff --git a/gwells/gwells.json b/gwells/gwells.json index 1de8236..3dc5ed5 100644 --- a/gwells/gwells.json +++ b/gwells/gwells.json @@ -1,3301 +1 @@ -{ - "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" - } - } - } - } - } - } -} - +{"openapi":"3.0.1","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"},"servers":[{"url":"https://apps.nrs.gov.bc.ca/gwells/api"}],"security":[{"Bearer":[]}],"paths":{"/v1/aquifers":{"get":{"tags":["v1"],"description":"return a list of aquifers","operationId":"v1_aquifers_list","parameters":[{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"search","in":"query","description":"A search term.","schema":{"type":"string"}},{"name":"page","in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"name":"page_size","in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"uri","nullable":true},"previous":{"type":"string","format":"uri","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Aquifer"}}}}}}}}}},"/v1/aquifers/{aquifer_id}":{"get":{"tags":["v1"],"description":"return details of aquifers","operationId":"v1_aquifers_read","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AquiferDetailSerializerV1"}}}}}},"parameters":[{"name":"aquifer_id","in":"path","description":"A unique integer value identifying this aquifer.","required":true,"schema":{"type":"integer"}}]},"/v1/aquifers/{aquifer_id}/files":{"get":{"tags":["v1"],"description":"list files found for the aquifer identified in the uri","operationId":"v1_aquifers_files_list","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"private":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}}}},"public":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}}}}}}}}}}},"parameters":[{"name":"aquifer_id","in":"path","required":true,"schema":{"type":"string"}}]},"/v1/drillers":{"get":{"tags":["v1"],"description":"Returns a list of all person records","operationId":"v1_drillers_list","parameters":[{"name":"search","in":"query","description":"A search term.","schema":{"type":"string"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonList"}}}}}}}},"/v1/wells":{"get":{"tags":["v1"],"description":"returns a list of wells","operationId":"v1_wells_list","parameters":[{"name":"search","in":"query","description":"A search term.","schema":{"type":"string"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"uri","nullable":true},"previous":{"type":"string","format":"uri","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/WellListSerializerV1"}}}}}}}}}},"/v1/wells/export":{"get":{"tags":["v1"],"description":"Returns CSV or Excel data for wells.","operationId":"v1_wells_export_list","parameters":[{"name":"search","in":"query","description":"A search term.","schema":{"type":"string"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WellExportSerializerV1"}}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WellExportSerializerV1"}}}}}}}},"/v1/wells/{tag}/files":{"get":{"tags":["v1"],"description":"list files found for the well identified in the uri","operationId":"v1_wells_files_list","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"private":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}}}},"public":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}}}}}}}}}}},"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}}]},"/v1/wells/{well_tag_number}":{"get":{"tags":["v1"],"description":"Return well detail.\nThis view is open to all, and has no permissions.","operationId":"v1_wells_read","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/well_detail_v1"}}}}}},"parameters":[{"name":"well_tag_number","in":"path","required":true,"schema":{"type":"string"}}]},"/v2/wells/{well_tag_number}":{"get":{"tags":["v2"],"description":"Return well detail.\nThis view is open to all, and has no permissions.","operationId":"v2_wells_read","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/well_detail_v2"}}}}}},"parameters":[{"name":"well_tag_number","in":"path","required":true,"schema":{"type":"string"}}]}},"components":{"schemas":{"Aquifer":{"type":"object","properties":{"aquifer_id":{"title":"Aquifer ID Number","type":"integer","readOnly":true},"mapping_year":{"title":"Date of Mapping","maximum":2021,"minimum":1.99E+3,"type":"integer","description":"Use the following format: ","nullable":true}}},"AquiferResource":{"required":["name","section_code","url"],"type":"object","properties":{"id":{"title":"Aquifer Resource Identifier","type":"integer","readOnly":true},"name":{"title":"Aquifer Resource Name","maxLength":255,"minLength":1,"type":"string"},"url":{"title":"PDF Document URL","maxLength":255,"minLength":1,"type":"string","description":"A resolvable link to the PDF document associated with this aquifer resource.","format":"uri"},"section_code":{"title":"Section code","type":"string"}}},"AquiferDetailSerializerV1":{"type":"object","properties":{"aquifer_id":{"title":"Aquifer ID Number","type":"integer","readOnly":true},"aquifer_name":{"title":"Aquifer name","maxLength":100,"type":"string","nullable":true},"location_description":{"title":"Description of Location","maxLength":100,"type":"string","nullable":true},"quality_concern":{"title":"Quality Concern Reference","type":"string","nullable":true},"material":{"title":"Material Reference","type":"string","nullable":true},"subtype":{"title":"Subtype Reference","type":"string","nullable":true},"vulnerability":{"title":"Aquifer Vulnerabiliy","type":"string","nullable":true},"known_water_use":{"title":"Known Water Use Reference","type":"string","nullable":true},"litho_stratographic_unit":{"title":"Lithographic Stratographic Unit","maxLength":100,"type":"string","nullable":true},"productivity":{"title":"Productivity Reference","type":"string","nullable":true},"demand":{"title":"Demand Reference","type":"string","nullable":true},"mapping_year":{"title":"Date of Mapping","maximum":2021,"minimum":1.99E+3,"type":"integer","description":"Use the following format: ","nullable":true},"resources":{"type":"array","items":{"$ref":"#/components/schemas/AquiferResource"}},"area":{"title":"Size (square km)","type":"string","format":"decimal","nullable":true},"notes":{"title":"Notes on Aquifer, for internal use only.","maxLength":2000,"type":"string","nullable":true},"licence_details":{"title":"Licence details","type":"object","properties":{},"readOnly":true}}},"Qualification":{"required":["well_class"],"type":"object","properties":{"well_class":{"title":"Well class","type":"string"},"description":{"title":"Description","type":"string","readOnly":true}}},"Subactivity":{"required":["description"],"type":"object","properties":{"registries_subactivity_code":{"title":"Registries subactivity code","minLength":1,"type":"string","readOnly":true},"description":{"title":"Description","maxLength":100,"minLength":1,"type":"string"},"qualification_set":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Qualification"}}}},"ApplicationStatusCode":{"required":["description"],"type":"object","properties":{"code":{"title":"Code","minLength":1,"type":"string","readOnly":true},"description":{"title":"Description","maxLength":100,"minLength":1,"type":"string"}}},"ApplicationList":{"required":["subactivity"],"type":"object","properties":{"qualifications":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Qualification"}},"subactivity":{"$ref":"#/components/schemas/Subactivity"},"cert_authority":{"title":"Cert authority","type":"string","readOnly":true},"removal_date":{"title":"Removal date","type":"string","format":"date","nullable":true},"certificate":{"title":"Certificate","type":"string","readOnly":true},"display_status":{"title":"Display status","type":"string","readOnly":true},"current_status":{"$ref":"#/components/schemas/ApplicationStatusCode"}}},"OrganizationList":{"required":["name","province_state"],"type":"object","properties":{"org_guid":{"title":"Organization UUID","type":"string","format":"uuid","readOnly":true},"name":{"title":"Name","maxLength":200,"minLength":1,"type":"string"},"org_verbose_name":{"title":"Org verbose name","type":"string","readOnly":true},"street_address":{"title":"Street Address","maxLength":100,"type":"string","nullable":true},"city":{"title":"Town/City","maxLength":50,"type":"string","nullable":true},"province_state":{"title":"Province/State","type":"string"},"postal_code":{"title":"Postal Code","maxLength":10,"type":"string","nullable":true},"main_tel":{"title":"Telephone number","maxLength":15,"type":"string","nullable":true},"fax_tel":{"title":"Fax number","maxLength":15,"type":"string","nullable":true},"email":{"title":"Email adddress","maxLength":254,"type":"string","format":"email","nullable":true},"website_url":{"title":"Website","maxLength":200,"type":"string","format":"uri","nullable":true}}},"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","maxLength":15,"type":"string","nullable":true},"applications":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ApplicationList"}},"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","maxLength":100,"minLength":1,"type":"string"},"surname":{"title":"Surname","maxLength":100,"minLength":1,"type":"string"},"registrations":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/RegistrationsList"}},"contact_tel":{"title":"Contact telephone number","maxLength":15,"type":"string","nullable":true},"contact_cell":{"title":"Contact cell number","maxLength":15,"type":"string","nullable":true},"contact_email":{"title":"Email address","maxLength":254,"type":"string","format":"email","nullable":true}}},"WellListSerializerV1":{"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","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"owner_full_name":{"title":"Owner Name","maxLength":200,"minLength":1,"type":"string"},"well_class":{"title":"Well Class","type":"string"},"well_subclass":{"title":"Well Subclass","type":"string","format":"uuid","nullable":true},"well_status":{"title":"Well Status","type":"string","nullable":true},"licenced_status":{"title":"Licenced status","type":"string","readOnly":true},"street_address":{"title":"Street Address","maxLength":100,"type":"string","nullable":true},"city":{"title":"Town/City","maxLength":50,"type":"string","nullable":true},"legal_lot":{"title":"Lot","maxLength":10,"type":"string","nullable":true},"legal_plan":{"title":"Plan","maxLength":20,"type":"string","nullable":true},"legal_district_lot":{"title":"District Lot","maxLength":20,"type":"string","nullable":true},"legal_block":{"title":"Block","maxLength":10,"type":"string","nullable":true},"legal_section":{"title":"Section","maxLength":10,"type":"string","nullable":true},"legal_township":{"title":"Township","maxLength":20,"type":"string","nullable":true},"legal_range":{"title":"Range","maxLength":10,"type":"string","nullable":true},"land_district":{"title":"Land District","type":"string","nullable":true},"legal_pid":{"title":"Legal pid","type":"string","readOnly":true},"well_location_description":{"title":"Description of Well Location","maxLength":500,"type":"string","nullable":true},"construction_start_date":{"title":"Construction Start Date","type":"string","format":"date","nullable":true},"construction_end_date":{"title":"Construction Date","type":"string","format":"date","nullable":true},"alteration_start_date":{"title":"Alteration Start Date","type":"string","format":"date","nullable":true},"alteration_end_date":{"title":"Alteration Date","type":"string","format":"date","nullable":true},"decommission_start_date":{"title":"Decommission Start Date","type":"string","format":"date","nullable":true},"decommission_end_date":{"title":"Decommission Date","type":"string","format":"date","nullable":true},"drilling_company":{"title":"Drilling company","type":"string","readOnly":true},"company_of_person_responsible":{"title":"Company of person responsible","type":"string","readOnly":true},"well_identification_plate_attached":{"title":"Well Identification Plate Is Attached","maxLength":500,"type":"string","nullable":true},"id_plate_attached_by":{"title":"Well identification plate attached by","maxLength":100,"type":"string","nullable":true},"water_supply_system_name":{"title":"Water Supply System Name","maxLength":80,"type":"string","nullable":true},"water_supply_system_well_name":{"title":"Water Supply System Well Name","maxLength":80,"type":"string","nullable":true},"latitude":{"title":"Latitude","type":"string","readOnly":true},"longitude":{"title":"Longitude","type":"string","readOnly":true},"coordinate_acquisition_code":{"title":"Location Accuracy Code","type":"string","nullable":true},"ground_elevation":{"title":"Ground Elevation","type":"string","format":"decimal","nullable":true},"ground_elevation_method":{"title":"Elevation Determined By","type":"string","nullable":true},"drilling_methods":{"uniqueItems":true,"type":"array","items":{"title":"Drilling Methods","type":"string"}},"well_orientation_status":{"title":"Well Orientation Code","type":"string","nullable":true},"surface_seal_material":{"title":"Surface Seal Material","type":"string","nullable":true},"surface_seal_thickness":{"title":"Surface Seal Thickness","type":"string","format":"decimal","nullable":true},"surface_seal_method":{"title":"Surface Seal Installation Method","type":"string","nullable":true},"surface_seal_depth":{"title":"Surface Seal Depth","type":"string","format":"decimal","nullable":true},"backfill_type":{"title":"Backfill Material Above Surface Seal","maxLength":250,"type":"string","nullable":true},"backfill_depth":{"title":"Backfill Depth","type":"string","format":"decimal","nullable":true},"liner_material":{"title":"Liner Material","type":"string","nullable":true},"liner_diameter":{"title":"Liner Diameter","type":"string","format":"decimal","nullable":true},"liner_thickness":{"title":"Liner Thickness","type":"string","format":"decimal","nullable":true},"liner_from":{"title":"Liner From","type":"string","format":"decimal","nullable":true},"liner_to":{"title":"Liner To","type":"string","format":"decimal","nullable":true},"screen_intake_method":{"title":"Intake Method","type":"string","nullable":true},"screen_type":{"title":"Type","type":"string","nullable":true},"screen_material":{"title":"Material","type":"string","nullable":true},"other_screen_material":{"title":"Specify Other Screen Material","maxLength":50,"type":"string","nullable":true},"screen_opening":{"title":"Opening","type":"string","nullable":true},"screen_bottom":{"title":"Bottom","type":"string","nullable":true},"other_screen_bottom":{"title":"Specify Other Screen Bottom","maxLength":50,"type":"string","nullable":true},"screen_information":{"title":"Screen Information","maxLength":300,"type":"string","nullable":true},"filter_pack_from":{"title":"Filter Pack From","type":"string","format":"decimal","nullable":true},"filter_pack_to":{"title":"Filter Pack To","type":"string","format":"decimal","nullable":true},"filter_pack_thickness":{"title":"Filter Pack Thickness","type":"string","format":"decimal","nullable":true},"filter_pack_material":{"title":"Filter Pack Material","type":"string","nullable":true},"filter_pack_material_size":{"title":"Filter Pack Material Size","type":"string","nullable":true},"development_methods":{"uniqueItems":true,"type":"array","items":{"title":"Development Methods","type":"string"}},"development_hours":{"title":"Development Total Duration","type":"string","format":"decimal","nullable":true},"development_notes":{"title":"Development Notes","maxLength":255,"type":"string","nullable":true},"yield_estimation_method":{"title":"Estimation Method","type":"string","nullable":true},"yield_estimation_rate":{"title":"Estimation Rate","type":"string","format":"decimal","nullable":true},"yield_estimation_duration":{"title":"Estimation Duration","type":"string","format":"decimal","nullable":true},"well_yield_unit":{"title":"Well yield unit","type":"string","nullable":true},"static_level_before_test":{"title":"SWL Before Test","type":"string","format":"decimal","nullable":true},"drawdown":{"title":"Drawdown","type":"string","format":"decimal","nullable":true},"hydro_fracturing_performed":{"title":"Hydro-fracturing Performed?","type":"boolean"},"hydro_fracturing_yield_increase":{"title":"Well Yield Increase Due to Hydro-fracturing","type":"string","format":"decimal","nullable":true},"recommended_pump_depth":{"title":"Recommended pump depth","type":"string","format":"decimal","nullable":true},"recommended_pump_rate":{"title":"Recommended pump rate","type":"string","format":"decimal","nullable":true},"water_quality_characteristics":{"uniqueItems":true,"type":"array","items":{"title":"Obvious Water Quality Characteristics","type":"string"}},"water_quality_colour":{"title":"Water Quality Colour","maxLength":60,"type":"string","nullable":true},"water_quality_odour":{"title":"Water Quality Odour","maxLength":60,"type":"string","nullable":true},"total_depth_drilled":{"title":"Total Depth Drilled","type":"string","format":"decimal","nullable":true},"finished_well_depth":{"title":"Finished Well Depth","type":"string","format":"decimal","nullable":true},"well_yield":{"title":"Estimated Well Yield","type":"string","format":"decimal","nullable":true},"diameter":{"title":"Diameter","maxLength":9,"type":"string"},"observation_well_number":{"title":"Observation Well Number","maxLength":30,"type":"string","nullable":true},"observation_well_status":{"title":"Observation Well Status","type":"string","nullable":true},"ems":{"title":"Environmental Monitoring System (EMS) ID","maxLength":10,"type":"string","nullable":true},"aquifer":{"title":"Aquifer ID Number","type":"integer","nullable":true},"utm_zone_code":{"title":"Zone","maxLength":10,"type":"string","nullable":true},"utm_northing":{"title":"UTM Northing","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"utm_easting":{"title":"UTM Easting","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"bcgs_id":{"title":"BCGS Mapsheet Number","type":"integer","nullable":true},"decommission_reason":{"title":"Reason for Decommission","maxLength":250,"type":"string","nullable":true},"decommission_method":{"title":"Method of Decommission","type":"string","nullable":true},"decommission_sealant_material":{"title":"Decommission Sealant Material","maxLength":100,"type":"string","nullable":true},"decommission_backfill_material":{"title":"Decommission Backfill Material","maxLength":100,"type":"string","nullable":true},"decommission_details":{"title":"Decommission Details","maxLength":250,"type":"string","nullable":true},"aquifer_vulnerability_index":{"title":"AVI","type":"string","format":"decimal","nullable":true},"aquifer_lithology":{"title":"Aquifer Lithology","type":"string","nullable":true},"storativity":{"title":"Storativity","type":"string","format":"decimal","nullable":true},"transmissivity":{"title":"Transmissivity","type":"string","format":"decimal","nullable":true},"hydraulic_conductivity":{"title":"Hydraulic Conductivity","maxLength":100,"type":"string","nullable":true},"specific_storage":{"title":"Specific Storage","maxLength":100,"type":"string","nullable":true},"specific_yield":{"title":"Specific Yield","type":"string","format":"decimal","nullable":true},"testing_method":{"title":"Testing Method","maxLength":100,"type":"string","nullable":true},"testing_duration":{"title":"Testing duration","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"analytic_solution_type":{"title":"Analytic Solution Type","type":"string","format":"decimal","nullable":true},"boundary_effect":{"title":"Boundary Effect","type":"string","nullable":true},"final_casing_stick_up":{"title":"Final Casing Stick Up","type":"string","format":"decimal","nullable":true},"bedrock_depth":{"title":"Depth to Bedrock","type":"string","format":"decimal","nullable":true},"artesian_flow":{"title":"Artesian Flow","type":"string","format":"decimal","nullable":true},"artesian_pressure":{"title":"Artesian Pressure","type":"string","format":"decimal","nullable":true},"artesian_pressure_head":{"title":"Artesian Pressure head","type":"string","format":"decimal","nullable":true},"artesian_conditions":{"title":"Artesian Conditions","type":"boolean"},"well_cap_type":{"title":"Well Cap","maxLength":40,"type":"string","nullable":true},"well_disinfected_status":{"title":"Well Disinfected Code","type":"string","nullable":true},"static_water_level":{"title":"Static Water Level (BTOC)","type":"string","format":"decimal","nullable":true}}},"WellExportSerializerV1":{"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","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"owner_full_name":{"title":"Owner Name","maxLength":200,"minLength":1,"type":"string"},"well_class":{"title":"Well class","type":"string","readOnly":true},"well_subclass":{"title":"Well subclass","type":"string","readOnly":true},"well_status":{"title":"Well status","type":"string","readOnly":true},"licenced_status":{"title":"Licenced status","type":"string","readOnly":true},"street_address":{"title":"Street Address","maxLength":100,"type":"string","nullable":true},"city":{"title":"Town/City","maxLength":50,"type":"string","nullable":true},"legal_lot":{"title":"Lot","maxLength":10,"type":"string","nullable":true},"legal_plan":{"title":"Plan","maxLength":20,"type":"string","nullable":true},"legal_district_lot":{"title":"District Lot","maxLength":20,"type":"string","nullable":true},"legal_block":{"title":"Block","maxLength":10,"type":"string","nullable":true},"legal_section":{"title":"Section","maxLength":10,"type":"string","nullable":true},"legal_township":{"title":"Township","maxLength":20,"type":"string","nullable":true},"legal_range":{"title":"Range","maxLength":10,"type":"string","nullable":true},"land_district":{"title":"Land district","type":"string","readOnly":true},"legal_pid":{"title":"Legal pid","type":"string","readOnly":true},"well_location_description":{"title":"Description of Well Location","maxLength":500,"type":"string","nullable":true},"construction_start_date":{"title":"Construction Start Date","type":"string","format":"date","nullable":true},"construction_end_date":{"title":"Construction Date","type":"string","format":"date","nullable":true},"alteration_start_date":{"title":"Alteration Start Date","type":"string","format":"date","nullable":true},"alteration_end_date":{"title":"Alteration Date","type":"string","format":"date","nullable":true},"decommission_start_date":{"title":"Decommission Start Date","type":"string","format":"date","nullable":true},"decommission_end_date":{"title":"Decommission Date","type":"string","format":"date","nullable":true},"drilling_company":{"title":"Drilling company","minLength":1,"type":"string","readOnly":true},"company_of_person_responsible":{"title":"Company of person responsible","type":"string","readOnly":true},"well_identification_plate_attached":{"title":"Well Identification Plate Is Attached","maxLength":500,"type":"string","nullable":true},"id_plate_attached_by":{"title":"Well identification plate attached by","maxLength":100,"type":"string","nullable":true},"water_supply_system_name":{"title":"Water Supply System Name","maxLength":80,"type":"string","nullable":true},"water_supply_system_well_name":{"title":"Water Supply System Well Name","maxLength":80,"type":"string","nullable":true},"latitude":{"title":"Latitude","type":"string","readOnly":true},"longitude":{"title":"Longitude","type":"string","readOnly":true},"coordinate_acquisition_code":{"title":"Coordinate acquisition code","type":"string","readOnly":true},"ground_elevation":{"title":"Ground Elevation","type":"string","format":"decimal","nullable":true},"ground_elevation_method":{"title":"Ground elevation method","type":"string","readOnly":true},"drilling_methods":{"uniqueItems":true,"type":"array","readOnly":true,"items":{"type":"string"}},"well_orientation_status":{"title":"Well Orientation Code","type":"string","nullable":true},"surface_seal_material":{"title":"Surface seal material","type":"string","readOnly":true},"surface_seal_thickness":{"title":"Surface Seal Thickness","type":"string","format":"decimal","nullable":true},"surface_seal_method":{"title":"Surface seal method","type":"string","readOnly":true},"surface_seal_depth":{"title":"Surface Seal Depth","type":"string","format":"decimal","nullable":true},"backfill_type":{"title":"Backfill Material Above Surface Seal","maxLength":250,"type":"string","nullable":true},"backfill_depth":{"title":"Backfill Depth","type":"string","format":"decimal","nullable":true},"liner_material":{"title":"Liner material","type":"string","readOnly":true},"liner_diameter":{"title":"Liner Diameter","type":"string","format":"decimal","nullable":true},"liner_thickness":{"title":"Liner Thickness","type":"string","format":"decimal","nullable":true},"liner_from":{"title":"Liner From","type":"string","format":"decimal","nullable":true},"liner_to":{"title":"Liner To","type":"string","format":"decimal","nullable":true},"screen_intake_method":{"title":"Screen intake method","type":"string","readOnly":true},"screen_type":{"title":"Screen type","type":"string","readOnly":true},"screen_material":{"title":"Screen material","type":"string","readOnly":true},"other_screen_material":{"title":"Specify Other Screen Material","maxLength":50,"type":"string","nullable":true},"screen_opening":{"title":"Screen opening","type":"string","readOnly":true},"screen_bottom":{"title":"Screen bottom","type":"string","readOnly":true},"other_screen_bottom":{"title":"Specify Other Screen Bottom","maxLength":50,"type":"string","nullable":true},"screen_information":{"title":"Screen Information","maxLength":300,"type":"string","nullable":true},"filter_pack_from":{"title":"Filter Pack From","type":"string","format":"decimal","nullable":true},"filter_pack_to":{"title":"Filter Pack To","type":"string","format":"decimal","nullable":true},"filter_pack_thickness":{"title":"Filter Pack Thickness","type":"string","format":"decimal","nullable":true},"filter_pack_material":{"title":"Filter Pack Material","type":"string","nullable":true},"filter_pack_material_size":{"title":"Filter Pack Material Size","type":"string","nullable":true},"development_methods":{"uniqueItems":true,"type":"array","readOnly":true,"items":{"type":"string"}},"development_hours":{"title":"Development Total Duration","type":"string","format":"decimal","nullable":true},"development_notes":{"title":"Development Notes","maxLength":255,"type":"string","nullable":true},"yield_estimation_method":{"title":"Yield estimation method","type":"string","readOnly":true},"yield_estimation_rate":{"title":"Estimation Rate","type":"string","format":"decimal","nullable":true},"yield_estimation_duration":{"title":"Estimation Duration","type":"string","format":"decimal","nullable":true},"well_yield_unit":{"title":"Well yield unit","type":"string","readOnly":true},"static_level_before_test":{"title":"SWL Before Test","type":"string","format":"decimal","nullable":true},"drawdown":{"title":"Drawdown","type":"string","format":"decimal","nullable":true},"hydro_fracturing_performed":{"title":"Hydro fracturing performed","minLength":1,"type":"string","readOnly":true},"hydro_fracturing_yield_increase":{"title":"Well Yield Increase Due to Hydro-fracturing","type":"string","format":"decimal","nullable":true},"recommended_pump_depth":{"title":"Recommended pump depth","type":"string","format":"decimal","nullable":true},"recommended_pump_rate":{"title":"Recommended pump rate","type":"string","format":"decimal","nullable":true},"water_quality_characteristics":{"uniqueItems":true,"type":"array","readOnly":true,"items":{"type":"string"}},"water_quality_colour":{"title":"Water Quality Colour","maxLength":60,"type":"string","nullable":true},"water_quality_odour":{"title":"Water Quality Odour","maxLength":60,"type":"string","nullable":true},"total_depth_drilled":{"title":"Total Depth Drilled","type":"string","format":"decimal","nullable":true},"finished_well_depth":{"title":"Finished Well Depth","type":"string","format":"decimal","nullable":true},"well_yield":{"title":"Estimated Well Yield","type":"string","format":"decimal","nullable":true},"diameter":{"title":"Diameter","maxLength":9,"type":"string"},"observation_well_number":{"title":"Observation Well Number","maxLength":30,"type":"string","nullable":true},"observation_well_status":{"title":"Observation well status","type":"string","readOnly":true},"ems":{"title":"Environmental Monitoring System (EMS) ID","maxLength":10,"type":"string","nullable":true},"aquifer":{"title":"Aquifer","type":"integer","readOnly":true},"utm_zone_code":{"title":"Zone","maxLength":10,"type":"string","nullable":true},"utm_northing":{"title":"UTM Northing","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"utm_easting":{"title":"UTM Easting","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"bcgs_id":{"title":"Bcgs id","type":"string","readOnly":true},"decommission_reason":{"title":"Reason for Decommission","maxLength":250,"type":"string","nullable":true},"decommission_method":{"title":"Decommission method","type":"string","readOnly":true},"decommission_sealant_material":{"title":"Decommission Sealant Material","maxLength":100,"type":"string","nullable":true},"decommission_backfill_material":{"title":"Decommission Backfill Material","maxLength":100,"type":"string","nullable":true},"decommission_details":{"title":"Decommission Details","maxLength":250,"type":"string","nullable":true},"aquifer_vulnerability_index":{"title":"AVI","type":"string","format":"decimal","nullable":true},"aquifer_lithology":{"title":"Aquifer lithology","type":"string","readOnly":true},"storativity":{"title":"Storativity","type":"string","format":"decimal","nullable":true},"transmissivity":{"title":"Transmissivity","type":"string","format":"decimal","nullable":true},"hydraulic_conductivity":{"title":"Hydraulic Conductivity","maxLength":100,"type":"string","nullable":true},"specific_storage":{"title":"Specific Storage","maxLength":100,"type":"string","nullable":true},"specific_yield":{"title":"Specific Yield","type":"string","format":"decimal","nullable":true},"testing_method":{"title":"Testing Method","maxLength":100,"type":"string","nullable":true},"testing_duration":{"title":"Testing duration","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"analytic_solution_type":{"title":"Analytic Solution Type","type":"string","format":"decimal","nullable":true},"boundary_effect":{"title":"Boundary Effect","type":"string","nullable":true},"final_casing_stick_up":{"title":"Final Casing Stick Up","type":"string","format":"decimal","nullable":true},"bedrock_depth":{"title":"Depth to Bedrock","type":"string","format":"decimal","nullable":true},"artesian_flow":{"title":"Artesian Flow","type":"string","format":"decimal","nullable":true},"artesian_pressure":{"title":"Artesian Pressure","type":"string","format":"decimal","nullable":true},"artesian_pressure_head":{"title":"Artesian Pressure head","type":"string","format":"decimal","nullable":true},"artesian_conditions":{"title":"Artesian Conditions","type":"boolean"},"well_cap_type":{"title":"Well Cap","maxLength":40,"type":"string","nullable":true},"well_disinfected_status":{"title":"Well Disinfected Code","type":"string","nullable":true},"static_water_level":{"title":"Static Water Level (BTOC)","type":"string","format":"decimal","nullable":true}}},"RegistrationsNumber":{"required":["registries_activity"],"type":"object","properties":{"registration_no":{"title":"Registration no","maxLength":15,"type":"string","nullable":true},"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","readOnly":true,"items":{"$ref":"#/components/schemas/RegistrationsNumber"}}}},"DrillingMethodSummary":{"required":["description"],"type":"object","properties":{"description":{"title":"Description","maxLength":100,"minLength":1,"type":"string"}}},"CasingSummary":{"type":"object","properties":{"start":{"title":"From","type":"string","format":"decimal","nullable":true},"end":{"title":"To","type":"string","format":"decimal","nullable":true},"diameter":{"title":"Diameter","type":"string","format":"decimal","nullable":true},"casing_code":{"title":"Casing code","type":"string","readOnly":true},"casing_material":{"title":"Casing material","type":"string","readOnly":true},"drive_shoe_status":{"title":"Drive Shoe Code","type":"string","nullable":true},"wall_thickness":{"title":"Wall Thickness","type":"string","format":"decimal","nullable":true}}},"Screen":{"required":["assembly_type","end","start"],"type":"object","properties":{"start":{"title":"From","type":"string","format":"decimal","nullable":true},"end":{"title":"To","type":"string","format":"decimal","nullable":true},"diameter":{"title":"Diameter","type":"string","format":"decimal","nullable":true},"assembly_type":{"title":"Assembly type","type":"string","nullable":true},"slot_size":{"title":"Slot Size","type":"string","format":"decimal","nullable":true}}},"LinerPerforation":{"required":["end","start"],"type":"object","properties":{"start":{"title":"Perforated From","type":"string","format":"decimal"},"end":{"title":"Perforated To","type":"string","format":"decimal"}}},"DecommissionDescription":{"required":["end","material","start"],"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","maxLength":255,"type":"string","nullable":true}}},"LithologyDescriptionSummary":{"type":"object","properties":{"start":{"title":"From","type":"string","format":"decimal","nullable":true},"end":{"title":"To","type":"string","format":"decimal","nullable":true},"lithology_raw_data":{"title":"Raw Data","maxLength":250,"type":"string","nullable":true},"lithology_colour":{"title":"Lithology colour","type":"string","readOnly":true},"lithology_hardness":{"title":"Lithology hardness","type":"string","readOnly":true},"lithology_moisture":{"title":"Lithology moisture","type":"string","readOnly":true},"lithology_description":{"title":"Lithology description","type":"string","readOnly":true},"lithology_observation":{"title":"Observations","maxLength":250,"type":"string","nullable":true},"water_bearing_estimated_flow":{"title":"Water Bearing Estimated Flow","type":"string","format":"decimal","nullable":true}}},"well_detail_v1":{"required":["casing_set","decommission_description_set","drilling_methods","linerperforation_set","lithologydescription_set","owner_full_name","person_responsible","screen_set","well"],"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","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"owner_full_name":{"title":"Owner Name","maxLength":200,"minLength":1,"type":"string"},"well_class":{"title":"Well class","type":"string","readOnly":true},"well_subclass":{"title":"Well subclass","type":"string","readOnly":true},"intended_water_use":{"title":"Intended water use","type":"string","readOnly":true},"well_status":{"title":"Well status","type":"string","readOnly":true},"well_publication_status":{"title":"Well publication status","type":"string","readOnly":true},"licenced_status":{"title":"Licenced status","type":"string","readOnly":true},"street_address":{"title":"Street Address","maxLength":100,"type":"string","nullable":true},"city":{"title":"Town/City","maxLength":50,"type":"string","nullable":true},"legal_lot":{"title":"Lot","maxLength":10,"type":"string","nullable":true},"legal_plan":{"title":"Plan","maxLength":20,"type":"string","nullable":true},"legal_district_lot":{"title":"District Lot","maxLength":20,"type":"string","nullable":true},"legal_block":{"title":"Block","maxLength":10,"type":"string","nullable":true},"legal_section":{"title":"Section","maxLength":10,"type":"string","nullable":true},"legal_township":{"title":"Township","maxLength":20,"type":"string","nullable":true},"legal_range":{"title":"Range","maxLength":10,"type":"string","nullable":true},"land_district":{"title":"Land District","type":"string","nullable":true},"legal_pid":{"title":"Legal pid","type":"string","readOnly":true},"well_location_description":{"title":"Description of Well Location","maxLength":500,"type":"string","nullable":true},"construction_start_date":{"title":"Construction Start Date","type":"string","format":"date","nullable":true},"construction_end_date":{"title":"Construction Date","type":"string","format":"date","nullable":true},"alteration_start_date":{"title":"Alteration Start Date","type":"string","format":"date","nullable":true},"alteration_end_date":{"title":"Alteration Date","type":"string","format":"date","nullable":true},"decommission_start_date":{"title":"Decommission Start Date","type":"string","format":"date","nullable":true},"decommission_end_date":{"title":"Decommission Date","type":"string","format":"date","nullable":true},"person_responsible":{"$ref":"#/components/schemas/PersonName"},"driller_name":{"title":"Name of Person Who Did the Work","maxLength":200,"type":"string","nullable":true},"drilling_company":{"title":"Drilling company","type":"string","readOnly":true},"company_of_person_responsible":{"title":"Company of person responsible","type":"string","readOnly":true},"consultant_name":{"title":"Consultant Name","maxLength":200,"type":"string","nullable":true},"consultant_company":{"title":"Consultant Company","maxLength":200,"type":"string","nullable":true},"well_identification_plate_attached":{"title":"Well Identification Plate Is Attached","maxLength":500,"type":"string","nullable":true},"id_plate_attached_by":{"title":"Well identification plate attached by","maxLength":100,"type":"string","nullable":true},"water_supply_system_name":{"title":"Water Supply System Name","maxLength":80,"type":"string","nullable":true},"water_supply_system_well_name":{"title":"Water Supply System Well Name","maxLength":80,"type":"string","nullable":true},"latitude":{"title":"Latitude","type":"string","readOnly":true},"longitude":{"title":"Longitude","type":"string","readOnly":true},"coordinate_acquisition_code":{"title":"Coordinate acquisition code","type":"string","readOnly":true},"ground_elevation":{"title":"Ground Elevation","type":"string","format":"decimal","nullable":true},"ground_elevation_method":{"title":"Ground elevation method","type":"string","readOnly":true},"drilling_methods":{"type":"array","items":{"$ref":"#/components/schemas/DrillingMethodSummary"}},"well_orientation_status":{"title":"Well Orientation Code","type":"string","nullable":true},"surface_seal_material":{"title":"Surface seal material","type":"string","readOnly":true},"surface_seal_thickness":{"title":"Surface Seal Thickness","type":"string","format":"decimal","nullable":true},"surface_seal_method":{"title":"Surface seal method","type":"string","readOnly":true},"surface_seal_depth":{"title":"Surface Seal Depth","type":"string","format":"decimal","nullable":true},"backfill_type":{"title":"Backfill Material Above Surface Seal","maxLength":250,"type":"string","nullable":true},"backfill_depth":{"title":"Backfill Depth","type":"string","format":"decimal","nullable":true},"liner_material":{"title":"Liner material","type":"string","readOnly":true},"liner_diameter":{"title":"Liner Diameter","type":"string","format":"decimal","nullable":true},"liner_thickness":{"title":"Liner Thickness","type":"string","format":"decimal","nullable":true},"liner_from":{"title":"Liner From","type":"string","format":"decimal","nullable":true},"liner_to":{"title":"Liner To","type":"string","format":"decimal","nullable":true},"screen_intake_method":{"title":"Screen intake method","type":"string","readOnly":true},"screen_type":{"title":"Screen type","type":"string","readOnly":true},"screen_material":{"title":"Screen material","type":"string","readOnly":true},"other_screen_material":{"title":"Specify Other Screen Material","maxLength":50,"type":"string","nullable":true},"screen_opening":{"title":"Screen opening","type":"string","readOnly":true},"screen_bottom":{"title":"Screen bottom","type":"string","readOnly":true},"other_screen_bottom":{"title":"Specify Other Screen Bottom","maxLength":50,"type":"string","nullable":true},"screen_information":{"title":"Screen Information","maxLength":300,"type":"string","nullable":true},"filter_pack_from":{"title":"Filter Pack From","type":"string","format":"decimal","nullable":true},"filter_pack_to":{"title":"Filter Pack To","type":"string","format":"decimal","nullable":true},"filter_pack_thickness":{"title":"Filter Pack Thickness","type":"string","format":"decimal","nullable":true},"filter_pack_material":{"title":"Filter Pack Material","type":"string","nullable":true},"filter_pack_material_size":{"title":"Filter Pack Material Size","type":"string","nullable":true},"development_methods":{"uniqueItems":true,"type":"array","items":{"title":"Development Methods","type":"string"}},"development_hours":{"title":"Development Total Duration","type":"string","format":"decimal","nullable":true},"development_notes":{"title":"Development Notes","maxLength":255,"type":"string","nullable":true},"water_quality_characteristics":{"uniqueItems":true,"type":"array","items":{"title":"Obvious Water Quality Characteristics","type":"string"}},"water_quality_colour":{"title":"Water Quality Colour","maxLength":60,"type":"string","nullable":true},"water_quality_odour":{"title":"Water Quality Odour","maxLength":60,"type":"string","nullable":true},"total_depth_drilled":{"title":"Total Depth Drilled","type":"string","format":"decimal","nullable":true},"finished_well_depth":{"title":"Finished Well Depth","type":"string","format":"decimal","nullable":true},"final_casing_stick_up":{"title":"Final Casing Stick Up","type":"string","format":"decimal","nullable":true},"bedrock_depth":{"title":"Depth to Bedrock","type":"string","format":"decimal","nullable":true},"static_water_level":{"title":"Static Water Level (BTOC)","type":"string","format":"decimal","nullable":true},"well_yield":{"title":"Estimated Well Yield","type":"string","format":"decimal","nullable":true},"artesian_flow":{"title":"Artesian Flow","type":"string","format":"decimal","nullable":true},"artesian_pressure":{"title":"Artesian Pressure","type":"string","format":"decimal","nullable":true},"artesian_pressure_head":{"title":"Artesian Pressure head","type":"string","format":"decimal","nullable":true},"artesian_conditions":{"title":"Artesian Conditions","type":"boolean"},"well_cap_type":{"title":"Well Cap","maxLength":40,"type":"string","nullable":true},"well_disinfected_status":{"title":"Well Disinfected Code","type":"string","nullable":true},"comments":{"title":"Comments","maxLength":3000,"type":"string","nullable":true},"alternative_specs_submitted":{"title":"Alternative specs submitted","type":"string","readOnly":true},"well_yield_unit":{"title":"Well yield unit","type":"string","nullable":true},"diameter":{"title":"Diameter","maxLength":9,"type":"string"},"observation_well_number":{"title":"Observation Well Number","maxLength":30,"type":"string","nullable":true},"observation_well_status":{"title":"Observation Well Status","type":"string","nullable":true},"ems":{"title":"Environmental Monitoring System (EMS) ID","maxLength":10,"type":"string","nullable":true},"aquifer":{"title":"Aquifer ID Number","type":"integer","nullable":true},"utm_zone_code":{"title":"Zone","maxLength":10,"type":"string","nullable":true},"utm_northing":{"title":"UTM Northing","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"utm_easting":{"title":"UTM Easting","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"bcgs_id":{"title":"BCGS Mapsheet Number","type":"integer","nullable":true},"decommission_reason":{"title":"Reason for Decommission","maxLength":250,"type":"string","nullable":true},"decommission_method":{"title":"Method of Decommission","type":"string","nullable":true},"decommission_sealant_material":{"title":"Decommission Sealant Material","maxLength":100,"type":"string","nullable":true},"decommission_backfill_material":{"title":"Decommission Backfill Material","maxLength":100,"type":"string","nullable":true},"decommission_details":{"title":"Decommission Details","maxLength":250,"type":"string","nullable":true},"aquifer_vulnerability_index":{"title":"AVI","type":"string","format":"decimal","nullable":true},"aquifer_lithology":{"title":"Aquifer Lithology","type":"string","nullable":true},"storativity":{"title":"Storativity","type":"string","format":"decimal","nullable":true},"transmissivity":{"title":"Transmissivity","type":"string","format":"decimal","nullable":true},"hydraulic_conductivity":{"title":"Hydraulic Conductivity","maxLength":100,"type":"string","nullable":true},"specific_storage":{"title":"Specific Storage","maxLength":100,"type":"string","nullable":true},"specific_yield":{"title":"Specific Yield","type":"string","format":"decimal","nullable":true},"testing_method":{"title":"Testing Method","maxLength":100,"type":"string","nullable":true},"testing_duration":{"title":"Testing duration","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"analytic_solution_type":{"title":"Analytic Solution Type","type":"string","format":"decimal","nullable":true},"boundary_effect":{"title":"Boundary Effect","type":"string","nullable":true},"yield_estimation_method":{"title":"Estimation Method","type":"string","nullable":true},"yield_estimation_rate":{"title":"Estimation Rate","type":"string","format":"decimal","nullable":true},"yield_estimation_duration":{"title":"Estimation Duration","type":"string","format":"decimal","nullable":true},"static_level_before_test":{"title":"SWL Before Test","type":"string","format":"decimal","nullable":true},"drawdown":{"title":"Drawdown","type":"string","format":"decimal","nullable":true},"hydro_fracturing_performed":{"title":"Hydro-fracturing Performed?","type":"boolean"},"hydro_fracturing_yield_increase":{"title":"Well Yield Increase Due to Hydro-fracturing","type":"string","format":"decimal","nullable":true},"recommended_pump_depth":{"title":"Recommended pump depth","type":"string","format":"decimal","nullable":true},"recommended_pump_rate":{"title":"Recommended pump rate","type":"string","format":"decimal","nullable":true},"casing_set":{"type":"array","items":{"$ref":"#/components/schemas/CasingSummary"}},"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/LithologyDescriptionSummary"}},"submission_work_dates":{"title":"Submission work dates","type":"string","readOnly":true},"is_published":{"title":"Is published","type":"string","readOnly":true}}},"DevelopmentMethodsSummary":{"required":["description"],"type":"object","properties":{"description":{"title":"Description","maxLength":100,"minLength":1,"type":"string"}}},"well_detail_v2":{"required":["casing_set","decommission_description_set","development_methods","drilling_methods","linerperforation_set","lithologydescription_set","owner_full_name","person_responsible","screen_set","well"],"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","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"owner_full_name":{"title":"Owner Name","maxLength":200,"minLength":1,"type":"string"},"well_class":{"title":"Well class","type":"string","readOnly":true},"well_subclass":{"title":"Well subclass","type":"string","readOnly":true},"intended_water_use":{"title":"Intended water use","type":"string","readOnly":true},"well_status":{"title":"Well status","type":"string","readOnly":true},"well_publication_status":{"title":"Well publication status","type":"string","readOnly":true},"licenced_status":{"title":"Licenced status","type":"string","readOnly":true},"street_address":{"title":"Street Address","maxLength":100,"type":"string","nullable":true},"city":{"title":"Town/City","maxLength":50,"type":"string","nullable":true},"legal_lot":{"title":"Lot","maxLength":10,"type":"string","nullable":true},"legal_plan":{"title":"Plan","maxLength":20,"type":"string","nullable":true},"legal_district_lot":{"title":"District Lot","maxLength":20,"type":"string","nullable":true},"legal_block":{"title":"Block","maxLength":10,"type":"string","nullable":true},"legal_section":{"title":"Section","maxLength":10,"type":"string","nullable":true},"legal_township":{"title":"Township","maxLength":20,"type":"string","nullable":true},"legal_range":{"title":"Range","maxLength":10,"type":"string","nullable":true},"land_district":{"title":"Land District","type":"string","nullable":true},"legal_pid":{"title":"Legal pid","type":"string","readOnly":true},"well_location_description":{"title":"Description of Well Location","maxLength":500,"type":"string","nullable":true},"construction_start_date":{"title":"Construction Start Date","type":"string","format":"date","nullable":true},"construction_end_date":{"title":"Construction Date","type":"string","format":"date","nullable":true},"alteration_start_date":{"title":"Alteration Start Date","type":"string","format":"date","nullable":true},"alteration_end_date":{"title":"Alteration Date","type":"string","format":"date","nullable":true},"decommission_start_date":{"title":"Decommission Start Date","type":"string","format":"date","nullable":true},"decommission_end_date":{"title":"Decommission Date","type":"string","format":"date","nullable":true},"person_responsible":{"$ref":"#/components/schemas/PersonName"},"driller_name":{"title":"Name of Person Who Did the Work","maxLength":200,"type":"string","nullable":true},"drilling_company":{"title":"Drilling company","type":"string","readOnly":true},"company_of_person_responsible":{"title":"Company of person responsible","type":"string","readOnly":true},"consultant_name":{"title":"Consultant Name","maxLength":200,"type":"string","nullable":true},"consultant_company":{"title":"Consultant Company","maxLength":200,"type":"string","nullable":true},"well_identification_plate_attached":{"title":"Well Identification Plate Is Attached","maxLength":500,"type":"string","nullable":true},"id_plate_attached_by":{"title":"Well identification plate attached by","maxLength":100,"type":"string","nullable":true},"water_supply_system_name":{"title":"Water Supply System Name","maxLength":80,"type":"string","nullable":true},"water_supply_system_well_name":{"title":"Water Supply System Well Name","maxLength":80,"type":"string","nullable":true},"latitude":{"title":"Latitude","type":"string","readOnly":true},"longitude":{"title":"Longitude","type":"string","readOnly":true},"coordinate_acquisition_code":{"title":"Coordinate acquisition code","type":"string","readOnly":true},"ground_elevation":{"title":"Ground Elevation","type":"string","format":"decimal","nullable":true},"ground_elevation_method":{"title":"Ground elevation method","type":"string","readOnly":true},"drilling_methods":{"type":"array","items":{"$ref":"#/components/schemas/DrillingMethodSummary"}},"well_orientation_status":{"title":"Well Orientation Code","type":"string","nullable":true},"surface_seal_material":{"title":"Surface seal material","type":"string","readOnly":true},"surface_seal_thickness":{"title":"Surface Seal Thickness","type":"string","format":"decimal","nullable":true},"surface_seal_method":{"title":"Surface seal method","type":"string","readOnly":true},"surface_seal_depth":{"title":"Surface Seal Depth","type":"string","format":"decimal","nullable":true},"backfill_type":{"title":"Backfill Material Above Surface Seal","maxLength":250,"type":"string","nullable":true},"backfill_depth":{"title":"Backfill Depth","type":"string","format":"decimal","nullable":true},"liner_material":{"title":"Liner material","type":"string","readOnly":true},"liner_diameter":{"title":"Liner Diameter","type":"string","format":"decimal","nullable":true},"liner_thickness":{"title":"Liner Thickness","type":"string","format":"decimal","nullable":true},"liner_from":{"title":"Liner From","type":"string","format":"decimal","nullable":true},"liner_to":{"title":"Liner To","type":"string","format":"decimal","nullable":true},"screen_intake_method":{"title":"Screen intake method","type":"string","readOnly":true},"screen_type":{"title":"Screen type","type":"string","readOnly":true},"screen_material":{"title":"Screen material","type":"string","readOnly":true},"other_screen_material":{"title":"Specify Other Screen Material","maxLength":50,"type":"string","nullable":true},"screen_opening":{"title":"Screen opening","type":"string","readOnly":true},"screen_bottom":{"title":"Screen bottom","type":"string","readOnly":true},"other_screen_bottom":{"title":"Specify Other Screen Bottom","maxLength":50,"type":"string","nullable":true},"screen_information":{"title":"Screen Information","maxLength":300,"type":"string","nullable":true},"filter_pack_from":{"title":"Filter Pack From","type":"string","format":"decimal","nullable":true},"filter_pack_to":{"title":"Filter Pack To","type":"string","format":"decimal","nullable":true},"filter_pack_thickness":{"title":"Filter Pack Thickness","type":"string","format":"decimal","nullable":true},"filter_pack_material":{"title":"Filter Pack Material","type":"string","nullable":true},"filter_pack_material_size":{"title":"Filter Pack Material Size","type":"string","nullable":true},"development_methods":{"type":"array","items":{"$ref":"#/components/schemas/DevelopmentMethodsSummary"}},"development_hours":{"title":"Development Total Duration","type":"string","format":"decimal","nullable":true},"development_notes":{"title":"Development Notes","maxLength":255,"type":"string","nullable":true},"water_quality_characteristics":{"uniqueItems":true,"type":"array","items":{"title":"Obvious Water Quality Characteristics","type":"string"}},"water_quality_colour":{"title":"Water Quality Colour","maxLength":60,"type":"string","nullable":true},"water_quality_odour":{"title":"Water Quality Odour","maxLength":60,"type":"string","nullable":true},"total_depth_drilled":{"title":"Total Depth Drilled","type":"string","format":"decimal","nullable":true},"finished_well_depth":{"title":"Finished Well Depth","type":"string","format":"decimal","nullable":true},"final_casing_stick_up":{"title":"Final Casing Stick Up","type":"string","format":"decimal","nullable":true},"bedrock_depth":{"title":"Depth to Bedrock","type":"string","format":"decimal","nullable":true},"static_water_level":{"title":"Static Water Level (BTOC)","type":"string","format":"decimal","nullable":true},"well_yield":{"title":"Estimated Well Yield","type":"string","format":"decimal","nullable":true},"artesian_flow":{"title":"Artesian Flow","type":"string","format":"decimal","nullable":true},"artesian_pressure":{"title":"Artesian Pressure","type":"string","format":"decimal","nullable":true},"artesian_pressure_head":{"title":"Artesian Pressure head","type":"string","format":"decimal","nullable":true},"artesian_conditions":{"title":"Artesian Conditions","type":"boolean"},"well_cap_type":{"title":"Well Cap","maxLength":40,"type":"string","nullable":true},"well_disinfected_status":{"title":"Well Disinfected Code","type":"string","nullable":true},"comments":{"title":"Comments","maxLength":3000,"type":"string","nullable":true},"alternative_specs_submitted":{"title":"Alternative specs submitted","type":"string","readOnly":true},"well_yield_unit":{"title":"Well yield unit","type":"string","nullable":true},"diameter":{"title":"Diameter","maxLength":9,"type":"string"},"observation_well_number":{"title":"Observation Well Number","maxLength":30,"type":"string","nullable":true},"observation_well_status":{"title":"Observation Well Status","type":"string","nullable":true},"ems":{"title":"Environmental Monitoring System (EMS) ID","maxLength":10,"type":"string","nullable":true},"aquifer":{"title":"Aquifer ID Number","type":"integer","nullable":true},"utm_zone_code":{"title":"Zone","maxLength":10,"type":"string","nullable":true},"utm_northing":{"title":"UTM Northing","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"utm_easting":{"title":"UTM Easting","maximum":2147483647,"minimum":-2147483648,"type":"integer","nullable":true},"bcgs_id":{"title":"BCGS Mapsheet Number","type":"integer","nullable":true},"decommission_reason":{"title":"Reason for Decommission","maxLength":250,"type":"string","nullable":true},"decommission_method":{"title":"Method of Decommission","type":"string","nullable":true},"decommission_sealant_material":{"title":"Decommission Sealant Material","maxLength":100,"type":"string","nullable":true},"decommission_backfill_material":{"title":"Decommission Backfill Material","maxLength":100,"type":"string","nullable":true},"decommission_details":{"title":"Decommission Details","maxLength":250,"type":"string","nullable":true},"aquifer_vulnerability_index":{"title":"AVI","type":"string","format":"decimal","nullable":true},"aquifer_lithology":{"title":"Aquifer Lithology","type":"string","nullable":true},"storativity":{"title":"Storativity","type":"string","format":"decimal","nullable":true},"transmissivity":{"title":"Transmissivity","type":"string","format":"decimal","nullable":true},"hydraulic_conductivity":{"title":"Hydraulic Conductivity","maxLength":100,"type":"string","nullable":true},"specific_storage":{"title":"Specific Storage","maxLength":100,"type":"string","nullable":true},"specific_yield":{"title":"Specific Yield","type":"string","format":"decimal","nullable":true},"testing_method":{"title":"Testing Method","maxLength":100,"type":"string","nullable":true},"testing_duration":{"title":"Testing duration","maximum":2147483647,"minimum":0,"type":"integer","nullable":true},"analytic_solution_type":{"title":"Analytic Solution Type","type":"string","format":"decimal","nullable":true},"boundary_effect":{"title":"Boundary Effect","type":"string","nullable":true},"yield_estimation_method":{"title":"Yield estimation method","type":"string","readOnly":true},"yield_estimation_rate":{"title":"Estimation Rate","type":"string","format":"decimal","nullable":true},"yield_estimation_duration":{"title":"Estimation Duration","type":"string","format":"decimal","nullable":true},"static_level_before_test":{"title":"SWL Before Test","type":"string","format":"decimal","nullable":true},"drawdown":{"title":"Drawdown","type":"string","format":"decimal","nullable":true},"hydro_fracturing_performed":{"title":"Hydro-fracturing Performed?","type":"boolean"},"hydro_fracturing_yield_increase":{"title":"Well Yield Increase Due to Hydro-fracturing","type":"string","format":"decimal","nullable":true},"recommended_pump_depth":{"title":"Recommended pump depth","type":"string","format":"decimal","nullable":true},"recommended_pump_rate":{"title":"Recommended pump rate","type":"string","format":"decimal","nullable":true},"casing_set":{"type":"array","items":{"$ref":"#/components/schemas/CasingSummary"}},"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/LithologyDescriptionSummary"}},"submission_work_dates":{"title":"Submission work dates","type":"string","readOnly":true},"is_published":{"title":"Is published","type":"string","readOnly":true}}}},"securitySchemes":{"Bearer":{"type":"apiKey","name":"JWT","in":"header"}}}} \ No newline at end of file diff --git a/gwells/gwells.yaml b/gwells/gwells.yaml index abd41d9..63ab9c7 100644 --- a/gwells/gwells.yaml +++ b/gwells/gwells.yaml @@ -1,9 +1,9 @@ -openapi: 3.0.0 +openapi: 3.0.1 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. + 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 @@ -11,83 +11,47 @@ info: name: Open Government License - British Columbia url: https://www2.gov.bc.ca/gov/content?id=A519A56BC2BF44E4A008B33FCF527F61 version: v1 +servers: +- url: https://apps.nrs.gov.bc.ca/gwells/api security: - - Bearer: - [] +- Bearer: [] paths: - /api-token-auth/: - parameters: - [] - /aquifer-codes/demand/: + /v1/aquifers: 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 + - v1 + description: return a list of aquifers + operationId: v1_aquifers_list 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 + - name: ordering + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: search + in: query + description: A search term. + schema: + type: string + - name: page + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + in: query + description: Number of results to return per page. + schema: + type: integer responses: - "200": + 200: description: "" content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -95,281 +59,145 @@ paths: next: type: string format: uri + nullable: true previous: type: string format: uri + nullable: true results: type: array items: - $ref: "#/components/schemas/AquiferMaterial" - tags: - - aquifer-codes - parameters: - [] - /aquifer-codes/productivity/: + $ref: '#/components/schemas/Aquifer' + /v1/aquifers/{aquifer_id}: 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 + - v1 + description: return details of aquifers + operationId: v1_aquifers_read responses: - "200": + 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 + $ref: '#/components/schemas/AquiferDetailSerializerV1' parameters: - [] - /aquifer-codes/subtypes/: + - name: aquifer_id + in: path + description: A unique integer value identifying this aquifer. + required: true + schema: + type: integer + /v1/aquifers/{aquifer_id}/files: 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 + tags: + - v1 + description: list files found for the aquifer identified in the uri + operationId: v1_aquifers_files_list responses: - "200": - description: "" + 200: + description: OK content: application/json: schema: - required: - - count - - results type: object properties: - count: - type: integer - next: - type: string - format: uri - previous: - type: string - format: uri - results: + private: 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: object + properties: + name: + type: string + url: + type: string + public: type: array items: - $ref: "#/components/schemas/AquiferVulnerability" - tags: - - aquifer-codes + type: object + properties: + name: + type: string + url: + type: string parameters: - [] - /aquifer-codes/water-use/: + - name: aquifer_id + in: path + required: true + schema: + type: string + /v1/drillers: get: - operationId: aquifer-codes_water-use_list - description: return a list of water use codes + tags: + - v1 + description: Returns a list of all person records + operationId: v1_drillers_list 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 + - name: search + in: query + description: A search term. + schema: + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: limit + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + schema: + type: integer responses: - "200": + 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/: + type: array + items: + $ref: '#/components/schemas/PersonList' + /v1/wells: get: - operationId: aquifers_list - description: return a list of aquifers + tags: + - v1 + description: returns a list of wells + operationId: v1_wells_list 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 + - name: search + in: query + description: A search term. + schema: + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: limit + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + schema: + type: integer responses: - "200": + 200: description: "" content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -377,933 +205,1759 @@ paths: next: type: string format: uri + nullable: true previous: type: string format: uri + nullable: true results: type: array items: - $ref: "#/components/schemas/Aquifer" - tags: - - aquifers - parameters: - [] - /aquifers/names/: + $ref: '#/components/schemas/WellListSerializerV1' + /v1/wells/export: get: - operationId: aquifers_names_list - description: List all aquifers in a simplified format + tags: + - v1 + description: Returns CSV or Excel data for wells. + operationId: v1_wells_export_list parameters: - - name: search - in: query - description: A search term. - required: false - schema: - type: string + - name: search + in: query + description: A search term. + schema: + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + schema: + type: string responses: - "200": + 200: description: "" content: - application/json: + text/csv: 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: + $ref: '#/components/schemas/WellExportSerializerV1' + application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: 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": + type: array + items: + $ref: '#/components/schemas/WellExportSerializerV1' + /v1/wells/{tag}/files: get: - operationId: aquifers_files_list - description: list files found for the aquifer identified in the uri + tags: + - v1 + description: list files found for the well identified in the uri + operationId: v1_wells_files_list responses: - "200": + 200: description: OK content: application/json: schema: type: object properties: - public: + private: type: array items: type: object properties: - url: - type: string name: type: string - private: + url: + type: string + public: type: array items: type: object properties: - url: - type: string name: type: string - tags: - - aquifers + url: + type: string parameters: - - name: aquifer_id - in: path - required: true - schema: - type: string - /cities/drillers/: + - name: tag + in: path + required: true + schema: + type: string + /v1/wells/{well_tag_number}: 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) + - v1 + description: |- + Return well detail. + This view is open to all, and has no permissions. + operationId: v1_wells_read responses: - "200": + 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 + $ref: '#/components/schemas/well_detail_v1' parameters: - [] - /drillers/: + - name: well_tag_number + in: path + required: true + schema: + type: string + /v2/wells/{well_tag_number}: 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 + - v2 + description: |- + Return well detail. + This view is open to all, and has no permissions. + operationId: v2_wells_read responses: - "200": + 200: description: "" content: application/json: schema: - type: array - items: - $ref: "#/components/schemas/PersonName" - tags: - - drillers - parameters: - [] - /drillers/options/: + $ref: '#/components/schemas/well_detail_v2' 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: + - name: well_tag_number + in: path + required: true + schema: + type: string +components: + schemas: + Aquifer: + type: object + properties: + aquifer_id: + title: Aquifer ID Number + type: integer + readOnly: true + mapping_year: + title: Date of Mapping + maximum: 2021 + minimum: 1.99E+3 + type: integer + description: 'Use the following format: ' + nullable: true + AquiferResource: + required: + - name + - section_code + - url + type: object + properties: + id: + title: Aquifer Resource Identifier + type: integer + readOnly: true + name: + title: Aquifer Resource Name + maxLength: 255 + minLength: 1 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: + url: + title: PDF Document URL + maxLength: 255 + minLength: 1 type: string - "/wells/{well_tag_number}": - get: - operationId: wells_read - description: |- - Return well detail. - This 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: + description: A resolvable link to the PDF document associated with this + aquifer resource. + format: uri + section_code: + title: Section code + type: string + AquiferDetailSerializerV1: + type: object + properties: + aquifer_id: + title: Aquifer ID Number type: integer -servers: - - url: https://apps.nrs.gov.bc.ca/gwells/api/v1/ -components: - securitySchemes: - Bearer: - type: apiKey - name: JWT - in: header - schemas: - AquiferDemand: + readOnly: true + aquifer_name: + title: Aquifer name + maxLength: 100 + type: string + nullable: true + location_description: + title: Description of Location + maxLength: 100 + type: string + nullable: true + quality_concern: + title: Quality Concern Reference + type: string + nullable: true + material: + title: Material Reference + type: string + nullable: true + subtype: + title: Subtype Reference + type: string + nullable: true + vulnerability: + title: Aquifer Vulnerabiliy + type: string + nullable: true + known_water_use: + title: Known Water Use Reference + type: string + nullable: true + litho_stratographic_unit: + title: Lithographic Stratographic Unit + maxLength: 100 + type: string + nullable: true + productivity: + title: Productivity Reference + type: string + nullable: true + demand: + title: Demand Reference + type: string + nullable: true + mapping_year: + title: Date of Mapping + maximum: 2021 + minimum: 1.99E+3 + type: integer + description: 'Use the following format: ' + nullable: true + resources: + type: array + items: + $ref: '#/components/schemas/AquiferResource' + area: + title: Size (square km) + type: string + format: decimal + nullable: true + notes: + title: Notes on Aquifer, for internal use only. + maxLength: 2000 + type: string + nullable: true + licence_details: + title: Licence details + type: object + properties: {} + readOnly: true + Qualification: required: - - code - - description + - well_class type: object properties: - code: - title: Code + well_class: + title: Well class type: string - maxLength: 1 description: title: Description type: string - maxLength: 100 - AquiferMaterial: + readOnly: true + Subactivity: required: - - code - - description + - description type: object properties: - code: - title: Code + registries_subactivity_code: + title: Registries subactivity code + minLength: 1 type: string - maxLength: 10 + readOnly: true description: title: Description - type: string maxLength: 100 - AquiferProductivity: + minLength: 1 + type: string + qualification_set: + type: array + readOnly: true + items: + $ref: '#/components/schemas/Qualification' + ApplicationStatusCode: required: - - code - - description + - description type: object properties: code: title: Code + minLength: 1 type: string - maxLength: 1 + readOnly: true description: title: Description - type: string maxLength: 100 - QualityConcern: + minLength: 1 + type: string + ApplicationList: required: - - code - - description + - subactivity type: object properties: - code: - title: Code + qualifications: + type: array + readOnly: true + items: + $ref: '#/components/schemas/Qualification' + subactivity: + $ref: '#/components/schemas/Subactivity' + cert_authority: + title: Cert authority + type: string + readOnly: true + removal_date: + title: Removal date + type: string + format: date + nullable: true + certificate: + title: Certificate + type: string + readOnly: true + display_status: + title: Display status + type: string + readOnly: true + current_status: + $ref: '#/components/schemas/ApplicationStatusCode' + OrganizationList: + required: + - name + - province_state + type: object + properties: + org_guid: + title: Organization UUID + type: string + format: uuid + readOnly: true + name: + title: Name + maxLength: 200 + minLength: 1 + type: string + org_verbose_name: + title: Org verbose name + type: string + readOnly: true + street_address: + title: Street Address + maxLength: 100 + type: string + nullable: true + city: + title: Town/City + maxLength: 50 + type: string + nullable: true + province_state: + title: Province/State + type: string + postal_code: + title: Postal Code + maxLength: 10 + type: string + nullable: true + main_tel: + title: Telephone number + maxLength: 15 + type: string + nullable: true + fax_tel: + title: Fax number + maxLength: 15 + type: string + nullable: true + email: + title: Email adddress + maxLength: 254 + type: string + format: email + nullable: true + website_url: + title: Website + maxLength: 200 + type: string + format: uri + nullable: true + 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 + maxLength: 15 + type: string + nullable: true + applications: + type: array + readOnly: true + items: + $ref: '#/components/schemas/ApplicationList' + 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 + maxLength: 100 + minLength: 1 + type: string + surname: + title: Surname + maxLength: 100 + minLength: 1 + type: string + registrations: + type: array + readOnly: true + items: + $ref: '#/components/schemas/RegistrationsList' + contact_tel: + title: Contact telephone number + maxLength: 15 + type: string + nullable: true + contact_cell: + title: Contact cell number + maxLength: 15 + type: string + nullable: true + contact_email: + title: Email address + maxLength: 254 + type: string + format: email + nullable: true + WellListSerializerV1: + 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 + maximum: 2147483647 + minimum: 0 + type: integer + nullable: true + owner_full_name: + title: Owner Name + maxLength: 200 + minLength: 1 + type: string + well_class: + title: Well Class + type: string + well_subclass: + title: Well Subclass + type: string + format: uuid + nullable: true + well_status: + title: Well Status + type: string + nullable: true + licenced_status: + title: Licenced status + type: string + readOnly: true + street_address: + title: Street Address + maxLength: 100 + type: string + nullable: true + city: + title: Town/City + maxLength: 50 + type: string + nullable: true + legal_lot: + title: Lot + maxLength: 10 + type: string + nullable: true + legal_plan: + title: Plan + maxLength: 20 + type: string + nullable: true + legal_district_lot: + title: District Lot + maxLength: 20 + type: string + nullable: true + legal_block: + title: Block + maxLength: 10 + type: string + nullable: true + legal_section: + title: Section + maxLength: 10 + type: string + nullable: true + legal_township: + title: Township + maxLength: 20 + type: string + nullable: true + legal_range: + title: Range + maxLength: 10 + type: string + nullable: true + land_district: + title: Land District + type: string + nullable: true + legal_pid: + title: Legal pid + type: string + readOnly: true + well_location_description: + title: Description of Well Location + maxLength: 500 + type: string + nullable: true + construction_start_date: + title: Construction Start Date + type: string + format: date + nullable: true + construction_end_date: + title: Construction Date + type: string + format: date + nullable: true + alteration_start_date: + title: Alteration Start Date + type: string + format: date + nullable: true + alteration_end_date: + title: Alteration Date + type: string + format: date + nullable: true + decommission_start_date: + title: Decommission Start Date + type: string + format: date + nullable: true + decommission_end_date: + title: Decommission Date + type: string + format: date + nullable: true + drilling_company: + title: Drilling company + type: string + readOnly: true + company_of_person_responsible: + title: Company of person responsible + type: string + readOnly: true + well_identification_plate_attached: + title: Well Identification Plate Is Attached + maxLength: 500 + type: string + nullable: true + id_plate_attached_by: + title: Well identification plate attached by + maxLength: 100 + type: string + nullable: true + water_supply_system_name: + title: Water Supply System Name + maxLength: 80 + type: string + nullable: true + water_supply_system_well_name: + title: Water Supply System Well Name + maxLength: 80 + type: string + nullable: true + latitude: + title: Latitude + type: string + readOnly: true + longitude: + title: Longitude + type: string + readOnly: true + coordinate_acquisition_code: + title: Location Accuracy Code + type: string + nullable: true + ground_elevation: + title: Ground Elevation + type: string + format: decimal + nullable: true + ground_elevation_method: + title: Elevation Determined By + type: string + nullable: true + drilling_methods: + uniqueItems: true + type: array + items: + title: Drilling Methods + type: string + well_orientation_status: + title: Well Orientation Code + type: string + nullable: true + surface_seal_material: + title: Surface Seal Material + type: string + nullable: true + surface_seal_thickness: + title: Surface Seal Thickness + type: string + format: decimal + nullable: true + surface_seal_method: + title: Surface Seal Installation Method + type: string + nullable: true + surface_seal_depth: + title: Surface Seal Depth + type: string + format: decimal + nullable: true + backfill_type: + title: Backfill Material Above Surface Seal + maxLength: 250 + type: string + nullable: true + backfill_depth: + title: Backfill Depth + type: string + format: decimal + nullable: true + liner_material: + title: Liner Material + type: string + nullable: true + liner_diameter: + title: Liner Diameter + type: string + format: decimal + nullable: true + liner_thickness: + title: Liner Thickness + type: string + format: decimal + nullable: true + liner_from: + title: Liner From + type: string + format: decimal + nullable: true + liner_to: + title: Liner To + type: string + format: decimal + nullable: true + screen_intake_method: + title: Intake Method + type: string + nullable: true + screen_type: + title: Type + type: string + nullable: true + screen_material: + title: Material + type: string + nullable: true + other_screen_material: + title: Specify Other Screen Material + maxLength: 50 + type: string + nullable: true + screen_opening: + title: Opening + type: string + nullable: true + screen_bottom: + title: Bottom + type: string + nullable: true + other_screen_bottom: + title: Specify Other Screen Bottom + maxLength: 50 + type: string + nullable: true + screen_information: + title: Screen Information + maxLength: 300 + type: string + nullable: true + filter_pack_from: + title: Filter Pack From + type: string + format: decimal + nullable: true + filter_pack_to: + title: Filter Pack To + type: string + format: decimal + nullable: true + filter_pack_thickness: + title: Filter Pack Thickness + type: string + format: decimal + nullable: true + filter_pack_material: + title: Filter Pack Material + type: string + nullable: true + filter_pack_material_size: + title: Filter Pack Material Size + type: string + nullable: true + development_methods: + uniqueItems: true + type: array + items: + title: Development Methods + type: string + development_hours: + title: Development Total Duration + type: string + format: decimal + nullable: true + development_notes: + title: Development Notes + maxLength: 255 + type: string + nullable: true + yield_estimation_method: + title: Estimation Method + type: string + nullable: true + yield_estimation_rate: + title: Estimation Rate + type: string + format: decimal + nullable: true + yield_estimation_duration: + title: Estimation Duration + type: string + format: decimal + nullable: true + well_yield_unit: + title: Well yield unit + type: string + nullable: true + static_level_before_test: + title: SWL Before Test + type: string + format: decimal + nullable: true + drawdown: + title: Drawdown + type: string + format: decimal + nullable: true + hydro_fracturing_performed: + title: Hydro-fracturing Performed? + type: boolean + hydro_fracturing_yield_increase: + title: Well Yield Increase Due to Hydro-fracturing + type: string + format: decimal + nullable: true + recommended_pump_depth: + title: Recommended pump depth + type: string + format: decimal + nullable: true + recommended_pump_rate: + title: Recommended pump rate + type: string + format: decimal + nullable: true + water_quality_characteristics: + uniqueItems: true + type: array + items: + title: Obvious Water Quality Characteristics + type: string + water_quality_colour: + title: Water Quality Colour + maxLength: 60 + type: string + nullable: true + water_quality_odour: + title: Water Quality Odour + maxLength: 60 + type: string + nullable: true + total_depth_drilled: + title: Total Depth Drilled + type: string + format: decimal + nullable: true + finished_well_depth: + title: Finished Well Depth + type: string + format: decimal + nullable: true + well_yield: + title: Estimated Well Yield + type: string + format: decimal + nullable: true + diameter: + title: Diameter + maxLength: 9 + type: string + observation_well_number: + title: Observation Well Number + maxLength: 30 + type: string + nullable: true + observation_well_status: + title: Observation Well Status + type: string + nullable: true + ems: + title: Environmental Monitoring System (EMS) ID + maxLength: 10 + type: string + nullable: true + aquifer: + title: Aquifer ID Number + type: integer + nullable: true + utm_zone_code: + title: Zone + maxLength: 10 + type: string + nullable: true + utm_northing: + title: UTM Northing + maximum: 2147483647 + minimum: -2147483648 + type: integer + nullable: true + utm_easting: + title: UTM Easting + maximum: 2147483647 + minimum: -2147483648 + type: integer + nullable: true + bcgs_id: + title: BCGS Mapsheet Number + type: integer + nullable: true + decommission_reason: + title: Reason for Decommission + maxLength: 250 + type: string + nullable: true + decommission_method: + title: Method of Decommission + type: string + nullable: true + decommission_sealant_material: + title: Decommission Sealant Material + maxLength: 100 + type: string + nullable: true + decommission_backfill_material: + title: Decommission Backfill Material + maxLength: 100 + type: string + nullable: true + decommission_details: + title: Decommission Details + maxLength: 250 + type: string + nullable: true + aquifer_vulnerability_index: + title: AVI + type: string + format: decimal + nullable: true + aquifer_lithology: + title: Aquifer Lithology + type: string + nullable: true + storativity: + title: Storativity + type: string + format: decimal + nullable: true + transmissivity: + title: Transmissivity + type: string + format: decimal + nullable: true + hydraulic_conductivity: + title: Hydraulic Conductivity + maxLength: 100 + type: string + nullable: true + specific_storage: + title: Specific Storage + maxLength: 100 + type: string + nullable: true + specific_yield: + title: Specific Yield + type: string + format: decimal + nullable: true + testing_method: + title: Testing Method + maxLength: 100 + type: string + nullable: true + testing_duration: + title: Testing duration + maximum: 2147483647 + minimum: 0 + type: integer + nullable: true + analytic_solution_type: + title: Analytic Solution Type + type: string + format: decimal + nullable: true + boundary_effect: + title: Boundary Effect + type: string + nullable: true + final_casing_stick_up: + title: Final Casing Stick Up + type: string + format: decimal + nullable: true + bedrock_depth: + title: Depth to Bedrock + type: string + format: decimal + nullable: true + artesian_flow: + title: Artesian Flow + type: string + format: decimal + nullable: true + artesian_pressure: + title: Artesian Pressure + type: string + format: decimal + nullable: true + artesian_pressure_head: + title: Artesian Pressure head + type: string + format: decimal + nullable: true + artesian_conditions: + title: Artesian Conditions + type: boolean + well_cap_type: + title: Well Cap + maxLength: 40 + type: string + nullable: true + well_disinfected_status: + title: Well Disinfected Code + type: string + nullable: true + static_water_level: + title: Static Water Level (BTOC) + type: string + format: decimal + nullable: true + WellExportSerializerV1: + 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 + maximum: 2147483647 + minimum: 0 + type: integer + nullable: true + owner_full_name: + title: Owner Name + maxLength: 200 + minLength: 1 + type: string + well_class: + title: Well class + type: string + readOnly: true + well_subclass: + title: Well subclass + type: string + readOnly: true + well_status: + title: Well status + type: string + readOnly: true + licenced_status: + title: Licenced status + type: string + readOnly: true + street_address: + title: Street Address + maxLength: 100 + type: string + nullable: true + city: + title: Town/City + maxLength: 50 + type: string + nullable: true + legal_lot: + title: Lot + maxLength: 10 + type: string + nullable: true + legal_plan: + title: Plan + maxLength: 20 + type: string + nullable: true + legal_district_lot: + title: District Lot + maxLength: 20 + type: string + nullable: true + legal_block: + title: Block + maxLength: 10 + type: string + nullable: true + legal_section: + title: Section + maxLength: 10 + type: string + nullable: true + legal_township: + title: Township + maxLength: 20 + type: string + nullable: true + legal_range: + title: Range + maxLength: 10 + type: string + nullable: true + land_district: + title: Land district + type: string + readOnly: true + legal_pid: + title: Legal pid + type: string + readOnly: true + well_location_description: + title: Description of Well Location + maxLength: 500 + type: string + nullable: true + construction_start_date: + title: Construction Start Date + type: string + format: date + nullable: true + construction_end_date: + title: Construction Date + type: string + format: date + nullable: true + alteration_start_date: + title: Alteration Start Date + type: string + format: date + nullable: true + alteration_end_date: + title: Alteration Date + type: string + format: date + nullable: true + decommission_start_date: + title: Decommission Start Date + type: string + format: date + nullable: true + decommission_end_date: + title: Decommission Date + type: string + format: date + nullable: true + drilling_company: + title: Drilling company + minLength: 1 + type: string + readOnly: true + company_of_person_responsible: + title: Company of person responsible + type: string + readOnly: true + well_identification_plate_attached: + title: Well Identification Plate Is Attached + maxLength: 500 + type: string + nullable: true + id_plate_attached_by: + title: Well identification plate attached by + maxLength: 100 + type: string + nullable: true + water_supply_system_name: + title: Water Supply System Name + maxLength: 80 + type: string + nullable: true + water_supply_system_well_name: + title: Water Supply System Well Name + maxLength: 80 + type: string + nullable: true + latitude: + title: Latitude + type: string + readOnly: true + longitude: + title: Longitude + type: string + readOnly: true + coordinate_acquisition_code: + title: Coordinate acquisition code + type: string + readOnly: true + ground_elevation: + title: Ground Elevation + type: string + format: decimal + nullable: true + ground_elevation_method: + title: Ground elevation method + type: string + readOnly: true + drilling_methods: + uniqueItems: true + type: array + readOnly: true + items: + type: string + well_orientation_status: + title: Well Orientation Code + type: string + nullable: true + surface_seal_material: + title: Surface seal material + type: string + readOnly: true + surface_seal_thickness: + title: Surface Seal Thickness + type: string + format: decimal + nullable: true + surface_seal_method: + title: Surface seal method + type: string + readOnly: true + surface_seal_depth: + title: Surface Seal Depth + type: string + format: decimal + nullable: true + backfill_type: + title: Backfill Material Above Surface Seal + maxLength: 250 + type: string + nullable: true + backfill_depth: + title: Backfill Depth + type: string + format: decimal + nullable: true + liner_material: + title: Liner material + type: string + readOnly: true + liner_diameter: + title: Liner Diameter + type: string + format: decimal + nullable: true + liner_thickness: + title: Liner Thickness + type: string + format: decimal + nullable: true + liner_from: + title: Liner From + type: string + format: decimal + nullable: true + liner_to: + title: Liner To + type: string + format: decimal + nullable: true + screen_intake_method: + title: Screen intake method + type: string + readOnly: true + screen_type: + title: Screen type + type: string + readOnly: true + screen_material: + title: Screen material + type: string + readOnly: true + other_screen_material: + title: Specify Other Screen Material + maxLength: 50 + type: string + nullable: true + screen_opening: + title: Screen opening + type: string + readOnly: true + screen_bottom: + title: Screen bottom + type: string + readOnly: true + other_screen_bottom: + title: Specify Other Screen Bottom + maxLength: 50 + type: string + nullable: true + screen_information: + title: Screen Information + maxLength: 300 + type: string + nullable: true + filter_pack_from: + title: Filter Pack From + type: string + format: decimal + nullable: true + filter_pack_to: + title: Filter Pack To + type: string + format: decimal + nullable: true + filter_pack_thickness: + title: Filter Pack Thickness + type: string + format: decimal + nullable: true + filter_pack_material: + title: Filter Pack Material + type: string + nullable: true + filter_pack_material_size: + title: Filter Pack Material Size + type: string + nullable: true + development_methods: + uniqueItems: true + type: array + readOnly: true + items: + type: string + development_hours: + title: Development Total Duration type: string - maxLength: 2 - description: - title: Description + format: decimal + nullable: true + development_notes: + title: Development Notes + maxLength: 255 type: string - maxLength: 100 - AquiferSubtype: - required: - - code - - description - type: object - properties: - code: - title: Code + nullable: true + yield_estimation_method: + title: Yield estimation method type: string - maxLength: 3 - description: - title: Description + readOnly: true + yield_estimation_rate: + title: Estimation Rate type: string - AquiferVulnerability: - required: - - code - - description - type: object - properties: - code: - title: Code + format: decimal + nullable: true + yield_estimation_duration: + title: Estimation Duration type: string - maxLength: 1 - description: - title: Description + format: decimal + nullable: true + well_yield_unit: + title: Well yield unit type: string - maxLength: 100 - WaterUse: - required: - - code - - description - type: object - properties: - code: - title: Code + readOnly: true + static_level_before_test: + title: SWL Before Test type: string - maxLength: 2 - description: - title: Description + format: decimal + nullable: true + drawdown: + title: Drawdown + type: string + format: decimal + nullable: true + hydro_fracturing_performed: + title: Hydro fracturing performed + minLength: 1 type: string - maxLength: 100 - Aquifer: - type: object - properties: - aquifer_id: - title: Aquifer ID Number - type: integer readOnly: true - aquifer_name: - title: Aquifer name + hydro_fracturing_yield_increase: + title: Well Yield Increase Due to Hydro-fracturing type: string - maxLength: 100 - area: - title: Size (square km) + format: decimal + nullable: true + recommended_pump_depth: + title: Recommended pump depth type: string format: decimal - demand_description: - title: Demand description + nullable: true + recommended_pump_rate: + title: Recommended pump rate type: string + format: decimal + nullable: true + water_quality_characteristics: + uniqueItems: true + type: array readOnly: true - demand: - title: Demand Reference + items: + type: string + water_quality_colour: + title: Water Quality Colour + maxLength: 60 type: string - known_water_use_description: - title: Known water use description + nullable: true + water_quality_odour: + title: Water Quality Odour + maxLength: 60 type: string - readOnly: true - known_water_use: - title: Known Water Use Reference + nullable: true + total_depth_drilled: + title: Total Depth Drilled type: string - litho_stratographic_unit: - title: Lithographic Stratographic Unit + format: decimal + nullable: true + finished_well_depth: + title: Finished Well Depth type: string - maxLength: 100 - location_description: - title: Description of Location + format: decimal + nullable: true + well_yield: + title: Estimated Well Yield 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 + format: decimal + nullable: true + diameter: + title: Diameter + maxLength: 9 type: string - readOnly: true - material: - title: Material Reference + observation_well_number: + title: Observation Well Number + maxLength: 30 type: string - notes: - title: Notes on Aquifer, for internal use only. + nullable: true + observation_well_status: + title: Observation well status type: string - maxLength: 2000 - productivity_description: - title: Productivity description + readOnly: true + ems: + title: Environmental Monitoring System (EMS) ID + maxLength: 10 type: string + nullable: true + aquifer: + title: Aquifer + type: integer readOnly: true - productivity: - title: Productivity Reference + utm_zone_code: + title: Zone + maxLength: 10 type: string - quality_concern_description: - title: Quality concern description + nullable: true + utm_northing: + title: UTM Northing + maximum: 2147483647 + minimum: -2147483648 + type: integer + nullable: true + utm_easting: + title: UTM Easting + maximum: 2147483647 + minimum: -2147483648 + type: integer + nullable: true + bcgs_id: + title: Bcgs id type: string readOnly: true - quality_concern: - title: Quality Concern Reference + decommission_reason: + title: Reason for Decommission + maxLength: 250 type: string - subtype_description: - title: Subtype description + nullable: true + decommission_method: + title: Decommission method type: string readOnly: true - subtype: - title: Subtype Reference + decommission_sealant_material: + title: Decommission Sealant Material + maxLength: 100 type: string - vulnerability_description: - title: Vulnerability description + nullable: true + decommission_backfill_material: + title: Decommission Backfill Material + maxLength: 100 type: string - readOnly: true - vulnerability: - title: Aquifer Vulnerabiliy + nullable: true + decommission_details: + title: Decommission Details + maxLength: 250 type: string - AquiferSerializerBasic: - type: object - properties: - aquifer_id: - title: Aquifer ID Number - type: integer - readOnly: true - description: - title: Description + nullable: true + aquifer_vulnerability_index: + title: AVI type: string - readOnly: true - Organization: - title: Organization - required: - - name - - province_state - type: object - properties: - org_guid: - title: Organization UUID + format: decimal + nullable: true + aquifer_lithology: + title: Aquifer lithology type: string - format: uuid readOnly: true - name: - title: Name + storativity: + title: Storativity type: string - maxLength: 200 - org_verbose_name: - title: Org verbose name + format: decimal + nullable: true + transmissivity: + title: Transmissivity type: string - readOnly: true - street_address: - title: Street Address + format: decimal + nullable: true + hydraulic_conductivity: + title: Hydraulic Conductivity + maxLength: 100 + type: string + nullable: true + specific_storage: + title: Specific Storage + maxLength: 100 + type: string + nullable: true + specific_yield: + title: Specific Yield type: string + format: decimal + nullable: true + testing_method: + title: Testing Method maxLength: 100 - city: - title: Town/City type: string - maxLength: 50 - province_state: - title: Province/State + nullable: true + testing_duration: + title: Testing duration + maximum: 2147483647 + minimum: 0 + type: integer + nullable: true + analytic_solution_type: + title: Analytic Solution Type type: string - postal_code: - title: Postal Code + format: decimal + nullable: true + boundary_effect: + title: Boundary Effect type: string - maxLength: 10 - main_tel: - title: Telephone number + nullable: true + final_casing_stick_up: + title: Final Casing Stick Up type: string - maxLength: 15 - fax_tel: - title: Fax number + format: decimal + nullable: true + bedrock_depth: + title: Depth to Bedrock type: string - maxLength: 15 - email: - title: Email adddress + format: decimal + nullable: true + artesian_flow: + title: Artesian Flow type: string - format: email - maxLength: 254 - website_url: - title: Website + format: decimal + nullable: true + artesian_pressure: + title: Artesian Pressure type: string - format: uri - maxLength: 200 - CityList: - required: - - organization - type: object - properties: - organization: - $ref: "#/components/schemas/Organization" - Qualification: + format: decimal + nullable: true + artesian_pressure_head: + title: Artesian Pressure head + type: string + format: decimal + nullable: true + artesian_conditions: + title: Artesian Conditions + type: boolean + well_cap_type: + title: Well Cap + maxLength: 40 + type: string + nullable: true + well_disinfected_status: + title: Well Disinfected Code + type: string + nullable: true + static_water_level: + title: Static Water Level (BTOC) + type: string + format: decimal + nullable: true + RegistrationsNumber: required: - - well_class + - registries_activity type: object properties: - well_class: - title: Well class + registration_no: + title: Registration no + maxLength: 15 type: string - description: - title: Description + nullable: true + registries_activity: + title: Registries activity type: string - readOnly: true - Subactivity: - title: Subactivity - required: - - description + PersonName: type: object properties: - registries_subactivity_code: - title: Registries subactivity code + name: + title: Name type: string readOnly: true - description: - title: Description + person_guid: + title: Person UUID type: string - maxLength: 100 - qualification_set: + format: uuid + readOnly: true + registrations: type: array - items: - $ref: "#/components/schemas/Qualification" readOnly: true - ApplicationStatusCode: - title: Current status + items: + $ref: '#/components/schemas/RegistrationsNumber' + DrillingMethodSummary: required: - - description + - description type: object properties: - code: - title: Code - type: string - readOnly: true description: title: Description - type: string maxLength: 100 - ApplicationList: - required: - - subactivity + minLength: 1 + type: string + CasingSummary: 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 + start: + title: From type: string - format: date - certificate: - title: Certificate + format: decimal + nullable: true + end: + title: To type: string - readOnly: true - display_status: - title: Display status + format: decimal + nullable: true + diameter: + title: Diameter 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 + format: decimal + nullable: true + casing_code: + title: Casing code type: string - format: uuid readOnly: true - name: - title: Name - type: string - maxLength: 200 - org_verbose_name: - title: Org verbose name + casing_material: + title: Casing material type: string readOnly: true - street_address: - title: Street Address + drive_shoe_status: + title: Drive Shoe Code type: string - maxLength: 100 - city: - title: Town/City - type: string - maxLength: 50 - province_state: - title: Province/State + nullable: true + wall_thickness: + title: Wall Thickness type: string - postal_code: - title: Postal Code + format: decimal + nullable: true + Screen: + required: + - assembly_type + - end + - start + type: object + properties: + start: + title: From type: string - maxLength: 10 - main_tel: - title: Telephone number + format: decimal + nullable: true + end: + title: To type: string - maxLength: 15 - fax_tel: - title: Fax number + format: decimal + nullable: true + diameter: + title: Diameter type: string - maxLength: 15 - email: - title: Email adddress + format: decimal + nullable: true + assembly_type: + title: Assembly type type: string - format: email - maxLength: 254 - website_url: - title: Website + nullable: true + slot_size: + title: Slot Size type: string - format: uri - maxLength: 200 - RegistrationsList: + format: decimal + nullable: true + LinerPerforation: required: - - organization + - end + - start type: object properties: - activity: - title: Activity - type: string - readOnly: true - activity_description: - title: Activity description + start: + title: Perforated From type: string - readOnly: true - registration_no: - title: Registration no + format: decimal + end: + title: Perforated To type: string - maxLength: 15 - applications: - type: array - items: - $ref: "#/components/schemas/ApplicationList" - readOnly: true - organization: - $ref: "#/components/schemas/OrganizationList" - PersonList: + format: decimal + DecommissionDescription: required: - - first_name - - surname + - end + - material + - start 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 + start: + title: Decommissioned From type: string - maxLength: 100 - registrations: - type: array - items: - $ref: "#/components/schemas/RegistrationsList" - readOnly: true - contact_tel: - title: Contact telephone number + format: decimal + end: + title: Decommissioned To type: string - maxLength: 15 - contact_cell: - title: Contact cell number + format: decimal + material: + title: Material type: string - maxLength: 15 - contact_email: - title: Email address + observations: + title: Observations + maxLength: 255 type: string - format: email - maxLength: 254 - RegistrationsNumber: - required: - - registries_activity + nullable: true + LithologyDescriptionSummary: type: object properties: - registration_no: - title: Registration no + start: + title: From type: string - maxLength: 15 - registries_activity: - title: Registries activity + format: decimal + nullable: true + end: + title: To type: string - PersonName: - type: object - properties: - name: - title: Name + format: decimal + nullable: true + lithology_raw_data: + title: Raw Data + maxLength: 250 type: string - readOnly: true - person_guid: - title: Person UUID + nullable: true + lithology_colour: + title: Lithology colour type: string - format: uuid readOnly: true - registrations: - type: array - items: - $ref: "#/components/schemas/RegistrationsNumber" + lithology_hardness: + title: Lithology hardness + type: string readOnly: true - Survey: - type: object - properties: - survey_guid: - title: Survey guid + lithology_moisture: + title: Lithology moisture type: string - format: uuid readOnly: true - survey_introduction_text: - title: Introduction Text + lithology_description: + title: Lithology description type: string + readOnly: true + lithology_observation: + title: Observations maxLength: 250 - survey_link: - title: Link type: string - maxLength: 100 - survey_page: - title: Page - type: string - enum: - - w - - r - - s - - a - WellList: + nullable: true + water_bearing_estimated_flow: + title: Water Bearing Estimated Flow + type: string + format: decimal + nullable: true + well_detail_v1: required: - - owner_full_name + - casing_set + - decommission_description_set + - drilling_methods + - linerperforation_set + - lithologydescription_set + - owner_full_name + - person_responsible + - screen_set + - well type: object properties: well_guid: @@ -1311,637 +1965,635 @@ components: 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 + type: integer + nullable: true owner_full_name: title: Owner Name - type: string maxLength: 200 + minLength: 1 + type: string well_class: - title: Well Class + title: Well class type: string + readOnly: true well_subclass: - title: Well Subclass + title: Well subclass type: string - format: uuid + readOnly: true intended_water_use: - title: Intended Water Use + title: Intended water use type: string + readOnly: true well_status: - title: Well Status + title: Well status type: string + readOnly: true + well_publication_status: + title: Well publication status + type: string + readOnly: true licenced_status: - title: Licenced Status + title: Licenced status type: string + readOnly: true street_address: title: Street Address - type: string maxLength: 100 + type: string + nullable: true city: title: Town/City - type: string maxLength: 50 + type: string + nullable: true legal_lot: title: Lot - type: string maxLength: 10 + type: string + nullable: true legal_plan: title: Plan - type: string maxLength: 20 + type: string + nullable: true legal_district_lot: title: District Lot - type: string maxLength: 20 + type: string + nullable: true legal_block: title: Block - type: string maxLength: 10 + type: string + nullable: true legal_section: title: Section - type: string maxLength: 10 + type: string + nullable: true legal_township: title: Township - type: string maxLength: 20 + type: string + nullable: true legal_range: title: Range - type: string maxLength: 10 + type: string + nullable: true land_district: title: Land District type: string + nullable: true legal_pid: - title: Property Identification Description (PID) - type: integer - maximum: 2147483647 - minimum: 0 + title: Legal pid + type: string + readOnly: true well_location_description: title: Description of Well Location - type: string maxLength: 500 + type: string + nullable: true construction_start_date: title: Construction Start Date type: string format: date + nullable: true construction_end_date: title: Construction Date type: string format: date + nullable: true + alteration_start_date: + title: Alteration Start Date + type: string + format: date + nullable: true alteration_end_date: title: Alteration Date type: string format: date + nullable: true decommission_start_date: title: Decommission Start Date type: string format: date + nullable: true decommission_end_date: title: Decommission Date type: string format: date + nullable: true + person_responsible: + $ref: '#/components/schemas/PersonName' + driller_name: + title: Name of Person Who Did the Work + maxLength: 200 + type: string + nullable: true drilling_company: - title: Drilling Company + title: Drilling company type: string - format: uuid + readOnly: true + company_of_person_responsible: + title: Company of person responsible + type: string + readOnly: true + consultant_name: + title: Consultant Name + maxLength: 200 + type: string + nullable: true + consultant_company: + title: Consultant Company + maxLength: 200 + type: string + nullable: true well_identification_plate_attached: title: Well Identification Plate Is Attached - type: string maxLength: 500 + type: string + nullable: true id_plate_attached_by: title: Well identification plate attached by - type: string maxLength: 100 + type: string + nullable: true water_supply_system_name: title: Water Supply System Name - type: string maxLength: 80 + type: string + nullable: true water_supply_system_well_name: title: Water Supply System Well Name - type: string maxLength: 80 + type: string + nullable: true latitude: title: Latitude type: string - format: decimal + readOnly: true longitude: title: Longitude type: string - format: decimal + readOnly: true coordinate_acquisition_code: - title: Location Accuracy Code + title: Coordinate acquisition code type: string + readOnly: true ground_elevation: title: Ground Elevation type: string format: decimal + nullable: true ground_elevation_method: - title: Elevation Determined By + title: Ground elevation method type: string - drilling_method: - title: Drilling Method - type: string - other_drilling_method: - title: Specify Other Drilling Method + readOnly: true + drilling_methods: + type: array + items: + $ref: '#/components/schemas/DrillingMethodSummary' + well_orientation_status: + title: Well Orientation Code type: string - maxLength: 50 - well_orientation: - title: Orientation of Well - type: boolean - enum: - - true - - false + nullable: true surface_seal_material: - title: Surface Seal Material - type: string - surface_seal_length: - title: Surface Seal Length + title: Surface seal material type: string - format: decimal + readOnly: true surface_seal_thickness: title: Surface Seal Thickness type: string format: decimal + nullable: true surface_seal_method: - title: Surface Seal Installation Method + title: Surface seal method type: string + readOnly: true surface_seal_depth: title: Surface Seal Depth type: string format: decimal + nullable: true backfill_type: title: Backfill Material Above Surface Seal - type: string maxLength: 250 + type: string + nullable: true backfill_depth: title: Backfill Depth type: string format: decimal + nullable: true liner_material: - title: Liner Material + title: Liner material type: string + readOnly: true liner_diameter: title: Liner Diameter type: string format: decimal + nullable: true liner_thickness: title: Liner Thickness type: string format: decimal + nullable: true liner_from: title: Liner From type: string format: decimal + nullable: true liner_to: title: Liner To type: string format: decimal + nullable: true screen_intake_method: - title: Intake Method + title: Screen intake method type: string + readOnly: true screen_type: - title: Type + title: Screen type type: string + readOnly: true screen_material: - title: Material + title: Screen material type: string + readOnly: true other_screen_material: title: Specify Other Screen Material - type: string maxLength: 50 + type: string + nullable: true screen_opening: - title: Opening + title: Screen opening type: string + readOnly: true screen_bottom: - title: Bottom + title: Screen bottom type: string + readOnly: true other_screen_bottom: title: Specify Other Screen Bottom - type: string maxLength: 50 + type: string + nullable: true screen_information: title: Screen Information - type: string maxLength: 300 + type: string + nullable: true filter_pack_from: title: Filter Pack From type: string format: decimal + nullable: true filter_pack_to: title: Filter Pack To type: string format: decimal + nullable: true filter_pack_thickness: title: Filter Pack Thickness type: string format: decimal + nullable: true filter_pack_material: title: Filter Pack Material type: string + nullable: true filter_pack_material_size: title: Filter Pack Material Size type: string - development_method: - title: Developed By - type: string + nullable: true + development_methods: + uniqueItems: true + type: array + items: + title: Development Methods + type: string development_hours: title: Development Total Duration type: string format: decimal + nullable: true 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 + nullable: true water_quality_characteristics: + uniqueItems: true type: array items: title: Obvious Water Quality Characteristics type: string - uniqueItems: true water_quality_colour: title: Water Quality Colour - type: string maxLength: 60 + type: string + nullable: true water_quality_odour: title: Water Quality Odour - type: string maxLength: 60 + type: string + nullable: true total_depth_drilled: title: Total Depth Drilled type: string format: decimal + nullable: true finished_well_depth: title: Finished Well Depth type: string format: decimal + nullable: true final_casing_stick_up: title: Final Casing Stick Up type: string format: decimal + nullable: true bedrock_depth: title: Depth to Bedrock type: string format: decimal + nullable: true static_water_level: title: Static Water Level (BTOC) type: string format: decimal + nullable: true well_yield: title: Estimated Well Yield type: string format: decimal + nullable: true artesian_flow: title: Artesian Flow type: string format: decimal + nullable: true artesian_pressure: title: Artesian Pressure type: string format: decimal + nullable: true + artesian_pressure_head: + title: Artesian Pressure head + type: string + format: decimal + nullable: true + artesian_conditions: + title: Artesian Conditions + type: boolean well_cap_type: title: Well Cap - type: string maxLength: 40 - well_disinfected: - title: Well Disinfected - type: boolean - enum: - - false - - true + type: string + nullable: true + well_disinfected_status: + title: Well Disinfected Code + type: string + nullable: true comments: title: Comments - type: string maxLength: 3000 + type: string + nullable: true alternative_specs_submitted: - title: Alternative specs submitted (if required) - type: boolean - enum: - - false - - true + title: Alternative specs submitted + type: string + readOnly: true + well_yield_unit: + title: Well yield unit + type: string + nullable: true diameter: title: Diameter - type: string maxLength: 9 + type: string observation_well_number: title: Observation Well Number - type: string maxLength: 30 + type: string + nullable: true observation_well_status: title: Observation Well Status type: string + nullable: true ems: title: Environmental Monitoring System (EMS) ID - type: string maxLength: 10 + type: string + nullable: true aquifer: title: Aquifer ID Number type: integer + nullable: true utm_zone_code: title: Zone - type: string maxLength: 10 + type: string + nullable: true utm_northing: title: UTM Northing - type: integer maximum: 2147483647 minimum: -2147483648 + type: integer + nullable: true utm_easting: title: UTM Easting - type: integer maximum: 2147483647 minimum: -2147483648 + type: integer + nullable: true bcgs_id: title: BCGS Mapsheet Number type: integer + nullable: true decommission_reason: title: Reason for Decommission - type: string maxLength: 250 + type: string + nullable: true decommission_method: title: Method of Decommission type: string - sealant_material: - title: Sealant Material - type: string + nullable: true + decommission_sealant_material: + title: Decommission Sealant Material maxLength: 100 - backfill_material: - title: Backfill Material type: string + nullable: true + decommission_backfill_material: + title: Decommission Backfill Material maxLength: 100 + type: string + nullable: true decommission_details: title: Decommission Details - type: string maxLength: 250 + type: string + nullable: true aquifer_vulnerability_index: title: AVI type: string format: decimal + nullable: true + aquifer_lithology: + title: Aquifer Lithology + type: string + nullable: true storativity: title: Storativity type: string format: decimal + nullable: true transmissivity: title: Transmissivity type: string format: decimal + nullable: true hydraulic_conductivity: title: Hydraulic Conductivity - type: string maxLength: 100 + type: string + nullable: true specific_storage: title: Specific Storage - type: string maxLength: 100 + type: string + nullable: true specific_yield: title: Specific Yield type: string format: decimal + nullable: true testing_method: title: Testing Method - type: string maxLength: 100 + type: string + nullable: true 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 + minimum: 0 + type: integer + nullable: true + analytic_solution_type: + title: Analytic Solution Type type: string format: decimal - internal_diameter: - title: Diameter + nullable: true + boundary_effect: + title: Boundary Effect type: string - format: decimal - assembly_type: - title: Assembly type + nullable: true + yield_estimation_method: + title: Estimation Method type: string - slot_size: - title: Slot Size + nullable: true + yield_estimation_rate: + title: Estimation Rate type: string format: decimal - LinerPerforation: - required: - - start - - end - type: object - properties: - start: - title: Perforated From + nullable: true + yield_estimation_duration: + title: Estimation Duration type: string format: decimal - end: - title: Perforated To + nullable: true + static_level_before_test: + title: SWL Before Test type: string format: decimal - DecommissionDescription: - required: - - start - - end - - material - type: object - properties: - start: - title: Decommissioned From + nullable: true + drawdown: + title: Drawdown type: string format: decimal - end: - title: Decommissioned To + nullable: true + hydro_fracturing_performed: + title: Hydro-fracturing Performed? + type: boolean + hydro_fracturing_yield_increase: + title: Well Yield Increase Due to Hydro-fracturing type: string format: decimal - material: - title: Material - type: string - observations: - title: Observations - type: string - maxLength: 255 - LithologyDescription: - type: object - properties: - lithology_from: - title: From + nullable: true + recommended_pump_depth: + title: Recommended pump depth type: string format: decimal - lithology_to: - title: To + nullable: true + recommended_pump_rate: + title: Recommended pump rate type: string format: decimal - lithology_raw_data: - title: Raw Data - type: string - maxLength: 250 - lithology_colour: - title: Colour - type: string - lithology_hardness: - title: Hardness + nullable: true + casing_set: + type: array + items: + $ref: '#/components/schemas/CasingSummary' + 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/LithologyDescriptionSummary' + submission_work_dates: + title: Submission work dates type: string - lithology_moisture: - title: Moisture + readOnly: true + is_published: + title: Is published type: string - water_bearing_estimated_flow: - title: Water Bearing Estimated Flow + readOnly: true + DevelopmentMethodsSummary: + required: + - description + type: object + properties: + description: + title: Description + maxLength: 100 + minLength: 1 type: string - format: decimal - WellDetail: + well_detail_v2: required: - - well - - owner_full_name - - person_responsible - - company_of_person_responsible - - casing_set - - screen_set - - linerperforation_set - - decommission_description_set - - lithologydescription_set + - casing_set + - decommission_description_set + - development_methods + - drilling_methods + - linerperforation_set + - lithologydescription_set + - owner_full_name + - person_responsible + - screen_set + - well type: object properties: well_guid: @@ -1958,471 +2610,604 @@ components: readOnly: true identification_plate_number: title: Well Identification Plate Number - type: integer maximum: 2147483647 minimum: 0 + type: integer + nullable: true owner_full_name: title: Owner Name - type: string maxLength: 200 + minLength: 1 + type: string well_class: - title: Well Class + title: Well class type: string + readOnly: true well_subclass: - title: Well Subclass + title: Well subclass type: string - format: uuid + readOnly: true intended_water_use: - title: Intended Water Use + title: Intended water use type: string + readOnly: true well_status: - title: Well Status + title: Well status type: string + readOnly: true + well_publication_status: + title: Well publication status + type: string + readOnly: true licenced_status: - title: Licenced Status + title: Licenced status type: string + readOnly: true street_address: title: Street Address - type: string maxLength: 100 + type: string + nullable: true city: title: Town/City - type: string maxLength: 50 + type: string + nullable: true legal_lot: title: Lot - type: string maxLength: 10 + type: string + nullable: true legal_plan: title: Plan - type: string maxLength: 20 + type: string + nullable: true legal_district_lot: title: District Lot - type: string maxLength: 20 + type: string + nullable: true legal_block: title: Block - type: string maxLength: 10 + type: string + nullable: true legal_section: title: Section - type: string maxLength: 10 + type: string + nullable: true legal_township: title: Township - type: string maxLength: 20 + type: string + nullable: true legal_range: title: Range - type: string maxLength: 10 + type: string + nullable: true land_district: title: Land District type: string + nullable: true legal_pid: - title: Property Identification Description (PID) - type: integer - maximum: 2147483647 - minimum: 0 + title: Legal pid + type: string + readOnly: true well_location_description: title: Description of Well Location - type: string maxLength: 500 + type: string + nullable: true construction_start_date: title: Construction Start Date type: string format: date + nullable: true construction_end_date: title: Construction Date type: string format: date + nullable: true + alteration_start_date: + title: Alteration Start Date + type: string + format: date + nullable: true alteration_end_date: title: Alteration Date type: string format: date + nullable: true decommission_start_date: title: Decommission Start Date type: string format: date + nullable: true decommission_end_date: title: Decommission Date type: string format: date + nullable: true person_responsible: - $ref: "#/components/schemas/PersonBasic" - company_of_person_responsible: - $ref: "#/components/schemas/OrganizationNameList" + $ref: '#/components/schemas/PersonName' + driller_name: + title: Name of Person Who Did the Work + maxLength: 200 + type: string + nullable: true drilling_company: - title: Drilling Company + title: Drilling company type: string - format: uuid + readOnly: true + company_of_person_responsible: + title: Company of person responsible + type: string + readOnly: true + consultant_name: + title: Consultant Name + maxLength: 200 + type: string + nullable: true + consultant_company: + title: Consultant Company + maxLength: 200 + type: string + nullable: true well_identification_plate_attached: title: Well Identification Plate Is Attached - type: string maxLength: 500 + type: string + nullable: true id_plate_attached_by: title: Well identification plate attached by - type: string maxLength: 100 + type: string + nullable: true water_supply_system_name: title: Water Supply System Name - type: string maxLength: 80 + type: string + nullable: true water_supply_system_well_name: title: Water Supply System Well Name - type: string maxLength: 80 + type: string + nullable: true latitude: title: Latitude type: string - format: decimal + readOnly: true longitude: title: Longitude type: string - format: decimal + readOnly: true coordinate_acquisition_code: - title: Location Accuracy Code + title: Coordinate acquisition code type: string + readOnly: true ground_elevation: title: Ground Elevation type: string format: decimal + nullable: true ground_elevation_method: - title: Elevation Determined By + title: Ground elevation method type: string - drilling_method: - title: Drilling Method - type: string - other_drilling_method: - title: Specify Other Drilling Method + readOnly: true + drilling_methods: + type: array + items: + $ref: '#/components/schemas/DrillingMethodSummary' + well_orientation_status: + title: Well Orientation Code type: string - maxLength: 50 - well_orientation: - title: Orientation of Well - type: boolean - enum: - - true - - false + nullable: true surface_seal_material: - title: Surface Seal Material - type: string - surface_seal_length: - title: Surface Seal Length + title: Surface seal material type: string - format: decimal + readOnly: true surface_seal_thickness: title: Surface Seal Thickness type: string format: decimal + nullable: true surface_seal_method: - title: Surface Seal Installation Method + title: Surface seal method type: string + readOnly: true surface_seal_depth: title: Surface Seal Depth type: string format: decimal + nullable: true backfill_type: title: Backfill Material Above Surface Seal - type: string maxLength: 250 + type: string + nullable: true backfill_depth: title: Backfill Depth type: string format: decimal + nullable: true liner_material: - title: Liner Material + title: Liner material type: string + readOnly: true liner_diameter: title: Liner Diameter type: string format: decimal + nullable: true liner_thickness: title: Liner Thickness type: string format: decimal + nullable: true liner_from: title: Liner From type: string format: decimal + nullable: true liner_to: title: Liner To type: string format: decimal + nullable: true screen_intake_method: - title: Intake Method + title: Screen intake method type: string + readOnly: true screen_type: - title: Type + title: Screen type type: string + readOnly: true screen_material: - title: Material + title: Screen material type: string + readOnly: true other_screen_material: title: Specify Other Screen Material - type: string maxLength: 50 + type: string + nullable: true screen_opening: - title: Opening + title: Screen opening type: string + readOnly: true screen_bottom: - title: Bottom + title: Screen bottom type: string + readOnly: true other_screen_bottom: title: Specify Other Screen Bottom - type: string maxLength: 50 + type: string + nullable: true screen_information: title: Screen Information - type: string maxLength: 300 + type: string + nullable: true filter_pack_from: title: Filter Pack From type: string format: decimal + nullable: true filter_pack_to: title: Filter Pack To type: string format: decimal + nullable: true filter_pack_thickness: title: Filter Pack Thickness type: string format: decimal + nullable: true filter_pack_material: title: Filter Pack Material type: string + nullable: true filter_pack_material_size: title: Filter Pack Material Size type: string - development_method: - title: Developed By - type: string + nullable: true + development_methods: + type: array + items: + $ref: '#/components/schemas/DevelopmentMethodsSummary' development_hours: title: Development Total Duration type: string format: decimal + nullable: true development_notes: title: Development Notes - type: string maxLength: 255 + type: string + nullable: true water_quality_characteristics: + uniqueItems: true type: array items: title: Obvious Water Quality Characteristics type: string - uniqueItems: true water_quality_colour: title: Water Quality Colour - type: string maxLength: 60 + type: string + nullable: true water_quality_odour: title: Water Quality Odour - type: string maxLength: 60 + type: string + nullable: true total_depth_drilled: title: Total Depth Drilled type: string format: decimal + nullable: true finished_well_depth: title: Finished Well Depth type: string format: decimal + nullable: true final_casing_stick_up: title: Final Casing Stick Up type: string format: decimal + nullable: true bedrock_depth: title: Depth to Bedrock type: string format: decimal + nullable: true static_water_level: title: Static Water Level (BTOC) type: string format: decimal + nullable: true well_yield: title: Estimated Well Yield type: string format: decimal + nullable: true artesian_flow: title: Artesian Flow type: string format: decimal + nullable: true artesian_pressure: title: Artesian Pressure type: string format: decimal + nullable: true + artesian_pressure_head: + title: Artesian Pressure head + type: string + format: decimal + nullable: true + artesian_conditions: + title: Artesian Conditions + type: boolean well_cap_type: title: Well Cap - type: string maxLength: 40 - well_disinfected: - title: Well Disinfected - type: boolean - enum: - - false - - true + type: string + nullable: true + well_disinfected_status: + title: Well Disinfected Code + type: string + nullable: true comments: title: Comments - type: string maxLength: 3000 + type: string + nullable: true alternative_specs_submitted: - title: Alternative specs submitted (if required) - type: boolean - enum: - - false - - true + title: Alternative specs submitted + type: string + readOnly: true well_yield_unit: title: Well yield unit type: string + nullable: true diameter: title: Diameter - type: string maxLength: 9 + type: string observation_well_number: title: Observation Well Number - type: string maxLength: 30 + type: string + nullable: true observation_well_status: title: Observation Well Status type: string + nullable: true ems: title: Environmental Monitoring System (EMS) ID - type: string maxLength: 10 + type: string + nullable: true aquifer: title: Aquifer ID Number type: integer + nullable: true utm_zone_code: title: Zone - type: string maxLength: 10 + type: string + nullable: true utm_northing: title: UTM Northing - type: integer maximum: 2147483647 minimum: -2147483648 + type: integer + nullable: true utm_easting: title: UTM Easting - type: integer maximum: 2147483647 minimum: -2147483648 + type: integer + nullable: true bcgs_id: title: BCGS Mapsheet Number type: integer + nullable: true decommission_reason: title: Reason for Decommission - type: string maxLength: 250 + type: string + nullable: true decommission_method: title: Method of Decommission type: string - sealant_material: - title: Sealant Material - type: string + nullable: true + decommission_sealant_material: + title: Decommission Sealant Material maxLength: 100 - backfill_material: - title: Backfill Material type: string + nullable: true + decommission_backfill_material: + title: Decommission Backfill Material maxLength: 100 + type: string + nullable: true decommission_details: title: Decommission Details - type: string maxLength: 250 + type: string + nullable: true aquifer_vulnerability_index: title: AVI type: string format: decimal + nullable: true + aquifer_lithology: + title: Aquifer Lithology + type: string + nullable: true storativity: title: Storativity type: string format: decimal + nullable: true transmissivity: title: Transmissivity type: string format: decimal + nullable: true hydraulic_conductivity: title: Hydraulic Conductivity - type: string maxLength: 100 + type: string + nullable: true specific_storage: title: Specific Storage - type: string maxLength: 100 + type: string + nullable: true specific_yield: title: Specific Yield type: string format: decimal + nullable: true testing_method: title: Testing Method - type: string maxLength: 100 + type: string + nullable: true testing_duration: title: Testing duration - type: integer maximum: 2147483647 minimum: 0 + type: integer + nullable: true analytic_solution_type: title: Analytic Solution Type type: string format: decimal + nullable: true boundary_effect: title: Boundary Effect type: string - format: decimal + nullable: true yield_estimation_method: - title: Estimation Method + title: Yield estimation method type: string + readOnly: true yield_estimation_rate: title: Estimation Rate type: string format: decimal + nullable: true yield_estimation_duration: title: Estimation Duration type: string format: decimal + nullable: true static_level_before_test: title: SWL Before Test type: string format: decimal + nullable: true drawdown: title: Drawdown type: string format: decimal + nullable: true 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 + nullable: true recommended_pump_depth: title: Recommended pump depth type: string format: decimal + nullable: true recommended_pump_rate: title: Recommended pump rate type: string format: decimal + nullable: true casing_set: type: array items: - $ref: "#/components/schemas/Casing" + $ref: '#/components/schemas/CasingSummary' screen_set: type: array items: - $ref: "#/components/schemas/Screen" + $ref: '#/components/schemas/Screen' linerperforation_set: type: array items: - $ref: "#/components/schemas/LinerPerforation" + $ref: '#/components/schemas/LinerPerforation' decommission_description_set: type: array items: - $ref: "#/components/schemas/DecommissionDescription" + $ref: '#/components/schemas/DecommissionDescription' lithologydescription_set: type: array items: - $ref: "#/components/schemas/LithologyDescription" + $ref: '#/components/schemas/LithologyDescriptionSummary' + submission_work_dates: + title: Submission work dates + type: string + readOnly: true + is_published: + title: Is published + type: string + readOnly: true + securitySchemes: + Bearer: + type: apiKey + name: JWT + in: header