Child pages
  • PvPlanner WS: request / response examples

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

WSDL location

...

Production environment: https://solargis.info/ws/soap/pvPlannerWebService.wsdl

REST endpoint: https://solargis.info/ws/rest/pvplanner/calculate?key=demo

pvPlanner calculate

Web service access to PvPlanner "Calculate" functionality, available in online application: http://solargis.info/pvplanner

XML Schemas

  • ws-pvplanner.xsd - pvPlanner web service request and response
  • common-types.xsd - generic common types, like percent, monthly values, etc.
  • common-geo.xsd - geographic common types, like location, terrain, horizon, etc.
  • common-pv.xsd - pv system common configuration, like geometry, mounting, losses, etc.
Tip

Technical schema documentation is available here

 

Requext XML

Code Block
xml
xml

<calculateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:geo="http://geomodel.eu/schema/common/geo"
      xmlns:pv="http://geomodel.eu/schema/common/pv"
      xmlns="http://geomodel.eu/schema/ws/pvplanner">

	<site lat="48.612590" lng="20.827079">
		<!-- optional terrain data -->
		<geo:terrain elevation="246" azimuth="176" tilt="3.1" />
		<!-- optional horizon data -->
		<geo:horizon userDefined="true">11horizon>11.11:18.0; 7.5:15.53; 15.0:10.94; 22.5:10.59; 30.0:13.06; 37.5:14.47; 45.0:14.47; 52.5:13.76; 60.0:12.35; 67.5:11.29; 75.0:8.12; 82.5:4.59; 90.0:1.41; 97.5:0.35; 105.0:0.35; 112.5:0.35; 120.0:0.35; 127.5:0.35; 135.0:0.0; 142.5:0.0; 150.0:0.35; 157.5:1.41; 165.0:2.47; 172.5:2.47; 180.0:2.82; 187.5:3.18; 195.0:2.82; 202.5:2.47; 210.0:2.47; 217.5:2.47; 225.0:3.18; 232.5:3.18; 240.0:2.47; 247.5:2.12; 255.0:2.12; 262.5:2.82; 270.0:3.88; 277.5:6.71; 285.0:8.47; 292.5:10.24; 300.0:11.29; 307.5:12.71; 315.0:14.12; 322.5:15.53; 330.0:16.24; 337.5:16.94; 345.0:17.29; 352.5:17.29</geo:horizon>
		<pv:geometry xsi:type="pv:GeometryFixedOneAngle" azimuth="175" tilt="45"/>
		<pv:system installedPower="1" installationType="roofMountedROOF_MOUNTED" availability="99">
			<pv:module type="cSiCSI">
				<pv:degradation>0</pv:degradation>
                        </pv:module>
			<pv:inverter>
				<pv:efficiency xsi:type="pv:EfficiencyConstant" percent="97.5"/>
			</pv:inverter>
			<pv:losses dc="5.5" ac="1.5"/>
		</pv:system>
	</site>

</calculateRequest>

Response XML

