Web Service Documentation / Categories / Property Services / Add Sample Properties from a Specific Major Release

Add Sample Properties from a Specific Major Release

Updated on July 25, 2023

Description

This web service creates a set of sample properties in your account from the pool of sample properties defined by EPA and NRCan respectively. These properties reflect changes from a specific major release. At this time, only sample properties that reflect changes in the 23.0 release are supported and are listed below. This web service is only available within the Test environment.

23.0 US Properties
  • EPA Sample Fast Food
  • EPA Sample Restaurant
  • EPA Sample Vehicle Dealership
  • EPA Sample Vehicle Repair Services
  • EPA Sample Pre-school/Daycare
  • EPA Sample Manufacturing/Industrial Plant
  • EPA Sample Green Power


23.0 Canadian Properties
  • NRCAN/RNCAN Sample Fast Food
  • NRCAN/RNCAN Sample Restaurant
  • NRCAN/RNCAN Sample Vehicle Dealership
  • NRCAN/RNCAN Sample Vehicle Repair Services
  • NRCAN/RNCAN Sample Pre-school/Daycare
  • NRCAN/RNCAN Sample Manufacturing/Industrial Plant
  • NRCAN/RNCAN Sample Green Power

Version

23.0

HTTP Method

POST

Resource URL

/createSampleProperties/{major-release-version}?countryCode=(countryCode)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
countryCode Optional. Indicates the country to create sample properties from. Valid values are US or CA. Default is US.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Requests

The following example creates US properties that are specific to the changes in the 23.0 release.

POST  /createSampleProperties/23?countryCode=US

The following example creates Canadian properties that are specific to the changes in the 23.0 release.

POST  /createSampleProperties/23?countryCode=CA

Example Response

The following example shows that the sample properties were successfully created.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>
TEST