> ## Documentation Index > Fetch the complete documentation index at: https://docs.plantpredict.com/llms.txt > Use this file to discover all available pages before exploring further. # Run quality check on a parsed weather file > The Quality Check endpoint is used to confirm: 1. The specified column mappings are valid 2. The input values for the specified data type are within tolerance and do not exceed realistic values. 3. Your weather file is ready for import - If all validations pass, the API will return a message indicating there were no errors found and you are good to proceed to the final step. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml post /Weather/QualityCheck openapi: 3.1.0 info: title: PlantPredict API version: 12.13.0 description: > ## What is PlantPredict? PlantPredict is an industry-leading performance modeling platform for utility-scale solar power plants. It predicts energy yield across the full project lifecycle — from early-stage site prospecting through detailed engineering and operational monitoring. The same engine that powers the PlantPredict web UI is fully exposed via this REST API, enabling automation of complex, high-time-resolution energy predictions without any UI interaction. ## Domain Model — read this first Understanding the object hierarchy is essential before calling the API: - **Weather** — A weather file (hourly irradiance, temperature, wind, etc.) for a geographic location. Imported from a provider (e.g. SolarAnywhere, Meteonorm) or uploaded manually. Weather files live in a company-wide library and are referenced by Predictions. - **Module** — A PV module definition parameterized with electrical characteristics (STC power, temperature coefficients, single-diode model parameters, IAM curves, etc.). Modules live in a company-wide library. - **Inverter** — An inverter definition with efficiency curves, voltage/power ratings, and optional kVA derating curves. Inverters live in a company-wide library. - **Project** — A named location (lat/lon) that acts as a container for one or more Predictions. Holds geographic metadata (country, elevation, UTC offset) and a status. - **Prediction** — The core simulation configuration nested under a Project. Defines the simulation period, model selections (transposition, air mass, degradation, soiling, shading, spectral shift models), uncertainty error terms, and references to a Weather file. A Prediction must be linked to a PowerPlant before it can be run. Status values: 0 = Draft, 1 = Active, 2 = Issued, 3 = Archived. - **PowerPlant** — The physical plant design attached to a Prediction. Describes the electrical topology: Blocks → Arrays → Inverters → DC Fields (strings of modules). Also includes transformers, transmission lines, energy storage (ESS), availability losses, and LGIA export limits. - **Shade Scene** — An optional 3D shading model (PVJ format) attached to a Prediction's DC Fields. Supports import from PVC or SHD files. Shade and TABT (Tracker Angle Back-Tracking) calculations are queued and run asynchronously. ## Typical workflow to run a prediction 1. Ensure a **Weather** file exists (search, download, or import one). 2. Ensure a **Module** and **Inverter** exist in the library. 3. **POST /Project** — create a project at the site location. 4. **POST /Project/{projectId}/Prediction** — create a prediction with model settings. 5. **POST /Project/{projectId}/Prediction/{predictionId}/PowerPlant** — attach a plant design referencing your module and inverter. 6. **POST /Project/{projectId}/Prediction/{predictionId}/Run** — queue the simulation. 7. Poll **GET /Project/{projectId}/Prediction/{predictionId}/Overview** until `status` reaches 2 (complete), then retrieve results via `/ResultSummary`, `/ResultDetails`, or `/NodalJson`. ## Authentication OAuth 2.0 **Client Credentials** flow via AWS Cognito. The spec advertises a single `bearerAuth` scheme — fetch a token yourself with the snippet below, then either paste it into the in-browser playground or pass it on every request as `Authorization: Bearer `. > **Why not advertise OAuth2 directly?** Most users have access to the > production tenant only, and we don't want to invite anyone to enter > long-lived `client_id` / `client_secret` credentials into a third-party > documentation site. Keep credentials in your own environment; ship > short-lived bearer tokens to wherever they are needed. - Token URL: `https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token` - Scopes: `transactions/get` (read), `transactions/post` (write) — request both to access the entire surface. - Send credentials as **Basic Auth** in the token request header. Example: ```bash curl -X POST 'https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token' \ -u "$PP_CLIENT_ID:$PP_CLIENT_SECRET" \ -d 'grant_type=client_credentials&scope=transactions/get transactions/post' ``` API credentials (Client ID + Secret) are generated per user by a company admin inside the PlantPredict UI (gear icon → user profile → Generate API Credentials). Store them securely — they are shown only once. ## Notes - All request/response bodies are JSON (`Content-Type: application/json`). - The API is stateless — every request must supply complete inputs; there is no session. - POST operations that create entities return `{"id": }`. - Many integer fields (model types, status codes) map to named enums — use `GET /Definitions` to retrieve the full enum catalog at runtime. - Long-running operations (Run, Shade calculations, TABT) are asynchronous; poll the corresponding `ProcessingStatus` endpoint to track progress. - Responses may include an `X-Message` header with non-blocking warnings (e.g. duplicate project name). servers: - url: https://api.plantpredict.terabase.energy description: Production security: - bearerAuth: [] tags: - name: Definitions description: Enum and model type definitions - name: Projects description: Solar project management - name: Predictions description: Energy prediction configuration and execution - name: PowerPlant description: Power plant design (blocks, arrays, inverters, transformers) - name: TimeSeries description: Custom time series data inputs - name: Results description: Prediction results — summary, details, nodal, average energy - name: FinancialModel description: Financial model parameters and cashflow results - name: Reports description: Report generation and export - name: ShadeScene description: 3D shade scene management and calculations - name: Weather description: Weather file import, download, and management - name: Inverters description: Inverter library management - name: Modules description: PV module library and single-diode parameter generation - name: ASHRAE description: ASHRAE climate station lookup - name: System description: System version and maintenance status - name: Company description: Company settings and user management - name: Country description: Reference country data paths: /Weather/QualityCheck: post: tags: - Weather summary: Run quality check on a parsed weather file description: > The Quality Check endpoint is used to confirm: 1. The specified column mappings are valid 2. The input values for the specified data type are within tolerance and do not exceed realistic values. 3. Your weather file is ready for import - If all validations pass, the API will return a message indicating there were no errors found and you are good to proceed to the final step. operationId: qualityCheckWeather requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WeatherFile' examples: postman-mples-how-to-add-new-with-quality-check-step-2-quality-check: value: error: false errorDescription: null warningMessage: null source: Meteonorm - 40.193N - 99.715W.xlsx latitude: 40.1932678 longitude: -99.7152252 elevation: 665 timeZone: -6 region: North America pLevel: 0 windSensorHeight: 10 dataProvider: 4 dataType: 1 format: 3 weatherDataModelVersion: 8.1.2.15989 customerName: '' stationName: '' stationCode: null separatorType: ',' customSeparater: null headerRowsToSkip: 3 startDate: '2005-01-01T00:00:00' endDate: '2005-12-31T23:00:00' timeInterval: 60 timestampDefinition: 2 columnMappings: ghi: 2 dni: 3 dhi: 4 temp: 5 windspeed: 6 relativeHumidity: 7 pwat: 8 rain: 9 pressure: 10 dewpointTemp: 11 windDirection: 12 soilingLoss: 13 poai: 14 fileLimitReached: false rowCount: 8763 weatherFileKey: 8f83cecb-4080-4b84-9c52-3f99e457ef5e locality: Oxford stateProvince: Nebraska stateProvinceCode: NE country: United States countryCode: US offsetMinutes: 0 includesLeapDays: false moduleTilt: null moduleAzimuth: null trackingType: null trackingBacktrackingType: 0 minimumTrackingLimitAngleD: 0 maximumTrackingLimitAngleD: null trackerPitchAngleD: null trackerStowAngle: null groundCoverageRatio: null postman-weather-quality-check: value: error: false errorDescription: null warningMessage: null source: NSRDB - 41.65N - 83.54W (1).xlsx latitude: 41.65 longitude: -83.54 elevation: 183 timeZone: -5 region: North America pLevel: 0 windSensorHeight: 10 dataProvider: 17 dataType: 7 format: 2 weatherDataModelVersion: v3.0.1 customerName: '' stationName: '' stationCode: null separatorType: ',' customSeparater: null headerRowsToSkip: 3 startDate: '2010-01-01T00:00:00' endDate: '2010-12-31T23:00:00' timeInterval: 60 timestampDefinition: 2 columnMappings: ghi: 2 dni: 3 dhi: 4 temp: 5 windspeed: 6 relativeHumidity: 7 pwat: 8 rain: 9 pressure: 10 dewpointTemp: 11 windDirection: 12 soilingLoss: 13 poai: 14 rowData: - - Station Type - Latitude (dd) - Longitude (dd) - Elevation (m) - Time Zone (UTC) - Time Stamp - Timestep Interval (min) - Data Provider - P-Level - Data Type - Model Version - IF(OR(H2="GlobalFED", H2="Customer"),"Customer Name","") - >- IF(OR(J2="Measured", J2="TMY3"),"Project/Station Name","") - Wind Sensor Height m - Mounting Technology - Rotational Limits Min - Rotational Limts Max - Tracking Method - Tilt Angle - GCR (%) - Azimuth (°) - - NREL - '41.65' - '-83.54' - '183' - '-5' - IntervalBegin - '60' - NSRDB - P50 - PSM - v3.0.1 - '' - '' - '10' - '' - '' - '' - '' - '' - '' - '' - - MM/DD/YYYY - hh:mm:ss - GHI - DNI - DHI - Temp - WS - RH - PWat - Rain - Pressure - Dew Point Temp - Wind Direction - Soiling Loss - POAI (W/m2) - - 01/01/2010 - '00:00:00' - '-15' - '0' - '1500' - '-3' - '4.8' - '' - '' - '' - '1000' - '-6' - '78' - '' - '-15' - - 01/01/2010 - '01:00:00' - '-15' - '0' - '1500' - '-3' - '4.3' - '-3' - '' - '' - '990' - '-6' - '77.599999999999994' - '' - '' - - 01/01/2010 - '02:00:00' - '-15' - '0' - '1500' - '-4' - '3.8' - '' - '' - '-6' - '990' - '-7' - '72.2' - '' - '' - - 01/01/2010 - '03:00:00' - '-15' - '0' - '1500' - '-5' - '4' - '' - '-5' - '' - '990' - '-7' - '65' - '' - '' - - 01/01/2010 - '04:00:00' - '-15' - '0' - '0' - '-4' - '4.5999999999999996' - '' - '' - '' - '990' - '-7' - '64.099999999999994' - '' - '' - - 01/01/2010 - '05:00:00' - '-15' - '0' - '0' - '-4' - '5.2' - '' - '' - '' - '990' - '-7' - '450' - '' - '' - - 01/01/2010 - '06:00:00' - '-15' - '0' - '0' - '-4' - '5.3' - '' - '' - '' - '990' - '-7' - '69.400000000000006' - '' - '' - - 01/01/2010 - '07:00:00' - '-15' - '0' - '0' - '-4' - '5.0999999999999996' - '' - '' - '' - '990' - '-6' - '70.2' - '-5' - '' - - 01/01/2010 - '08:00:00' - '-15' - '0' - '6' - '-3' - '5.6' - '' - '' - '' - '990' - '45' - '66.2' - '' - '' - - 01/01/2010 - '09:00:00' - '-15' - '0' - '26' - '-2' - '6.6' - '' - '' - '' - '990' - '-6' - '68.5' - '' - '' - - 01/01/2010 - '10:00:00' - '-15' - '0' - '45' - '-2' - '6.9' - '' - '' - '' - '990' - '-7' - '76.099999999999994' - '' - '' - - 01/01/2010 - '11:00:00' - '-15' - '0' - '57' - '100' - '7' - '' - '' - '' - '990' - '-7' - '78.099999999999994' - '' - '' - - 01/01/2010 - '12:00:00' - '-15' - '29' - '168' - '-2' - '35' - '' - '' - '' - '990' - '-7' - '79.599999999999994' - '' - '' - - 01/01/2010 - '13:00:00' - '-15' - '0' - '75' - '-2' - '6.7' - '' - '' - '' - '990' - '-7' - '81.099999999999994' - '' - '' - - 01/01/2010 - '14:00:00' - '34' - '0' - '34' - '-3' - '6.4' - '' - '' - '' - '990' - '-7' - '81.7' - '' - '' - - 01/01/2010 - '15:00:00' - '22' - '0' - '22' - '-3' - '5.8' - '' - '' - '' - '990' - '-7' - '81.7' - '' - '' - - 01/01/2010 - '16:00:00' - '7' - '0' - '7' - '-3' - '4.9000000000000004' - '' - '' - '' - '990' - '-7' - '80.5' - '' - '' - - 01/01/2010 - '17:00:00' - '0' - '0' - '0' - '-4' - '4.4000000000000004' - '' - '' - '' - '990' - '-7' - '75.8' - '' - '' - - 01/01/2010 - '18:00:00' - '0' - '0' - '0' - '-4' - '4.3' - '' - '' - '' - '990' - '-7' - '70' - '' - '' - - 01/01/2010 - '19:00:00' - '0' - '0' - '0' - '-4' - '4.3' - '' - '' - '' - '1500' - '-7' - '68.099999999999994' - '' - '' - - 01/01/2010 - '20:00:00' - '0' - '-15' - '0' - '-3' - '4.5' - '' - '' - '' - '990' - '-7' - '64.3' - '' - '' - - 01/01/2010 - '21:00:00' - '0' - '0' - '0' - '-3' - '4.7' - '' - '' - '' - '990' - '-6' - '60.5' - '' - '' - - 01/01/2010 - '22:00:00' - '0' - '0' - '0' - '-3' - '4.5999999999999996' - '' - '' - '' - '990' - '-6' - '56.1' - '' - '' - - 01/01/2010 - '23:00:00' - '0' - '0' - '0' - '-3' - '4.3' - '' - '' - '' - '990' - '-5' - '51.3' - '' - '' - - 01/02/2010 - '00:00:00' - '0' - '0' - '0' - '-4' - '4.0999999999999996' - '' - '' - '' - '990' - '-6' - '47.9' - '' - '' - - 01/02/2010 - '01:00:00' - '0' - '0' - '0' - '-4' - '4.0999999999999996' - '' - '' - '' - '990' - '-6' - '45.5' - '' - '' - - 01/02/2010 - '02:00:00' - '0' - '0' - '0' - '-4' - '4.0999999999999996' - '' - '' - '' - '990' - '-6' - '45.8' - '' - '' - - 01/02/2010 - '03:00:00' - '0' - '0' - '0' - '-4' - '4' - '' - '' - '' - '990' - '-5' - '50.5' - '' - '' - - 01/02/2010 - '04:00:00' - '0' - '0' - '0' - '-3' - '4.0999999999999996' - '' - '' - '' - '990' - '-5' - '54.1' - '' - '' - - 01/02/2010 - '05:00:00' - '0' - '0' - '0' - '-3' - '4.2' - '' - '' - '' - '990' - '-5' - '58.6' - '' - '' - - 01/02/2010 - '06:00:00' - '0' - '0' - '0' - '-2' - '4.4000000000000004' - '' - '' - '' - '990' - '-4' - '65.2' - '' - '' - - 01/02/2010 - '07:00:00' - '0' - '-15' - '0' - '-2' - '4.5' - '' - '' - '' - '990' - '-4' - '68.599999999999994' - '' - '' - - 01/02/2010 - '08:00:00' - '10' - '0' - '10' - '-1' - '4.7' - '' - '' - '' - '990' - '-4' - '72.2' - '' - '' - - 01/02/2010 - '09:00:00' - '46' - '0' - '46' - '0' - '4.9000000000000004' - '' - '' - '' - '990' - '-4' - '74.7' - '' - '' - - 01/02/2010 - '10:00:00' - '79' - '0' - '79' - '0' - '5' - '' - '' - '' - '990' - '-4' - '80.2' - '' - '' - - 01/02/2010 - '11:00:00' - '120' - '0' - '120' - '0' - '5' - '' - '' - '' - '990' - '-4' - '80.599999999999994' - '' - '' - - 01/02/2010 - '12:00:00' - '146' - '1' - '145' - '0' - '5' - '' - '' - '' - '990' - '-4' - '76' - '' - '' - - 01/02/2010 - '13:00:00' - '240' - '147' - '179' - '1' - '5.0999999999999996' - '' - '' - '' - '990' - '-3' - '70.3' - '' - '' - - 01/02/2010 - '14:00:00' - '281' - '482' - '112' - '1' - '5.2' - '' - '' - '' - '990' - '-3' - '63.4' - '' - '' - - 01/02/2010 - '15:00:00' - '225' - '696' - '54' - '0' - '4.7' - '' - '' - '' - '990' - '-3' - '57.8' - '' - '' - - 01/02/2010 - '16:00:00' - '81' - '465' - '31' - '0' - '3.9' - '' - '' - '' - '990' - '-3' - '54.2' - '' - '' - - 01/02/2010 - '17:00:00' - '0' - '0' - '0' - '-1' - '3.8' - '' - '' - '' - '990' - '-4' - '50.2' - '' - '' - - 01/02/2010 - '18:00:00' - '0' - '0' - '0' - '-1' - '4.5' - '' - '' - '' - '990' - '-4' - '46.1' - '' - '' - - 01/02/2010 - '19:00:00' - '0' - '0' - '0' - '-1' - '5.3' - '' - '' - '' - '990' - '-3' - '43.6' - '' - '' - - 01/02/2010 - '20:00:00' - '0' - '0' - '0' - '-1' - '5.9' - '' - '' - '' - '990' - '-3' - '43.7' - '' - '' - - 01/02/2010 - '21:00:00' - '0' - '0' - '0' - '-1' - '6.3' - '' - '' - '' - '980' - '-3' - '44.6' - '' - '' - - 01/02/2010 - '22:00:00' - '0' - '0' - '0' - '-1' - '6.3' - '' - '' - '' - '980' - '-3' - '48.3' - '' - '' - - 01/02/2010 - '23:00:00' - '0' - '0' - '0' - '-1' - '6' - '' - '' - '' - '980' - '-3' - '53.9' - '' - '' - - 01/03/2010 - '00:00:00' - '0' - '0' - '0' - '-2' - '5.6' - '' - '' - '' - '980' - '-3' - '59.5' - '' - '' - - 01/03/2010 - '01:00:00' - '0' - '0' - '0' - '-2' - '5.4' - '' - '' - '' - '980' - '-3' - '66.900000000000006' - '' - '' - - 01/03/2010 - '02:00:00' - '0' - '0' - '0' - '-2' - '5' - '' - '' - '' - '980' - '-3' - '78.7' - '' - '' - - 01/03/2010 - '03:00:00' - '0' - '0' - '0' - '-1' - '4.4000000000000004' - '' - '' - '' - '980' - '-3' - '88.5' - '' - '' - - 01/03/2010 - '04:00:00' - '0' - '0' - '0' - '-1' - '3.9' - '' - '' - '' - '990' - '-3' - '92.1' - '' - '' - - 01/03/2010 - '05:00:00' - '0' - '0' - '0' - '-1' - '3.4' - '' - '' - '' - '990' - '-3' - '91.9' - '' - '' - - 01/03/2010 - '06:00:00' - '0' - '0' - '0' - '-1' - '3.1' - '' - '' - '' - '990' - '-3' - '100.2' - '' - '' - - 01/03/2010 - '07:00:00' - '0' - '0' - '0' - '-1' - '2.9' - '' - '' - '' - '990' - '-3' - '110.7' - '' - '' - - 01/03/2010 - '08:00:00' - '2' - '0' - '2' - '0' - '3.2' - '' - '' - '' - '990' - '-3' - '119.4' - '' - '' - - 01/03/2010 - '09:00:00' - '11' - '0' - '11' - '0' - '3.9' - '' - '' - '' - '990' - '-3' - '129.6' - '' - '' - - 01/03/2010 - '10:00:00' - '19' - '0' - '19' - '0' - '4.5' - '' - '' - '' - '990' - '-4' - '144' - '' - '' - - 01/03/2010 - '11:00:00' - '130' - '0' - '130' - '1' - '4.7' - '' - '' - '' - '990' - '-5' - '147.30000000000001' - '' - '' - - 01/03/2010 - '12:00:00' - '79' - '0' - '79' - '1' - '4.8' - '' - '' - '' - '990' - '-5' - '147.6' - '' - '' - - 01/03/2010 - '13:00:00' - '52' - '0' - '52' - '1' - '4.5999999999999996' - '' - '' - '' - '990' - '-5' - '147.80000000000001' - '' - '' - - 01/03/2010 - '14:00:00' - '54' - '0' - '54' - '0' - '4.4000000000000004' - '' - '' - '' - '990' - '-5' - '147.30000000000001' - '' - '' - - 01/03/2010 - '15:00:00' - '35' - '0' - '35' - '0' - '3.8' - '' - '' - '' - '990' - '-5' - '146.9' - '' - '' - - 01/03/2010 - '16:00:00' - '12' - '0' - '12' - '0' - '3' - '' - '' - '' - '990' - '-5' - '146.69999999999999' - '' - '' - - 01/03/2010 - '17:00:00' - '0' - '0' - '0' - '-1' - '2.9' - '' - '' - '' - '990' - '-5' - '147.9' - '' - '' - - 01/03/2010 - '18:00:00' - '0' - '0' - '0' - '-1' - '3' - '' - '' - '' - '990' - '-5' - '149.80000000000001' - '' - '' - - 01/03/2010 - '19:00:00' - '0' - '0' - '0' - '-2' - '2.9' - '' - '' - '' - '990' - '-5' - '152.80000000000001' - '' - '' - - 01/03/2010 - '20:00:00' - '0' - '0' - '0' - '-2' - '2.7' - '' - '' - '' - '990' - '-5' - '155' - '' - '' - - 01/03/2010 - '21:00:00' - '0' - '0' - '0' - '-2' - '2.6' - '' - '' - '' - '990' - '-5' - '154.69999999999999' - '' - '' - - 01/03/2010 - '22:00:00' - '0' - '0' - '0' - '-3' - '2.4' - '' - '' - '' - '990' - '-5' - '155.1' - '' - '' - - 01/03/2010 - '23:00:00' - '0' - '0' - '0' - '-3' - '2.4' - '' - '' - '' - '990' - '-5' - '156.30000000000001' - '' - '' - - 01/04/2010 - '00:00:00' - '0' - '0' - '0' - '-3' - '2.5' - '' - '' - '' - '990' - '-6' - '156.80000000000001' - '' - '' - - 01/04/2010 - '01:00:00' - '0' - '0' - '0' - '-3' - '2.5' - '' - '' - '' - '990' - '-6' - '158.19999999999999' - '' - '' - - 01/04/2010 - '02:00:00' - '0' - '0' - '0' - '-3' - '2.4' - '' - '' - '' - '990' - '-6' - '160.5' - '' - '' - - 01/04/2010 - '03:00:00' - '0' - '0' - '0' - '-3' - '2.4' - '' - '' - '' - '990' - '-6' - '162.4' - '' - '' - - 01/04/2010 - '04:00:00' - '0' - '0' - '0' - '-3' - '2.5' - '' - '' - '' - '990' - '-6' - '160.69999999999999' - '' - '' - - 01/04/2010 - '05:00:00' - '0' - '0' - '0' - '-3' - '2.5' - '' - '' - '' - '1000' - '-6' - '156.9' - '' - '' - - 01/04/2010 - '06:00:00' - '0' - '0' - '0' - '-3' - '2.5' - '' - '' - '' - '1000' - '-6' - '157.4' - '' - '' - - 01/04/2010 - '07:00:00' - '0' - '0' - '0' - '-4' - '2.6' - '' - '' - '' - '1000' - '-6' - '162.30000000000001' - '' - '' - - 01/04/2010 - '08:00:00' - '20' - '0' - '20' - '-3' - '3.3' - '' - '' - '' - '1000' - '-6' - '172.9' - '' - '' - - 01/04/2010 - '09:00:00' - '89' - '38' - '81' - '-3' - '4.4000000000000004' - '' - '' - '' - '1000' - '-7' - '185.3' - '' - '' - - 01/04/2010 - '10:00:00' - '153' - '63' - '132' - '-3' - '5.2' - '' - '' - '' - '1000' - '-7' - '190.9' - '' - '' - - 01/04/2010 - '11:00:00' - '127' - '0' - '127' - '-3' - '5.4' - '' - '' - '' - '1000' - '-8' - '192.1' - '' - '' - - 01/04/2010 - '12:00:00' - '214' - '70' - '184' - '-3' - '5.3' - '' - '' - '' - '1000' - '-8' - '193.3' - '' - '' - - 01/04/2010 - '13:00:00' - '154' - '9' - '150' - '-3' - '5' - '' - '' - '' - '1000' - '-9' - '197.6' - '' - '' - - 01/04/2010 - '14:00:00' - '159' - '46' - '143' - '-3' - '4.5' - '' - '' - '' - '1000' - '-9' - '203.6' - '' - '' - - 01/04/2010 - '15:00:00' - '239' - '715' - '60' - '-4' - '3.9' - '' - '' - '' - '1000' - '-10' - '209.3' - '' - '' - - 01/04/2010 - '16:00:00' - '88' - '464' - '37' - '-5' - '3.1' - '' - '' - '' - '1000' - '-10' - '214.1' - '' - '' - - 01/04/2010 - '17:00:00' - '0' - '0' - '0' - '-6' - '2.4' - '' - '' - '' - '1000' - '-11' - '215.8' - '' - '' - - 01/04/2010 - '18:00:00' - '0' - '0' - '0' - '-6' - '2.1' - '' - '' - '' - '1010' - '-10' - '215.1' - '' - '' - - 01/04/2010 - '19:00:00' - '0' - '0' - '0' - '-7' - '1.9' - '' - '' - '' - '1010' - '-11' - '216.4' - '' - '' - - 01/04/2010 - '20:00:00' - '0' - '0' - '0' - '-7' - '1.7' - '' - '' - '' - '1010' - '-11' - '219.9' - '' - '' - - 01/04/2010 - '21:00:00' - '0' - '0' - '0' - '-8' - '1.6' - '' - '' - '' - '1010' - '-11' - '224.8' - '' - '' - - 01/04/2010 - '22:00:00' - '0' - '0' - '0' - '-8' - '1.6' - '' - '' - '' - '1010' - '-11' - '229.5' - '' - '' - - 01/04/2010 - '23:00:00' - '0' - '0' - '0' - '-9' - '1.5' - '' - '' - '' - '1010' - '-11' - '234.4' - '' - '' - - 01/05/2010 - '00:00:00' - '0' - '0' - '0' - '-9' - '1.2' - '' - '' - '' - '1010' - '-11' - '240.5' - '' - '' fileLimitReached: false rowCount: 8763 weatherFileKey: be586e7f-a9ad-4b2a-944b-8fe24755f747 locality: Toledo stateProvince: Ohio stateProvinceCode: OH country: United States countryCode: US offsetMinutes: 0 includesLeapDays: false moduleTilt: null moduleAzimuth: null trackingType: null trackingBacktrackingType: 0 minimumTrackingLimitAngleD: null maximumTrackingLimitAngleD: null trackerPitchAngleD: null trackerStowAngle: null groundCoverageRatio: null responses: '200': description: Quality check result content: application/json: schema: $ref: '#/components/schemas/WeatherFile' examples: postman-step-2-quality-check: value: No Questionable Records Found. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/ServerError' components: schemas: WeatherFile: type: object required: - name - latitude - longitude properties: id: type: integer readOnly: true name: type: string description: type: - string - 'null' status: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 x-enum-varnames: - Unknown - DraftPrivate - DraftShared - Active - Retired - Global - GlobalRetired description: LibraryStatusEnum source: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 x-enum-varnames: - Unknown - Meteonorm - CPRSolarAnywhere - NSRDBPSM - NSRDBSUNY - NSRDBMTS2 - SolarGIS - NASA - Solcast - PVGIS description: WeatherSourceTypeAPIEnum stationName: type: string stationCode: type: string format: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 x-enum-varnames: - SolarProspectorCSV - NRELTMY3 - MeteonormTMY3 - V3Tier - AWS - EPW - GeoModelSolar - SolarAnywhere - PlantPredict - TMY3 - SolarGIS - NASA - V3TierVaisala - Solcast - PVGIS description: WeatherFormat latitude: type: number longitude: type: number elevation: type: number timeZone: type: number timestampDefinition: type: integer enum: - 0 - 1 - 2 - 3 x-enum-varnames: - Undefined - IntervalEnd - IntervalBegin - IntervalMiddle description: WeatherTimestampDefinitionEnum timeInterval: type: integer startDate: type: string description: >- ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present. endDate: type: string description: >- ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present. dataProvider: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 x-enum-varnames: - NREL - AWSTruepower - WindLogics - Meteonorm - V3TIER - SolarAnywhere - GeoModelSolar - GeoSUNAfrica - SoDa - HelioClim - SolarResourceAssessment - EnergyPlus - Other - Customer - SolarProspector - GlobalFED - NSRDB - WhiteBoxTechnologies - SolarGIS - NASA - V3TIERVaisala - Solcast - PVGIS description: WeatherDataProvider dataType: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 x-enum-varnames: - SyntheticMonthly - Satellite - GroundCorrected - Measured - TMY3 - TGY - TMY - PSM - SUNY - MTS2 - CZ2010 description: WeatherDataType country: type: string countryCode: type: string stateProvince: type: string stateProvinceCode: type: string locality: type: string region: type: string globalHorizontalIrradianceSum: type: number diffuseHorizontalIrradianceSum: type: number directNormalIrradianceSum: type: number planeOfArrayIrradianceSum: type: number averageAirTemperature: type: number averageWindSpeed: type: number weatherDetails: type: array items: type: object pLevel: type: number windSensorHeight: type: number offsetMinutes: type: integer moduleTilt: type: number moduleAzimuth: type: number trackingType: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - FixedTilt - HorizontalTracker - SeasonalTilt description: DCFieldTrackingTypeEnum groundCoverageRatio: type: number companyId: type: integer readOnly: true createdDate: type: string readOnly: true description: >- ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present. ModelStateError: type: object description: | ASP.NET Web API validation error. `modelState` maps the offending field name (or `request`) to a list of human-readable messages. properties: message: type: string modelState: type: object additionalProperties: type: array items: type: string required: - message responses: BadRequest: description: | The request was rejected. PlantPredict returns one of two shapes: * `application/json` with `{message, modelState}` for input validation errors (ASP.NET Web API model-state). The `modelState` map keys field names to lists of human-readable error messages. * `text/plain` with a free-form message for runtime / database errors that bubble up before validation completes. Clients should branch on the `Content-Type` header. content: application/json: schema: $ref: '#/components/schemas/ModelStateError' example: message: The request is invalid. modelState: latitude: - The field Latitude must be between -90 and 90. text/plain: schema: type: string example: A successfully completed prediction cannot be cancelled. Unauthorized: description: >- Missing or invalid bearer token. The response body is empty and no `Content-Type` header is set; the 401 status code is the only signal. Fetch a fresh token (see the **Authentication** section of the API description) and retry. ServerError: description: | Unexpected server-side error. The body is usually a plain-text message but its structure is not guaranteed — treat it as opaque diagnostic text. Common causes: database constraint violation, downstream service timeout, internal exception. Retry-safe for idempotent requests; for non-idempotent ones, verify state before retrying. content: text/plain: schema: type: string example: An error has occurred. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Pass `Authorization: Bearer ` on every request. See the **Authentication** section of the API description for how to fetch a token. ````