header.banner.text
Web Service Documentation / Categories / Property Services / Add Sample Properties from a Specific Major Release
Add Sample Properties from a Specific Major Release
Updated on December 9, 2024
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. Thesee properties reflect changes from a specific major release. At this time, only sample properties that reflect changes in the 23.0 release and after are supported. This web service is only available within the Test environment.
Version
24.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 24.0 release.
POST /createSampleProperties/24?countryCode=US
The following example creates Canadian properties that are specific to the changes in the 24.0 release.
POST /createSampleProperties/24?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"/>