Code Block
xml
xml
<ns4:calculateResponse <calculateResponse xmlns:ns4="http://geomodel.eu/schema/ws/pvplanner" 	xmlns:xsins2="http://wwwgeomodel.w3.orgeu/2001/XMLSchema-instanceschema/common/geo" 	xmlns:geons3="http://geomodel.eu/schema/common/geopv" 
	xmlns:pvns5="http://geomodel.eu/schema/commonws/pvdata">
	 	<site    <ns4:site lat="48.61259" lng="20.827079">
		<geo       <ns2:terrain elevationazimuth="246176" azimuthelevation="176246" tilt="3.1" />
		<geo:horizon userDefined="true">11       <ns2:horizon>11.11:18.0; 7.5:15.53; 15.0:10.94; 22.5:10.59; 30.0:13.06; 37.5:14.47; 45.0:14.47; 52.5:13.76; 60.0:12.35; 67.5:11.29; 75.0:8.12; 82.5:4.59; 90.0:1.41; 97.5:0.35; 105.0:0.35; 112.5:0.35; 120.0:0.35; 127.5:0.35; 135.0:0.0; 142.5:0.0; 150.0:0.35; 157.5:1.41; 165.0:2.47; 172.5:2.47; 180.0:2.82; 187.5:3.18; 195.0:2.82; 202.5:2.47; 210.0:2.47; 217.5:2.47; 225.0:3.18; 232.5:3.18; 240.0:2.47; 247.5:2.12; 255.0:2.12; 262.5:2.82; 270.0:3.88; 277.5:6.71; 285.0:8.47; 292.5:10.24; 300.0:11.29; 307.5:12.71; 315.0:14.12; 322.5:15.53; 330.0:16.24; 337.5:16.94; 345.0:17.29; 352.5:17.29</geons2:horizon>
		<pv       <ns3:geometry xsi:type="pv:GeometryFixedOneAngle" azimuth="175" tilt="45.0" xsi:type="ns3:GeometryFixedOneAngle" xmlns:xsi="http:/>
		<pv/www.w3.org/2001/XMLSchema-instance"/>
       <ns3:system availability="99.0" installationType="roofMountedROOF_MOUNTED" installedPower="1.0">
			<pv          <ns3:module type="cSiCSI">
				<pv             <ns3:degradation>0.0</pvns3:degradation>
			          </pvns3:module>
			<pv:inverter>
				<pv:efficiency           <ns3:inverter>
             <ns3:efficiency percent="97.5" xsi:type="pvns3:EfficiencyConstant" percentxmlns:xsi="97.5http://www.w3.org/2001/XMLSchema-instance"/>
			          </pvns3:inverter>
			<pv          <ns3:losses ac="1.5" dc="5.5"/>
		       </pvns3:system>
	    </ns4:site>
	<irradiation> 		<reference> 			<Ghm   <ns4:irradiation>
       <ns4:reference>
          <ns4:Ghm monthly="3133 4550 9496 134125 158 166168 172165 145150 111100 66 34 2324" yearly="11791169"/>
			<Ghd           <ns4:Ghd monthly="1.0205 1.6080 3.0308 4.4616 5.0911 5.5259 5.5432 4.6885 3.6935 2.1412 1.1312 0.7478" yearly="3.2320"/>
			<Dhd           <ns4:Dhd monthly="0.6561 10.0298 1.7261 2.1613 2.7061 2.9280 2.7569 2.3932 1.7470 1.1614 0.7469 0.5048" yearly="1.7165"/>
			<Td           <ns4:Td monthly="-1.8 -0.4 4.1 10.1 15.5 18.6 20.5 19.9 14.5 9.4 3.9 -1.2" yearly="9.5"/>
			<Tmin           <ns4:Tmin monthly="-3.7 -3.1 0.9 6.5 11.1 13.9 15.9 15.6 11.2 6.3 1.7 -2.9"/>
			<Tmax           <ns4:Tmax monthly="1.4 3.8 8.8 15.5 20.9 23.9 25.8 25.8 20.3 14.6 7.6 1.6"/>
			<invar monthly="13.0 16.1 16.4 19.9 12.6 5.8 14.3 16.2 17.1 17.4 14.7 12.0" yearly="4.8"/>
		</reference>
		<inplane>
			<Gim monthly="57 67 121 150 153 153 164 153 139 99 57 42 </ns4:reference>
       <ns4:inplane>
          <ns4:Gim monthly="63 82 126 139 155 155 157 160 124 98 58 48" yearly="13551365"/>
			<Gid           <ns4:Gid monthly="12.8405 2.3992 34.9208 54.0063 4.9599 5.1017 5.2806 45.9417 4.6312 3.1917 1.8893 1.3754" yearly="3.7174"/>
			<Did           <ns4:Did monthly="0.7673 1.10 1.8070 2.1510 2.5144 2.6556 2.5549 2.3228 1.8375 1.2826 0.8478 0.5957" yearly="1.7065"/>
			<Rid           <ns4:Rid monthly="0.02 0.03 0.06 0.08 0.09 0.10 0.10 0.09 0.0706 0.04 0.02 0.01" yearly="0.06"/>
			<ShLoss           <ns4:ShLoss monthly="0.45 0.01 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.01 0.1 0.4" yearly="0.1"/>
		       </ns4:inplane>
		<comparison> 			<horizontal       <ns4:comparison>
          <ns4:horizontal percentOpt="8584.9" yearlySum="11781169.0"/>
			<optimum           <ns4:optimum percentOpt="100.0" yearlySum="13711377.0"/>
			<tracker2x           <ns4:tracker2x percentOpt="125126.40" yearlySum="17191735.0"/>
			<selected           <ns4:selected percentOpt="9899.91" yearlySum="13561365.0"/>
		       </ns4:comparison>
		<optimum        <ns4:optimum fixed="3637.0"/>
	    </ns4:irradiation>
	<calculation> 		<output> 			<Esm   <ns4:calculation>
       <ns4:output>
          <ns4:Esm monthly="4854 5669 100104 110 120 119 119 117122 12597 117 109 79 4748 3641" yearly="10771086"/>
			<Esd           <ns4:Esd monthly="1.5776 2.0249 3.2437 3.9969 3.8588 3.9297 43.0385 3.7895 3.6424 2.5857 1.5761 1.1632" yearly="2.9598"/>
			<Etm           <ns4:Etm monthly="4955 5670 100104 120111 120 118119 125119 117122 10997 80 4748 3641" yearly="1 0771087"/>
			<Eshare           <ns4:Eshare monthly="45.50 56.24 9.36 1110.12 11.1 10.9 11.60 1011.93 108.19 7.43 4.4 3.48" yearly="100.0"/>
			<PR           <ns4:PR monthly="85.36 8485.30 82.8 79.8 77.9 76.98 76.21 76.6 78.76 80.89 83.1 8485.72" yearly="79.46"/>
		       </ns4:output>
		<losses> 			<global       <ns4:losses>
          <ns4:global PRc="100.0" PRp="100.0" output="13561366"/>
			<terrain           <ns4:terrain PRc="10099.09" PRp="10099.09" lossAbs="0-1" lossRel="-0.01" output="13561365"/>
			<angular           <ns4:angular PRc="97.0" PRp="97.01" lossAbs="-4140" lossRel="-32.09" output="13151325"/>
			<conversion           <ns4:conversion PRc="88.45" PRp="91.2" lossAbs="-116" lossRel="-8.8" output="11991209"/>
			<dcLoss           <ns4:dcLoss PRc="83.67" PRp="94.5" lossAbs="-66" lossRel="-5.5" output="11331143"/>
			<inverter           <ns4:inverter PRc="81.56" PRp="97.5" lossAbs="-2829" lossRel="-2.5" output="11051114"/>
			<acLoss           <ns4:acLoss PRc="80.24" PRp="98.56" lossAbs="-1716" lossRel="-1.54" output="10881098"/>
			<availability           <ns4:availability PRc="79.46" PRp="99.0" lossAbs="-11" lossRel="-1.0" output="10771087"/>
			<total           <ns4:total PRc="79.46" lossAbs="-279" lossRel="-20.64" output="10771087"/>
		       </ns4:losses>
	    </ns4:calculation>
	<summary>PV     <ns4:summary>PV system: 1.0 kWp, crystalline silicon, fixed roof, azim. 175&amp;deg; (south), inclination 45&amp;deg;</ns4:summary>
</ns4:calculateResponse>