{ "openapi": "3.0.4", "info": { "description": "GreaseBook - Public Api", "version": "v1" }, "paths": { "/api/v1/assets/show": { "get": { "tags": [ "Assets" ], "summary": "Get Company Assets", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyAssetsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyAssetsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyAssetsDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries": { "post": { "tags": [ "Batteries" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatteryItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatteryItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatteryItemDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Batteries" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBatteryRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatteryItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatteryItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatteryItemDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Batteries" ], "parameters": [ { "name": "apiKey", "in": "query", "schema": { "type": "string" } }, { "name": "includeWells", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries/daily-production": { "get": { "tags": [ "Batteries" ], "summary": "Get daily production for batteries (oil, oil sales, oil stock, water and gas in mcf)", "description": "**Rate limit:** 500 requests per minute. For accounts with request-limit enabled,\nthis endpoint is restricted to **1 request per 24 hours** per unique batteryId.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "batteryId", "in": "query", "description": "optional to find just 1 battery", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDailyProductionDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDailyProductionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDailyProductionDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries/measurements": { "get": { "tags": [ "Batteries" ], "summary": "Get battery measurements", "description": "**Rate limit:** 500 requests per minute. For accounts with request-limit enabled,\nthis endpoint is restricted to **1 request per 24 hours** per unique batteryId.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "batteryId", "in": "query", "description": "optional to find just 1 battery", "schema": { "type": "integer", "format": "int32" } }, { "name": "showDynamics", "in": "query", "description": "show custom variables", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryMeasurementDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryMeasurementDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryMeasurementDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries/{batteryId}/measurements": { "post": { "tags": [ "Batteries" ], "summary": "Push battery measurements.\nDate should be in MM/dd/yyyy format and in the battery time zone.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "batteryId", "in": "path", "description": "battery id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "measurement", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries/production/{batteryId}/oil": { "post": { "tags": [ "Batteries" ], "summary": "Upload oil daily production for a battery and a given tank.\nDate should be in MM/dd/yyyy format and in the battery time zone.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "batteryId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BatteryDailyTankProductionInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatteryDailyTankProductionInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatteryDailyTankProductionInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatteryDailyTankProductionInput" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries/production/{batteryId}/water": { "post": { "tags": [ "Batteries" ], "summary": "Upload water daily for a battery and a given water tank.\nDate should be in MM/dd/yyyy format and in the battery time zone.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "batteryId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BatteryDailyWaterProductionInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatteryDailyWaterProductionInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatteryDailyWaterProductionInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatteryDailyWaterProductionInput" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries/production/{batteryId}/gas": { "post": { "tags": [ "Batteries" ], "summary": "Upload battery daily gas production.\nDate should be in MM/dd/yyyy format and in the battery time zone.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "batteryId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BatteryDailyGasProductionInput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatteryDailyGasProductionInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatteryDailyGasProductionInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatteryDailyGasProductionInput" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/batteries/measurements/dynamic-variables": { "put": { "tags": [ "Batteries" ], "parameters": [ { "name": "apiKey", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDynamicsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDynamicsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDynamicsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PushBatteryMeasurementDynamicsDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/comments/read": { "get": { "tags": [ "Comments" ], "summary": "Get Batteries comments", "description": "**Rate limit:** 500 requests per minute. For accounts with request-limit enabled,\nthis endpoint is restricted to **1 request per 24 hours** per unique batteryId.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "batteryId", "in": "query", "description": "optional battery", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "default is 50, up to 250 comments at the time", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "date", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/comments": { "post": { "tags": [ "Comments" ], "summary": "Create a new comment on a battery.\nDate format: MM/dd/yyyy\nTime format: HH:mm\nThe specified date should be in the battery time zone.", "description": "**Rate limit:** 500 requests per minute.", "requestBody": { "description": "Comment payload", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } } } }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/downtime-reasons": { "post": { "tags": [ "DowntimeReasons" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDowntimeReasonRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDowntimeReasonRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDowntimeReasonRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDowntimeReasonRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/gas-meters": { "post": { "tags": [ "GasMeters" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "GasMeters" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "batteryName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGasMeterRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/gas-meters/measurements": { "get": { "tags": [ "GasMeters" ], "summary": "Get gas meter measurements", "description": "**Rate limit:** 500 requests per minute. For accounts with request-limit enabled,\nthis endpoint is restricted to **1 request per 24 hours** per unique gasMeterId.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "gasMeterId", "in": "query", "description": "optional to find just 1 gas meter", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GasMeasurementDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GasMeasurementDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GasMeasurementDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/gas-meters/{gasMeterId}/measurements": { "post": { "tags": [ "GasMeters" ], "summary": "Push gas meter measurements.\nDate should be in MM/dd/yyyy format and in the battery time zone.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "Api Key", "schema": { "type": "string" } }, { "name": "gasMeterId", "in": "path", "description": "gas meter id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "measurement", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/gas-meters/bulk-measurements": { "post": { "tags": [ "GasMeters" ], "summary": "Bulk Import with an array of the same item of /{id}/measurements endpoint\nMax of 30 measurements at a single call\nSet detailedResponse=true to receive detailed results for each item and continue processing even if some fail.", "description": "Maximum 30 measurements per request. If more are provided, only the first 30 are processed.\n**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "detailedResponse", "in": "query", "description": "When true, returns detailed results and continues processing all items even if some fail", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PushGasMeterMeasurementDto" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/water-meters": { "post": { "tags": [ "InjectionWells" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "InjectionWells" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "batteryName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInjectionWellRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/water-meters/measurement": { "post": { "tags": [ "InjectionWells" ], "summary": "Upload Water Meter Measurement\nDate should be in MM/dd/yyyy format and in the battery time zone.\nComplete Injection Well Id or Battery Id and Injection Well Name.\nIf a meter reading field is sent with a valid value and the water bbls is null, the water bbls get calculated from\nthe previous meter reading automatically.\nIf the water bbls field is sent, it won't be calculated against the previous meter reading.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "measurement to edit or create new values,", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InjectionWellMeasurementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InjectionWellMeasurementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InjectionWellMeasurementDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InjectionWellMeasurementDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/water-meters/daily-measurements": { "get": { "tags": [ "InjectionWells" ], "summary": "Get daily water meter measurements for a given date.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InjectionWellMeasurementDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InjectionWellMeasurementDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InjectionWellMeasurementDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/lacts": { "post": { "tags": [ "Lacts" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLactRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLactRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLactRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLactRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/lacts/measurement": { "post": { "tags": [ "Lacts" ], "summary": "Upload Lact Measurement", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UploadLactMeasurementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadLactMeasurementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadLactMeasurementDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UploadLactMeasurementDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/pumpers": { "post": { "tags": [ "Pumpers" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Pumpers" ], "parameters": [ { "name": "username", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePumperRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/reports/generate/production-report": { "post": { "tags": [ "Reports" ], "summary": "Generate any report", "description": "**Rate limit:** 5 requests per minute.", "parameters": [ { "name": "useHtml", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportParameters" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/tanks": { "post": { "tags": [ "Tanks" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Tanks" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "batteryName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTankRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/tanks/gauge": { "post": { "tags": [ "Tanks" ], "summary": "Upload Tank Measurements\nGauges are in inches.\nTo Identify a tank provide\nA - Tank GreaseBook Id\nB - Battery Gsb Id + Tank Gsb Name\nC - Tank Number completed in Gsb\nDate Format: MM/dd/yyyy\nTime Format: HH:mm\nThe specified date should be in the battery time zone", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/tanks/gauge/bulk": { "post": { "tags": [ "Tanks" ], "summary": "Upload Many Tank Measurements\nGauges are in inches.\nTo Identify a tank provide\nA - Tank GreaseBook Id\nB - Battery Gsb Id + Tank Gsb Name\nC - Tank Number completed in Gsb\nDate Format: MM/dd/yyyy\nTime Format: HH:mm\nThe specified date should be in the battery time zone\nSet detailedResponse=true to receive detailed results for each item and continue processing even if some fail.", "description": "Maximum 500 items per request.\n**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "detailedResponse", "in": "query", "description": "When true, returns detailed results and continues processing all items even if some fail", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadTankMeasurementDto" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/tanks/ticket": { "post": { "tags": [ "Tanks" ], "summary": "Upload Tank Ticket information\nDate should be in MM/dd/yyyy format.\nTime should be in HH:mm format.\nIf no ticket type is specified sales will be the default.\nThe specified date should be in the battery time zone", "description": "**Rate limit:** 500 requests per minute.", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UploadTankTicketDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadTankTicketDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadTankTicketDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UploadTankTicketDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Tanks" ], "summary": "Get Tickets\nStart end difference can not be longer than 60 days.", "description": "**Rate limit:** 500 requests per minute. For accounts with request-limit enabled,\nthis endpoint is restricted to **1 request per 24 hours** per unique batteryId / tankId.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "batteryId", "in": "query", "description": "optional to find just 1 battery", "schema": { "type": "integer", "format": "int32" } }, { "name": "tankId", "in": "query", "description": "optional to find just 1 tank", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TankTicket" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TankTicket" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TankTicket" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/tanks/gauges": { "get": { "tags": [ "Tanks" ], "summary": "Get Tank gauges, last gauge daily for tank,\nStart end difference can not be longer than 60 days.", "description": "**Rate limit:** 500 requests per minute. For accounts with request-limit enabled,\nthis endpoint is restricted to **1 request per 24 hours** per unique batteryId / tankId.", "parameters": [ { "name": "apiKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "batteryId", "in": "query", "description": "optional to find just 1 battery", "schema": { "type": "integer", "format": "int32" } }, { "name": "tankId", "in": "query", "description": "optional to find just 1 tank", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TankGauge" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TankGauge" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TankGauge" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/transport-companies": { "post": { "tags": [ "TransportCompanies" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PurchaserDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PurchaserDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaserDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "TransportCompanies" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTransportCompanyRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/users": { "post": { "tags": [ "Users" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Users" ], "parameters": [ { "name": "username", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/users/lookup": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "username", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLookupResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/well-db/lookup": { "get": { "tags": [ "WellDb" ], "summary": "Look up a well from the WellDB table by API number or by Well Name + County + State.\nReturns a best-guess match only when confidence is at least 95%.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "API key for authentication.", "schema": { "type": "string" } }, { "name": "apiNumber", "in": "query", "description": "API number (e.g. 42-123-12345-00-00). Use this OR wellName+county+state.", "schema": { "type": "string" } }, { "name": "wellName", "in": "query", "description": "Well name. Required when not using apiNumber.", "schema": { "type": "string" } }, { "name": "county", "in": "query", "description": "County. Required with wellName and state.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "State (e.g. TX). Required with wellName and county.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WellDbLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WellDbLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WellDbLookupResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/wells": { "post": { "tags": [ "Wells" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Wells" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "batteryName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWellRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/wells/allocation": { "get": { "tags": [ "Wells" ], "summary": "Get Daily Allocations Fields ( GAS, WATER, OIL, WellName, WellAPINumber)", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "Api Key", "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "from when get allocations", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "to when get allocation", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellAllocationDayDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellAllocationDayDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellAllocationDayDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/wells/{wellId}/tests": { "post": { "tags": [ "Wells" ], "summary": "Upload a new well test.\nDate should be in MM/dd/yyyy format and in the battery time zone.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "Api Key", "schema": { "type": "string" } }, { "name": "wellId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WellTestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WellTestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WellTestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WellTestDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/wells/{wellId}/measurements": { "post": { "tags": [ "Wells" ], "summary": "Upload a new well measurement.\nDate should be in the format MM/dd/yyyy and in the battery time zone.\nTime should be in the format HH:mm. If the value is NULL it defaults to 07:00 AM", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "Api Key", "schema": { "type": "string" } }, { "name": "wellId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WellMeasurementDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WellMeasurementDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WellMeasurementDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WellMeasurementDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Wells" ], "summary": "Get Well measurements", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "Api Key", "schema": { "type": "string" } }, { "name": "wellId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "where to start pulling data", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "until when pull data", "schema": { "type": "string", "format": "date-time" } }, { "name": "showDynamics", "in": "query", "description": "if show custom variables default: false", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellMeasurementDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellMeasurementDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WellMeasurementDto" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/wells/{wellId}/downtime": { "post": { "tags": [ "Wells" ], "summary": "Upload a new well downtime.\nDate should be in the format MM/dd/yyyy and in the battery time zone.\nTime should be in the format HH:mm. If the value is NULL it defaults to 07:00 AM.\nWe only allow a downtime per day send by API so if you send info for a downtime and there is already one with start\nfor the same date it will be updated with the new info.\nUnitType\nDays = 1, (Default)\nHours = 2,\nMinutes = 3,\nSeconds = 4.\nThere is 3 different downtimes scenario supported, if this doesn't fit what you are trying to push please contact\nwith support.\n1) Send a downtime with start date/time - end date/time in this case please ignore units and units type,\n2) Send a downtime with start date/time - units and unit type, in this case, the system will calculate the end\ndate/time based on the units and unit type.\n3) Send a downtime with start date/time and leave unit type, units, end date/time empty, in this case, the system\nwill leave the downtime open until further notice.", "description": "**Rate limit:** 500 requests per minute.", "parameters": [ { "name": "apiKey", "in": "query", "description": "Api Key", "schema": { "type": "string" } }, { "name": "wellId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WellDowntimeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WellDowntimeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WellDowntimeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WellDowntimeDto" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "AggregateType": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "AssetBatteryItemDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "latitude": { "type": "number", "format": "float", "nullable": true }, "county": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatteryAssignmentType": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "BatteryDailyGasProductionInput": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32" }, "volume": { "type": "number", "format": "float" }, "checkMeter": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "BatteryDailyProductionDto": { "type": "object", "properties": { "batteryId": { "type": "integer", "format": "int32" }, "batteryName": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "oil": { "type": "number", "format": "double", "nullable": true }, "oilSales": { "type": "number", "format": "double", "nullable": true }, "oilStock": { "type": "number", "format": "double", "nullable": true }, "water": { "type": "number", "format": "double", "nullable": true }, "mcf": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "BatteryDailyTankProductionInput": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32" }, "tankId": { "type": "integer", "format": "int32", "nullable": true }, "tankName": { "type": "string", "nullable": true }, "volume": { "type": "number", "format": "float" } }, "additionalProperties": false }, "BatteryDailyWaterProductionInput": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32" }, "tankId": { "type": "integer", "format": "int32", "nullable": true }, "tankName": { "type": "string", "nullable": true }, "volume": { "type": "number", "format": "float" }, "waterMeterId": { "type": "integer", "format": "int32", "nullable": true }, "waterMeterName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatteryDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "leaseNumber": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true }, "engineeringIdentifier": { "type": "string", "nullable": true }, "wells": { "type": "array", "items": { "$ref": "#/components/schemas/WellDto" }, "nullable": true } }, "additionalProperties": false }, "BatteryItemDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "timeZone": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "nullable": true }, "batteryType": { "$ref": "#/components/schemas/BatteryType" }, "batteryAllocationType": { "$ref": "#/components/schemas/BatteryAssignmentType" }, "displayWellsInNavigation": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "displayTotalFluids": { "type": "boolean", "nullable": true }, "wellOperationalStatus": { "$ref": "#/components/schemas/WellOperationalStatus" }, "useCumulativeMode": { "type": "boolean" }, "displaySalesMeter": { "type": "boolean" }, "gasFlow": { "$ref": "#/components/schemas/ProductionFlow" }, "waterFlow": { "$ref": "#/components/schemas/ProductionFlow" }, "oilFlow": { "$ref": "#/components/schemas/ProductionFlow" }, "collectionPointId": { "type": "integer", "format": "int32", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "latitude": { "type": "number", "format": "float", "nullable": true }, "rangeArea": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BatteryMeasurementDto": { "type": "object", "properties": { "batteryName": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "differential": { "type": "number", "format": "float", "nullable": true }, "separator": { "type": "number", "format": "float", "nullable": true }, "heater": { "type": "number", "format": "float", "nullable": true }, "orificeSize": { "type": "number", "format": "float", "nullable": true }, "dynamicVariables": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicValueDto" }, "nullable": true } }, "additionalProperties": false }, "BatteryType": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "CompanyAssetDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "tanks": { "type": "array", "items": { "$ref": "#/components/schemas/AssetBatteryItemDto" }, "nullable": true }, "wells": { "type": "array", "items": { "$ref": "#/components/schemas/AssetBatteryItemDto" }, "nullable": true }, "injectionWells": { "type": "array", "items": { "$ref": "#/components/schemas/AssetBatteryItemDto" }, "nullable": true }, "gasMeters": { "type": "array", "items": { "$ref": "#/components/schemas/AssetBatteryItemDto" }, "nullable": true } }, "additionalProperties": false }, "CompanyAssetsDto": { "type": "object", "properties": { "batteries": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyAssetDto" }, "nullable": true } }, "additionalProperties": false }, "CreateBatteryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true }, "state": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "leaseName": { "type": "string", "nullable": true }, "leaseNumber": { "type": "string", "nullable": true }, "engineeringIdentifier": { "type": "string", "nullable": true }, "etcIdentifier": { "type": "string", "nullable": true }, "dcpIdentifier": { "type": "string", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "latitude": { "type": "number", "format": "float", "nullable": true }, "rangeArea": { "type": "integer", "format": "int32", "nullable": true }, "grossWorkingInterest": { "type": "number", "format": "float", "nullable": true }, "netRevenueInterest": { "type": "number", "format": "float", "nullable": true }, "batteryType": { "$ref": "#/components/schemas/BatteryType" }, "gasCollectionType": { "$ref": "#/components/schemas/GasCollectionType" }, "useCheckMeter": { "type": "boolean", "nullable": true }, "useCumulativeMode": { "type": "boolean", "nullable": true }, "overWriteSalesMeter": { "type": "boolean", "nullable": true }, "allowOilMeter": { "type": "boolean", "nullable": true }, "includeInReports": { "type": "boolean", "nullable": true }, "includeInTexasRccReport": { "type": "boolean", "nullable": true }, "displayWellsInNavigation": { "type": "boolean", "nullable": true }, "displaySalesMeter": { "type": "boolean", "nullable": true }, "enableSalesMeter": { "type": "boolean", "nullable": true }, "enableFacilityEquipment": { "type": "boolean", "nullable": true }, "displayTotalFluids": { "type": "boolean", "nullable": true }, "wellOperationalStatus": { "$ref": "#/components/schemas/WellOperationalStatus" }, "oilType": { "$ref": "#/components/schemas/OilType" }, "computeAsNegative": { "type": "boolean", "nullable": true }, "productionApplication": { "$ref": "#/components/schemas/ProductionApplication" }, "productionAggregate": { "$ref": "#/components/schemas/AggregateType" }, "contractHour": { "type": "string", "nullable": true }, "enableElasticOpsSync": { "type": "boolean", "nullable": true }, "importIdentifier": { "type": "string", "nullable": true }, "allocateGasFromWellCheckMeter": { "type": "boolean", "nullable": true }, "agreementIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCommentRequest": { "required": [ "batteryId", "comment", "date", "time" ], "type": "object", "properties": { "batteryId": { "type": "integer", "format": "int32" }, "comment": { "minLength": 1, "type": "string" }, "date": { "minLength": 1, "type": "string", "description": "Date in MM/dd/yyyy format" }, "time": { "minLength": 1, "type": "string", "description": "Time in HH:mm format" }, "wellId": { "type": "integer", "format": "int32", "nullable": true }, "injectionWellId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CreateDowntimeReasonRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateGasMeterRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "batteryName": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/GasMeterType" }, "isActive": { "type": "boolean", "nullable": true }, "isHidden": { "type": "boolean", "nullable": true }, "isCumulative": { "type": "boolean", "nullable": true }, "position": { "type": "integer", "format": "int32", "nullable": true }, "computeAsNegative": { "type": "boolean", "nullable": true }, "productionApplication": { "$ref": "#/components/schemas/ProductionApplication" }, "productionAggregate": { "$ref": "#/components/schemas/AggregateType" }, "rollupToBatteryId": { "type": "integer", "format": "int32", "nullable": true }, "rollupToGasMeterId": { "type": "integer", "format": "int32", "nullable": true }, "importIdentifier": { "type": "string", "nullable": true }, "allowSelectWellOnTest": { "type": "boolean", "nullable": true }, "enableCheckMeter": { "type": "boolean", "nullable": true }, "overwriteSalesMeter": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreateInjectionWellRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "batteryName": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/InjectionWellType" }, "isActive": { "type": "boolean", "nullable": true }, "uicPermitNumber": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "stateNumber": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "apiNumber": { "type": "string", "nullable": true }, "injectionWellIdentifier": { "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32", "nullable": true }, "useCumulativeMode": { "type": "boolean", "nullable": true }, "computeAsNegative": { "type": "boolean", "nullable": true }, "productionApplication": { "$ref": "#/components/schemas/ProductionApplication" }, "productionAggregate": { "$ref": "#/components/schemas/AggregateType" }, "latitude": { "type": "number", "format": "float", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "range": { "type": "integer", "format": "int32", "nullable": true }, "unit": { "$ref": "#/components/schemas/Volume" }, "rollupToInjectionWellId": { "type": "integer", "format": "int32", "nullable": true }, "approvedPacker": { "type": "number", "format": "float", "nullable": true }, "approvedTopInterval": { "type": "number", "format": "float", "nullable": true }, "approvedBottomInterval": { "type": "number", "format": "float", "nullable": true }, "rrcMaxWaterPressure": { "type": "number", "format": "float", "nullable": true }, "importIdentifier": { "type": "string", "nullable": true }, "allowSelectWellOnTest": { "type": "boolean", "nullable": true }, "agreementIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateLactRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "batteryName": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true }, "isHidden": { "type": "boolean", "nullable": true }, "isCumulative": { "type": "boolean", "nullable": true }, "position": { "type": "integer", "format": "int32", "nullable": true }, "productionApplication": { "$ref": "#/components/schemas/ProductionApplication" }, "productionAggregate": { "$ref": "#/components/schemas/AggregateType" }, "importIdentifier": { "type": "string", "nullable": true }, "computeAsNegative": { "type": "boolean", "nullable": true }, "allowSelectWellOnTest": { "type": "boolean", "nullable": true }, "ignoreAlerts": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreatePumperRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true }, "allowComments": { "type": "boolean", "nullable": true }, "allowViewAllReports": { "type": "boolean", "nullable": true }, "enableEmailNotifications": { "type": "boolean", "nullable": true }, "enableTagsEmailNotifications": { "type": "boolean", "nullable": true }, "enableSmsNotifications": { "type": "boolean", "nullable": true }, "enablePushNotifications": { "type": "boolean", "nullable": true }, "timeZone": { "type": "integer", "format": "int32", "nullable": true }, "readOnlyUser": { "type": "boolean", "nullable": true }, "hideDowntime": { "type": "boolean", "nullable": true }, "enableSpeedMode": { "type": "boolean", "nullable": true }, "displayOverview": { "type": "boolean", "nullable": true }, "batteryIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "batteryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CreateTankRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "batteryName": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "isDual": { "type": "boolean", "nullable": true }, "tankSupportedProduct": { "$ref": "#/components/schemas/TankSupportedProduct" }, "isEnabled": { "type": "boolean", "nullable": true }, "productionApplication": { "$ref": "#/components/schemas/ProductionApplication" }, "oilStockApplication": { "$ref": "#/components/schemas/StockApplication" }, "position": { "type": "integer", "format": "int32", "nullable": true }, "importIdentifier": { "type": "string", "nullable": true }, "straps": { "type": "array", "items": { "$ref": "#/components/schemas/CreateTankStrapRequest" }, "nullable": true } }, "additionalProperties": false }, "CreateTankStrapRequest": { "type": "object", "properties": { "startHeight": { "type": "number", "format": "float" }, "endHeight": { "type": "number", "format": "float" }, "volume": { "type": "number", "format": "float" } }, "additionalProperties": false }, "CreateTransportCompanyRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true }, "purchaserType": { "$ref": "#/components/schemas/PurchaserType" }, "active": { "type": "boolean", "nullable": true }, "rrcNumber": { "type": "string", "nullable": true }, "useCorrectedBblsCalculator": { "type": "boolean", "nullable": true }, "useCalculateClosingGauge": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreateUserRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/Role" }, "phoneNumber": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true }, "allowComments": { "type": "boolean", "nullable": true }, "allowViewAllReports": { "type": "boolean", "nullable": true }, "enableEmailNotifications": { "type": "boolean", "nullable": true }, "enableTagsEmailNotifications": { "type": "boolean", "nullable": true }, "enableSmsNotifications": { "type": "boolean", "nullable": true }, "enablePushNotifications": { "type": "boolean", "nullable": true }, "timeZone": { "type": "integer", "format": "int32", "nullable": true }, "readOnlyUser": { "type": "boolean", "nullable": true }, "hideDowntime": { "type": "boolean", "nullable": true }, "enableSpeedMode": { "type": "boolean", "nullable": true }, "displayOverview": { "type": "boolean", "nullable": true }, "batteryIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "batteryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CreateWellRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "batteryName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "county": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "apiWellNumber": { "type": "string", "nullable": true }, "wellIdentifier": { "type": "string", "nullable": true }, "texasIdentifier": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/WellType" }, "position": { "type": "integer", "format": "int32", "nullable": true }, "useCumulativeMode": { "type": "boolean", "nullable": true }, "productionApplication": { "$ref": "#/components/schemas/ProductionApplication" }, "wellOperationalStatus": { "$ref": "#/components/schemas/WellOperationalStatus" }, "latitude": { "type": "number", "format": "float", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "range": { "type": "integer", "format": "int32", "nullable": true }, "productionStart": { "type": "string", "nullable": true }, "mirrorTestsToWellId": { "type": "integer", "format": "int32", "nullable": true }, "mirrorDowntimesToWellId": { "type": "integer", "format": "int32", "nullable": true }, "importIdentifier": { "type": "string", "nullable": true }, "allocateGas": { "type": "boolean", "nullable": true }, "allocateOil": { "type": "boolean", "nullable": true }, "allocateWater": { "type": "boolean", "nullable": true }, "engineeringIdentifier": { "type": "string", "nullable": true }, "grossWorkingInterest": { "type": "number", "format": "float", "nullable": true }, "netRevenueInterest": { "type": "number", "format": "float", "nullable": true }, "allocateOilFromWellOilMeter": { "type": "boolean", "nullable": true }, "allowSelectWellOnTest": { "type": "boolean", "nullable": true }, "agreementIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DynamicOptionValueDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DynamicValueDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "DynamicVariableSource": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "GasCollectionType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "GasMeasurementDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "gasMeterId": { "type": "integer", "format": "int32" }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "gasMeterName": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time", "nullable": true }, "pressure": { "type": "number", "format": "float", "nullable": true }, "differential": { "type": "number", "format": "float", "nullable": true }, "meterReading": { "type": "number", "format": "float", "nullable": true }, "gasProduced": { "type": "number", "format": "float", "nullable": true }, "checkMeter": { "type": "number", "format": "float", "nullable": true }, "orificeSize": { "type": "number", "format": "float", "nullable": true }, "orificeSizeUnit": { "type": "integer", "format": "int32", "nullable": true }, "resetMeter": { "type": "boolean" }, "dynamics": { "type": "array", "items": { "$ref": "#/components/schemas/PreInputDynamicValueDto" }, "nullable": true } }, "additionalProperties": false }, "GasMeterType": { "enum": [ 0, 1, 2, 3, 5, 6, 7 ], "type": "integer", "format": "int32" }, "InjectionWellDynamicDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InjectionWellMeasurementDto": { "type": "object", "properties": { "injectionWellId": { "type": "integer", "format": "int32", "nullable": true }, "injectionWellName": { "type": "string", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "meterReading": { "type": "number", "format": "float", "nullable": true }, "casing": { "type": "number", "format": "float", "nullable": true }, "pressure": { "type": "number", "format": "float", "nullable": true }, "waterBbls": { "type": "number", "format": "float", "nullable": true }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "batteryName": { "type": "string", "nullable": true }, "dynamicVariables": { "type": "array", "items": { "$ref": "#/components/schemas/InjectionWellDynamicDto" }, "nullable": true } }, "additionalProperties": false }, "InjectionWellType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "OilType": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "PreInputDynamicValueDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "aggregateType": { "$ref": "#/components/schemas/AggregateType" }, "displayType": { "$ref": "#/components/schemas/VariableDisplayType" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicOptionValueDto" }, "nullable": true }, "required": { "type": "boolean" }, "source": { "$ref": "#/components/schemas/DynamicVariableSource" }, "dynamicsSourceMeasurementType": { "type": "integer", "format": "int32", "nullable": true }, "dynamicVariableSourceKey": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "locked": { "type": "boolean" }, "disableCarryForward": { "type": "boolean" } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProductionApplication": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "ProductionFlow": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "PurchaserDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "identifier": { "type": "string", "nullable": true }, "purchaserType": { "$ref": "#/components/schemas/PurchaserType" }, "active": { "type": "boolean" }, "useCorrectedBblsCalculator": { "type": "boolean" }, "useCalculateClosingGauge": { "type": "boolean" }, "rrcNumber": { "type": "string", "nullable": true }, "isNew": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PurchaserType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "PushBatteryMeasurementDto": { "type": "object", "properties": { "batteryId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "meterReading": { "type": "number", "format": "float", "nullable": true }, "salesMeter": { "type": "number", "format": "float", "nullable": true }, "orificeSize": { "type": "number", "format": "float", "nullable": true }, "differential": { "type": "number", "format": "float", "nullable": true }, "separator": { "type": "number", "format": "float", "nullable": true }, "heater": { "type": "number", "format": "float", "nullable": true }, "checkMeter": { "type": "number", "format": "float", "nullable": true }, "dynamics": { "type": "array", "items": { "$ref": "#/components/schemas/PushDynamicsDtoValue" }, "nullable": true } }, "additionalProperties": false }, "PushBatteryMeasurementDynamicsDto": { "type": "object", "properties": { "batteryId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/PushDynamicsDtoValue" }, "nullable": true } }, "additionalProperties": false }, "PushDynamicsDtoValue": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PushGasMeterMeasurementDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "pressure": { "type": "number", "format": "float", "nullable": true }, "differential": { "type": "number", "format": "float", "nullable": true }, "meterReading": { "type": "number", "format": "float", "nullable": true }, "gasProduced": { "type": "number", "format": "float", "nullable": true }, "dynamics": { "type": "array", "items": { "$ref": "#/components/schemas/PushDynamicsDtoValue" }, "nullable": true } }, "additionalProperties": false }, "ReportParameters": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "all": { "type": "boolean" }, "batteriesIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "batteryGroupsIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "userIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "Role": { "enum": [ 1, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "StockApplication": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "TankGauge": { "type": "object", "properties": { "tankId": { "type": "integer", "format": "int32" }, "tankName": { "type": "string", "nullable": true }, "closingGauge": { "type": "number", "format": "float", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TankSupportedProduct": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "TankTicket": { "type": "object", "properties": { "tankId": { "type": "integer", "format": "int32" }, "tankName": { "type": "string", "nullable": true }, "openingGauge": { "type": "number", "format": "float", "nullable": true }, "ticketNumber": { "type": "string", "nullable": true }, "closingGauge": { "type": "number", "format": "float", "nullable": true }, "openingBottomGauge": { "type": "number", "format": "float", "nullable": true }, "closingBottomGauge": { "type": "number", "format": "float", "nullable": true }, "correctedVolume": { "type": "number", "format": "float", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TicketType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32" }, "Time": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "UploadLactMeasurementDto": { "type": "object", "properties": { "tankId": { "type": "integer", "description": "For compatibility , please send lact id instead", "format": "int32", "nullable": true }, "lactId": { "type": "integer", "format": "int32", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "tankName": { "type": "string", "description": "For compatibility , please send lact name instead", "nullable": true }, "lactName": { "type": "string", "nullable": true }, "meterReading": { "type": "number", "format": "float", "nullable": true }, "meterSales": { "type": "number", "format": "float", "nullable": true }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "dynamicVariables": { "type": "array", "items": { "$ref": "#/components/schemas/PushDynamicsDtoValue" }, "nullable": true } }, "additionalProperties": false }, "UploadTankMeasurementDto": { "type": "object", "properties": { "tankId": { "type": "integer", "format": "int32", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "tankName": { "type": "string", "nullable": true }, "tankNumber": { "type": "string", "nullable": true }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "gauge": { "type": "number", "format": "float" }, "bottomGauge": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "UploadTankTicketDto": { "type": "object", "properties": { "tankId": { "type": "integer", "format": "int32", "nullable": true }, "batteryId": { "type": "integer", "format": "int32", "nullable": true }, "tankName": { "type": "string", "nullable": true }, "purchaserId": { "type": "integer", "format": "int32", "nullable": true }, "purchaserName": { "type": "string", "nullable": true }, "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "openingGauge": { "type": "number", "format": "float" }, "closingGauge": { "type": "number", "format": "float" }, "openingBottomGauge": { "type": "number", "format": "float", "nullable": true }, "closingBottomGauge": { "type": "number", "format": "float", "nullable": true }, "correctedValue": { "type": "number", "format": "float" }, "apiGrade": { "type": "number", "format": "float", "nullable": true }, "bsw": { "type": "number", "format": "float", "nullable": true }, "gross": { "type": "number", "format": "float", "nullable": true }, "ticketType": { "$ref": "#/components/schemas/TicketType" } }, "additionalProperties": false }, "UserLookupResponse": { "type": "object", "properties": { "exists": { "type": "boolean" }, "username": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/Role" } }, "additionalProperties": false }, "VariableDisplayType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32" }, "Volume": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "WellAllocationDayDto": { "type": "object", "properties": { "apiNumber": { "type": "string", "nullable": true }, "wellName": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "oil": { "type": "number", "format": "float", "nullable": true }, "water": { "type": "number", "format": "float", "nullable": true }, "gas": { "type": "number", "format": "float", "nullable": true }, "wellId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "WellDbLookupResponse": { "type": "object", "properties": { "well": { "$ref": "#/components/schemas/WellDbLookupWellDto" }, "confidence": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WellDbLookupWellDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "apiWellNumber": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "operatorName": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "float", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "wellType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WellDowntimeDto": { "type": "object", "properties": { "wellId": { "type": "integer", "format": "int32" }, "startOnDate": { "type": "string", "nullable": true }, "startOnTime": { "type": "string", "nullable": true }, "endOnDate": { "type": "string", "nullable": true }, "endOnTime": { "type": "string", "nullable": true }, "isShutIn": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "unitType": { "$ref": "#/components/schemas/Time" }, "units": { "type": "number", "format": "float", "nullable": true }, "isStillProducingGas": { "type": "boolean" }, "dynamics": { "type": "array", "items": { "$ref": "#/components/schemas/PushDynamicsDtoValue" }, "nullable": true } }, "additionalProperties": false }, "WellDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "api": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WellMeasurementDto": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "wellId": { "type": "integer", "format": "int32" }, "chokeSize": { "type": "number", "format": "float", "nullable": true }, "flowLine": { "type": "number", "format": "float", "nullable": true }, "tubing": { "type": "number", "format": "float", "nullable": true }, "casing": { "type": "number", "format": "float", "nullable": true }, "checkMeter": { "type": "number", "format": "float", "nullable": true }, "resetMeter": { "type": "boolean" }, "oilMeterReading": { "type": "number", "format": "float", "nullable": true }, "oilVolumeProduced": { "type": "number", "format": "float", "nullable": true }, "dynamics": { "type": "array", "items": { "$ref": "#/components/schemas/PushDynamicsDtoValue" }, "nullable": true } }, "additionalProperties": false }, "WellOperationalStatus": { "enum": [ 1, 14, 15 ], "type": "integer", "format": "int32" }, "WellTestDto": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "wellId": { "type": "integer", "format": "int32" }, "gas": { "type": "number", "format": "float", "nullable": true }, "oil": { "type": "number", "format": "float", "nullable": true }, "water": { "type": "number", "format": "float", "nullable": true }, "preTestShutInDays": { "type": "number", "format": "float", "nullable": true }, "dynamics": { "type": "array", "items": { "$ref": "#/components/schemas/PushDynamicsDtoValue" }, "nullable": true } }, "additionalProperties": false }, "WellType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "name": "Authorization", "in": "header" } } }, "security": [ { } ], "tags": [ { "name": "Assets" }, { "name": "Batteries" }, { "name": "Comments" }, { "name": "DowntimeReasons" }, { "name": "GasMeters" }, { "name": "InjectionWells" }, { "name": "Lacts" }, { "name": "Pumpers" }, { "name": "Reports" }, { "name": "Tanks" }, { "name": "TransportCompanies" }, { "name": "Users" }, { "name": "WellDb" }, { "name": "Wells" } ] }