CreateSimulationResponse

If no errors are encountered, CreateSimulationResponse is returned in response to POSTing a CreateSimulationRequest to https://services.solaranywhere.com/api/v2/Simulation?key=CLIENT_KEY.

The element has a SimulationId attribute that clients can use to request the simulation results via an HTTP GET to https://services.solaranywhere.com/api/v2/SimulationResult/{SimulationId}.

<CreateSimulationResponse SimulationId="PP8RXUE" RequestId="65VUTHP77" 
 xmlns="http://service.solaranywhere.com/api/v2" />

ServiceError

ServiceError responses indicate errors in the client CreateSimulationRequest XML.  License restrictions will return in the GetSimulationResultsResponse XML file.

 

<?xml version="1.0" encoding="utf-8"?>
<ServiceError RequestURL="/api/v2/Simulation?key=****EY" RequestId="5G54MKU03" xmlns="http://service.solaranywhere.com/api/v2">
  <StatusCode>BadRequest</StatusCode>
  <Message>Invalid SpatialResolution_Degrees value '0'</Message>
</ServiceError>

 

 

<?xml version="1.0" encoding="utf-8"?>
<ServiceError RequestURL="/api/v2/Simulation?key=****EY" RequestId="5G54MKU03" xmlns="http://service.solaranywhere.com/api/v2">
  <StatusCode>BadRequest</StatusCode>
  <Message>You must define at least 1 EnergySite when requesting simulation data.</Message>
</ServiceError>

 

 

<?xml version="1.0" encoding="utf-8"?>
<ServiceError RequestURL="/api/v2/Simulation?key=****EY" RequestId="5G54MKU03" xmlns="http://service.solaranywhere.com/api/v2">
  <Message>Request throttled.  License request rate exceeded.</Message>
</ServiceError>

 

ServiceError for TGY Requests

 

<?xml version="1.0" encoding="utf-8"?>
<ServiceError RequestURL="/api/v2/Simulation?key=****EY" RequestId="5G54MKU03" xmlns="http://service.solaranywhere.com/api/v2">
  <StatusCode>BadRequest</StatusCode>
  <Message>Simulation start and end time must be null when requesting Typical Year/Month data.</Message>
</ServiceError>

 

 

<?xml version="1.0" encoding="utf-8"?>
<ServiceError RequestURL="/api/v2/Simulation?key=****EY" RequestId="5G54MKU03" xmlns="http://service.solaranywhere.com/api/v2">
  <Message>PerformTimeShifting cannot be false for TGY/TDY requests.</Message>
</ServiceError>

 

 

<?xml version="1.0" encoding="utf-8"?>
<ServiceError RequestURL="/api/v2/Simulation?key=****EY" RequestId="5G54MKU03" xmlns="http://service.solaranywhere.com/api/v2">
  <StatusCode>BadRequest</StatusCode>
  <Message>Output field (StartTime) may not be requested when requesting Typical Month/Year data.</Message>
</ServiceError>