Auto Assessor PRO service calls

Introduction

This is a REST based API that allows a client to interact with the AutoAssessorPRO calculation service.
The basic process is that jobs to process are POSTED to data to be queued and processed as quickly as possible.
The job contains your own reference which you can use to identify the job.
GET from the results of that job to return the results once processed
All calls require that a "token" is passed in the header that identifies the user. If the token is not present or not recognised then an unauthorised error will be returned.

Data

API	Description
POST data	Returns 'SAP' energy assessment results for one energy survey - calculated using the table 12 fuel prices and UK average weather, along with any errors or warnings.
POST data/sap	Returns 'SAP' energy assessment results for one energy survey - calculated using the table 12 fuel prices and UK average weather, along with any errors or warnings.
POST data/diysap	Returns the recommendations, energy efficiency results and the 'soft' improvement measures (ways to save today).
POST data/epccosts	Returns 'EPC cost' energy assessment results - calculated using the latest fuel prices and regionalised weather data, along with any errors or warnings.
POST data/recommendations	Returns the improvement recommendations together with energy efficiency results - calculated using the latest fuel costs and regionalised weather data, along with any errors or warnings.

Batch

API	Description
POST batch	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format. Returns XML containing the batch ID. This call should be used when the SAP results are required.Used with GET methods to check the status and return results.
POST batch/sap	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format. Returns XML containing the batch ID. This call should be used when the SAP results are required.Used with GET methods to check the status and return results.
POST batch/epccosts	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format. Returns XML containing the batch ID. This call should be used when the regional EPC results are required.Used with GET methods to check the status and return results
POST batch/recommendations	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format.Returns XML containing the batch ID. The call is used when recommendations and EPC results are required. Used with GET methods to check the status and return results.
GET results/{jobId}	[Deprecated] Returns results and information (including any errors or warnings) for an individual property within a batch as identified using the JobID.
GET batch/{batchid}/results/{reference}	Returns results and information (including any errors or warnings) for one or more properties within a batch as identified using the Reference text field.
GET results/{batchid}/{reference}	[Deprecated] Returns results and information (including any errors or warnings) for one or more properties within a batch as identified using the Reference text field.
GET batch/{batchid}	Returns full batch results, JobIDs, and any errors or warnings, for all completed jobs in the batch. The output depends on which calculation mode (sap, epccosts or recommendations) was requested when posting data to the batch.
GET batch/{batchid}/results	Returns full batch results, JobIDs, and any errors or warnings, for all completed jobs in the batch. The output depends on which calculation mode (sap, epccosts or recommendations) was requested when posting data to the batch.
GET batch/{batchid}/status	Returns the progress of calculating the surveys in the batch.
GET batchstatus/{batchid}	[Deprecated] Returns the progress of calculating the surveys in the batch.
DELETE batch/{batchid}	Clears the batch of surveys and results
DELETE batchresults/{batchid}	[Deprecated] Clears the batch of surveys and results

V993

API	Description
POST v993/data/sap	Returns 'SAP' energy assessment results for one energy survey - calculated using the table 12 fuel prices and UK average weather, along with any errors or warnings.
POST v993/data/diysap	Returns the recommendations, energy efficiency results and the 'soft' improvement measures (ways to save today).
POST v993/data/epccosts	Returns 'EPC cost' energy assessment results - calculated using the latest fuel prices and regionalised weather data, along with any errors or warnings.
POST v993/data/recommendations	Returns the improvement recommendations together with energy efficiency results - calculated using the latest fuel costs and regionalised weather data, along with any errors or warnings.

V992

API	Description
POST v992/data/sap	Returns 'SAP' energy assessment results for one energy survey - calculated using the table 12 fuel prices and UK average weather, along with any errors or warnings.
POST v992/data/diysap	Returns the recommendations, energy efficiency results and the 'soft' improvement measures (ways to save today).
POST v992/data/epccosts	Returns 'EPC cost' energy assessment results - calculated using the latest fuel prices and regionalised weather data, along with any errors or warnings.
POST v992/data/recommendations	Returns the improvement recommendations together with energy efficiency results - calculated using the latest fuel costs and regionalised weather data, along with any errors or warnings.

V994

API	Description
POST v994/data/sap	Returns 'SAP' energy assessment results for one energy survey - calculated using the table 12 fuel prices and UK average weather, along with any errors or warnings.
POST v994/data/diysap	Returns the recommendations, energy efficiency results and the 'soft' improvement measures (ways to save today).
POST v994/data/epccosts	Returns 'EPC cost' energy assessment results - calculated using the latest fuel prices and regionalised weather data, along with any errors or warnings.
POST v994/data/recommendations	Returns the improvement recommendations together with energy efficiency results - calculated using the latest fuel costs and regionalised weather data, along with any errors or warnings.

V993Batch

API	Description
POST v993/batch/sap	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format. Returns XML containing the batch ID. This call should be used when the SAP results are required.Used with GET methods to check the status and return results.
POST v993/batch/epccosts	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format. Returns XML containing the batch ID. This call should be used when the regional EPC results are required.Used with GET methods to check the status and return results
POST v993/batch/recommendations	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format.Returns XML containing the batch ID. The call is used when recommendations and EPC results are required. Used with GET methods to check the status and return results.

V992Batch

API	Description
POST v992/batch/sap	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format. Returns XML containing the batch ID. This call should be used when the SAP results are required.Used with GET methods to check the status and return results.
POST v992/batch/epccosts	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format. Returns XML containing the batch ID. This call should be used when the regional EPC results are required.Used with GET methods to check the status and return results
POST v992/batch/recommendations	Send batch survey data using either NES RdSAP XML format or NES pocketed XML format.Returns XML containing the batch ID. The call is used when recommendations and EPC results are required. Used with GET methods to check the status and return results.