Here are the top reasons why Rheem's API is a great choice:

Increase Sales

With Rheem's API, you can offer full integration as a major selling point to your customers.

Easy to Integrate

Use Rheem's documentation and code samples to build data integration into your app in days. Need help? Give us a call.

Saves Time and Money

Rheem reduces support costs and saves developer time by eliminating the need for CSV parsing, data update logic, and FTP scripts.

Delight Your Customers

Distributors, Contractors and independent developers love how much simpler applications with Rheem are to manage and support.

The following table describes headers that can be used by various types of Rheem API REST requests

Header Name Description
Host The host for the api.
This header is required for HTTP 1.1 (most toolkits add this header automatically); optional for HTTP/1.0 requests.
Connection What type of connection the user-agent would prefer.
Accept Content-Types that are acceptable for the response
Origin Initiates a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response header) .
User-Agent The user agent string of the user agent
X-ClientID The ID of the Rheem API application. Users must request access to the ID from Rheem.
X-Timestamp The UTC time (the number of milliseconds between midnight of January 1, 1970 and the date/time of the request) Example: X-Timestamp: 1386860148718. This header is only required on PUT and POST requests. Your client must have an up to date clock for PUT and POST requests to work. If the difference between the X-Timestamp value and the time it is received by the server exceeds 500 milliseconds, the request will be rejected as a suspected REPLAY attack.
Authorization: Bearer: The information required for request authentication. For anonymous requests this header is not required.
Content-Type The content type of the resource in case the request content is in the body. Example: text/plain
Accept-Encoding List of acceptable encodings. See HTTP compression.
Accept-Language List of acceptable human languages for request.

Examples

A typical request header is identified below

GET http://atlwebdev100:8106/v1/eco/mylocations HTTP/1.1
Host: atlwebdev100:8106
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://s3.amazonaws.com
User-Agent: Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Authorization: Bearer: NjM1MjExNzM2MzQzNDY5MDYwMTEvMjcvMjAxMyA3OjI3OjE0IFBN
Content-Type: application/json; charset=utf-8
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8

The following table describes response headers that are common to most Rheem API responses.

Header Name Description
Content-Length The length of the request body in octets (8-bit bytes)
Content-Type The MIME type of the body of the request (used with POST and PUT requests)
Server The name of the server that created the response.
Type: String
Default: api.myrheem.com
Access-Control-Allow-Origin Specifying which web sites can participate in cross-origin resource sharing
Date The date and time that the message was sent

Examples

A typical response is identified below

HTTP/1.1 200 OK
Content-Length: 788
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Tue, 03 Dec 2013 20:41:45 GMT
[
  {
    "UserLocationId": x,
    "UserId": x,
    "LocationName": "Smith Home",
    "AddressLine1": "123 Main Street",
    "AddressLine2": "Apt 765",
    "City": "Atlanta",
    "State": "GA",
    "PostalCode": "30318",
  },
  {
    "UserLocationId": x,
    "UserId": x,
    "LocationName": "Jones Home",
    "AddressLine1": "123 Franklin Street",
    "AddressLine2": "Apt 123",
    "City": "Atlanta",
    "State": "GA",
    "PostalCode": "30318",
  }
]

Rheem ECONET supports many routes.

Available Routes

/v1/eco/authenticate

Description

The authenticate route is used to get secure access to the Rheem API.

Request

The authenticate route is used to get secure access to the Rheem API.

Request Parameters

Header Name Description
Host The host for the api.
This header is required for HTTP 1.1 (most toolkits add this header automatically); optional for HTTP/1.0 requests.
Connection What type of connection the user-agent would prefer.
Accept Content-Types that are acceptable for the response
Origin Initiates a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response header) .
User-Agent The user agent string of the user agent
Authorization: Basic The information required for request authentication. For anonymous requests this header is not required.
Content-Type The content type of the resource in case the request content is in the body. Example: text/plain
Accept-Encoding List of acceptable encodings. See HTTP compression.
Accept-Language List of acceptable human languages for request.

Request Headers

Header Name Description
Host The host for the api.
This header is required for HTTP 1.1 (most toolkits add this header automatically); optional for HTTP/1.0 requests.
Connection What type of connection the user-agent would prefer.
Accept Content-Types that are acceptable for the response
Origin Initiates a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response header) .
User-Agent The user agent string of the user agent
Authorization: Basic The information required for request authentication. For anonymous requests this header is not required.
Content-Type The content type of the resource in case the request content is in the body. Example: text/plain
Accept-Encoding List of acceptable encodings. See HTTP compression.
Accept-Language List of acceptable human languages for request.

Response

Response Headers

Example

A typical request is identified below


GET http://atlwebdev100:8106/v1/eco/authenticate HTTP/1.1
Host: atlwebdev100:8106
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://s3.amazonaws.com
User-Agent: Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Authorization: Basic YmlsbGhhaW5hdXRAZ21haWwuY29tOmplc3Nl
Content-Type: application/json; charset=utf-8
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8

A typical response is identified below

HTTP/1.1 200 OK
Content-Length: 54
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Tue, 03 Dec 2013 23:02:49 GMT

"NjM1MjExNzM2MzQzNDY5MDYwMTEvMjcvMjAxMyA3OjI3OjE0IFBN"

Sample code to call the Authenticate route with javascript

                                                
Sample.loginSubmitted = function () {
"use strict";
var basicAuthStr, webMethod;
basicAuthStr = 'Basic ' + window.btoa(jQuery('#tbEC_EmailAddress').val() + ':' + jQuery('#tbEC_Password').val());
RWPJS.EcoNetApp.lastUsedLogin = jQuery('#tbEC_EmailAddress').val();
webMethod = jQuery('#ddlDataSource').val() + '/v1/eco/authenticate';
$.ajax({
   type: "GET",
   async: true,
   url: webMethod,
   crossDomain: true,
   contentType: "application/json; charset=utf-8",
   dataType: "json",
   headers: { 'Authorization': basicAuthStr },
   success: function (msg) {
      Sample.handleLoginSubmitted(msg);
   },
   error: function (xhr, status, error) {
      if (xhr.status === 0 && status === 'error' && error === '') {
         alert('No response from server at: ' + this.url);
      } else {
         alert('Error: ' + error + '\nserver says: ' + xhr.responseText);
      }
   }
});
};

Rheem ECONET ...

Increase Sales

With Rheem's API, you can offer full integration as a major selling point to your customers.

Use Rheem's documentation and code samples to build data integration into your app in days. Need help? Give us a call.

Rheem reduces support costs and saves developer time by eliminating the need for CSV parsing, data update logic, and FTP scripts.

Distributors, Contractors and independent developers love how much simpler applications with Rheem are to manage and support.

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v3/oauth2/auth

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
response_type String
client_id String
redirect_uri String
scope String
state String
access_type String
approval_prompt String
login_hint String
include_granted_scopes String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
OAuth2__OutputType something for get

OAuth2__OutputType

Field Name Type
NotSureWhatGoesHere System.String

Examples

Example Request

GET http://io.myrheem.com/v3/oauth2/auth?response_type=value&client_id=value&redirect_uri=value&scope=value&state=value&access_type=value&approval_prompt=value&login_hint=value&include_granted_scopes=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      NotSureWhatGoesHere": "ABCDEF...",
   },
      NotSureWhatGoesHere": "ABCDEF...",
   }...
]

/v3/oauth2/authorize

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
postObj OAuth2Post__InputType

OAuth2Post__InputType

Field Name Type
username System.String
password System.String
redirectUrl System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
OAuth2LoginSuccess__OutputType A string containing a URL to the resource

OAuth2LoginSuccess__OutputType

Field Name Type
RedirectUrl System.String

Examples

Example Request

POST http://io.myrheem.com/v3/oauth2/authorize HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Content-Length: 296
Accept: application/json, text/javascript, */*; q=0.01
X-Timestamp: 1386951460559
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8
{
   "username":"Example String",
   "password":"Example String",
   "redirectUrl":"Example String"
}

Example Response

HTTP/1.1 202 Accepted
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

https://io.myrheem.com/v3/oauth2/authorize/12478

/v3/oauth2/token

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
postObj OAuth2TokenPost__InputType

OAuth2TokenPost__InputType

Field Name Type
code System.String
client_id System.String
client_secret System.String
redirect_uri System.String
grant_type System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
OAuth2Token__OutputType A string containing a URL to the resource

OAuth2Token__OutputType

Field Name Type
access_token System.String
token_type System.String
expires_in System.Int32
refresh_token System.String

Examples

Example Request

POST http://io.myrheem.com/v3/oauth2/token HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Content-Length: 296
Accept: application/json, text/javascript, */*; q=0.01
X-Timestamp: 1386951460559
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8
{
   "code":"Example String",
   "client_id":"Example String",
   "client_secret":"Example String",
   "redirect_uri":"Example String",
   "grant_type":"Example String"
}

Example Response

HTTP/1.1 202 Accepted
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

https://io.myrheem.com/v3/oauth2/token/12478

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/ahri/getoutdoormodellist

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
unitSearch String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
AHRIOutdoorModelStatus__OutputType something for get

AHRIOutdoorModelStatus__OutputType

Field Name Type
objAHRIData Rheem.WebAPI2.AHRIOutdoorModel__OutputItem[]

Examples

Example Request

GET http://io.myrheem.com/v1/ahri/getoutdoormodellist?unitSearch=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/ahri/getindoormodellist

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
unitSearch String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
AHRIIndoorModelStatus__OutputType something for get

AHRIIndoorModelStatus__OutputType

Field Name Type
objAHRIData Rheem.WebAPI2.AHRIIndoorModel__OutputItem[]

Examples

Example Request

GET http://io.myrheem.com/v1/ahri/getindoormodellist?unitSearch=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/ahri/getfurnacemodellist

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
unitSearch String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
AHRIFurnaceModelStatus__OutputType something for get

AHRIFurnaceModelStatus__OutputType

Field Name Type
objAHRIData Rheem.WebAPI2.AHRIFurnaceModel__OutputItem[]

Examples

Example Request

GET http://io.myrheem.com/v1/ahri/getfurnacemodellist?unitSearch=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/ahri/getahridata

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
unitSearch String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
AHRIDataStatus__OutputType something for get

AHRIDataStatus__OutputType

Field Name Type
objAHRIData Rheem.WebAPI2.AHRIDataContent__OutputItem[]

Examples

Example Request

GET http://io.myrheem.com/v1/ahri/getahridata?unitSearch=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/public/ahrilabel

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
jsonParamsIn String
top Int32
skip Int32

Int32

Field Name Type
MaxValue System.Int32
MinValue System.Int32

Int32

Field Name Type
MaxValue System.Int32
MinValue System.Int32

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
AHRIDataTypeSearchWithCounts_OutputType something for get

AHRIDataTypeSearchWithCounts_OutputType

Field Name Type
SearchCounts System.Collections.Generic.List`1[AHRIDataEntity.GetAHRIDataTypeSearchCounts_Result]
AHRIData Rheem.WebAPI2.GetAHRIData

Examples

Example Request

GET http://io.myrheem.com/v1/public/ahrilabel?jsonParamsIn=value&top=value&skip=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {


   },


   }...
]

/v1/public/ahrilabelsearch

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
jsonParamsIn String
top Int32
skip Int32

Int32

Field Name Type
MaxValue System.Int32
MinValue System.Int32

Int32

Field Name Type
MaxValue System.Int32
MinValue System.Int32

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
AHRIDataTypeSearchWithCounts_OutputType something for get

AHRIDataTypeSearchWithCounts_OutputType

Field Name Type
SearchCounts System.Collections.Generic.List`1[AHRIDataEntity.GetAHRIDataTypeSearchCounts_Result]
AHRIData Rheem.WebAPI2.GetAHRIData

Examples

Example Request

GET http://io.myrheem.com/v1/public/ahrilabelsearch?jsonParamsIn=value&top=value&skip=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {


   },


   }...
]

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/public/catalogaddendums

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
name String
brandName String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
CatalogAddendumsOutputType something for get

CatalogAddendumsOutputType

Field Name Type
CatalogAddendums System.Collections.Generic.List`1[MySqlEntity.GetCatalogAddendums_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/catalogaddendums?name=value&brandName=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

Public routes about Contractors are found here

/v1/public/contractors/getcontractorsbyzipandradius

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
PostalCode String
Radius String
bHeatCool Boolean
bWHRes Boolean
bWHComm Boolean
bWHTankless Boolean
bSolarWH Boolean
bHomeGen Boolean
bPoolSpa Boolean
bDesignStar Boolean
bKwikComfort Boolean
bPPlus Boolean
bCashback Boolean
bTC Boolean
bASP Boolean
bRheem Boolean
bRuud Boolean
bPHCC Boolean

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ContractorsZipAndRadiusOutputType something for get

ContractorsZipAndRadiusOutputType

Field Name Type
Contractors System.Collections.Generic.List`1[Rheem.WebAPI2.ContractorsZipAndRadiusDefinition]

Examples

Example Request

GET http://io.myrheem.com/v1/public/contractors/getcontractorsbyzipandradius?PostalCode=value&Radius=value&bHeatCool=value&bWHRes=value&bWHComm=value&bWHTankless=value&bSolarWH=value&bHomeGen=value&bPoolSpa=value&bDesignStar=value&bKwikComfort=value&bPPlus=value&bCashback=value&bTC=value&bASP=value&bRheem=value&bRuud=value&bPHCC=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/contractors/accontractorsfordistributorbyzipanddistance

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
DistributorID String
PostalCode String
Radius String
bRheem Boolean
bRuud Boolean

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ACContractorsOfDistributorZipAndRadiusOutputType something for get

ACContractorsOfDistributorZipAndRadiusOutputType

Field Name Type
Contractors System.Collections.Generic.List`1[Rheem.WebAPI2.ACContractorsOfDistributorZipAndRadiusDefinition]

Examples

Example Request

GET http://io.myrheem.com/v1/public/contractors/accontractorsfordistributorbyzipanddistance?DistributorID=value&PostalCode=value&Radius=value&bRheem=value&bRuud=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/contractors/getraypakpsrepsbystate

Description

This routine is called to get a list of contractor contacts who are responsible for sales of Raypak Pool and Spa in a given state

Remarks

Returns

Territory name, first and last names, phone#, email address, OrganizationName, Address, City, State, PostalCode, and a signature

Request Parameters

Parameter Name Type Description
State String The state you are interested in, MO = Missouri, IL = Illinois

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
GetRaypakPSRepsByState_OutputType something for get

GetRaypakPSRepsByState_OutputType

Field Name Type
RaypakPSRepsByState System.Collections.Generic.List`1[MySqlEntity.WAPI__GetRaypakPSRepsByState_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/contractors/getraypakpsrepsbystate?State=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/public/dotcom/footer

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
brand String
footerType String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
Footer__OutputType something for get

Footer__OutputType

Field Name Type
html System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/dotcom/footer?brand=value&footerType=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      html": "ABCDEF...",
   },
      html": "ABCDEF...",
   }...
]

/v1/public/dotcom/header

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
brand String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
Header__OutputType something for get

Header__OutputType

Field Name Type
html System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/dotcom/header?brand=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      html": "ABCDEF...",
   },
      html": "ABCDEF...",
   }...
]

/v1/public/dotcom/cssjs

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
brand String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
CssJs__OutputType something for get

CssJs__OutputType

Field Name Type
html System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/dotcom/cssjs?brand=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      html": "ABCDEF...",
   },
      html": "ABCDEF...",
   }...
]

This controller provides methods for all resources related to Public Glossary Routes

/v1/public/glossaries

Description

Get a list of Glossary Entries contained in the database.

Remarks

Returns

A list of objects of type Glossary

Request Parameters

Parameter Name Type Description
webFilter String An optional Website Name that identifies the website you want to filter on. Ex: Rheem.com

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
GlossaryOutputType something for get

GlossaryOutputType

Field Name Type
Glossaries System.Collections.Generic.List`1[Rheem.WebAPI2.OneGlossaryOutputType]

Examples

Example Request

GET http://io.myrheem.com/v1/public/glossaries?webFilter=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/public/news/getnews

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
numberofrows Int32

Int32

Field Name Type
MaxValue System.Int32
MinValue System.Int32

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
News_OutputType something for get

News_OutputType

Field Name Type
NewsList System.Collections.Generic.List`1[Rheem.WebAPI2.News_OutputItem]

Examples

Example Request

GET http://io.myrheem.com/v1/public/news/getnews?numberofrows=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/news/getnewshighlights

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
numberofrows Int32

Int32

Field Name Type
MaxValue System.Int32
MinValue System.Int32

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
NewsHighlight_OutputType something for get

NewsHighlight_OutputType

Field Name Type
NewsHightlightList System.Collections.Generic.List`1[Rheem.WebAPI2.NewsHighlight_OutputItem]

Examples

Example Request

GET http://io.myrheem.com/v1/public/news/getnewshighlights?numberofrows=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/news/getnewsbyid/{id}

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
id String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
News_OutputItem something for get

News_OutputItem

Field Name Type
NewsID System.String
Author System.String
PublicationDate System.DateTime
ModificationDate System.DateTime
Location System.String
IsLive System.Int32
NewsType System.String
NewsHeadline System.String
NewsContent System.String
PreviewHeadline System.String
PreviewContent System.String
AuthorPersonID System.String
CreateDateTime__Gen System.DateTime
UpdateDateTime__Gen System.DateTime

Examples

Example Request

GET http://io.myrheem.com/v1/public/news/getnewsbyid/{id} HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      NewsID": "ABCDEF...",
      Author": "ABCDEF...",
      PublicationDate": "2013-12-09T17:47:20",
      ModificationDate": "2013-12-09T17:47:20",
      Location": "ABCDEF...",

      NewsType": "ABCDEF...",
      NewsHeadline": "ABCDEF...",
      NewsContent": "ABCDEF...",
      PreviewHeadline": "ABCDEF...",
      PreviewContent": "ABCDEF...",
      AuthorPersonID": "ABCDEF...",
      CreateDateTime__Gen": "2013-12-09T17:47:20",
      UpdateDateTime__Gen": "2013-12-09T17:47:20",
   },
      NewsID": "ABCDEF...",
      Author": "ABCDEF...",
      PublicationDate": "2013-12-09T17:47:20",
      ModificationDate": "2013-12-09T17:47:20",
      Location": "ABCDEF...",

      NewsType": "ABCDEF...",
      NewsHeadline": "ABCDEF...",
      NewsContent": "ABCDEF...",
      PreviewHeadline": "ABCDEF...",
      PreviewContent": "ABCDEF...",
      AuthorPersonID": "ABCDEF...",
      CreateDateTime__Gen": "2013-12-09T17:47:20",
      UpdateDateTime__Gen": "2013-12-09T17:47:20",
   }...
]

/v1/public/news/getnewsbyheadline

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
headline String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
News_OutputItem something for get

News_OutputItem

Field Name Type
NewsID System.String
Author System.String
PublicationDate System.DateTime
ModificationDate System.DateTime
Location System.String
IsLive System.Int32
NewsType System.String
NewsHeadline System.String
NewsContent System.String
PreviewHeadline System.String
PreviewContent System.String
AuthorPersonID System.String
CreateDateTime__Gen System.DateTime
UpdateDateTime__Gen System.DateTime

Examples

Example Request

GET http://io.myrheem.com/v1/public/news/getnewsbyheadline?headline=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      NewsID": "ABCDEF...",
      Author": "ABCDEF...",
      PublicationDate": "2013-12-09T17:47:20",
      ModificationDate": "2013-12-09T17:47:20",
      Location": "ABCDEF...",

      NewsType": "ABCDEF...",
      NewsHeadline": "ABCDEF...",
      NewsContent": "ABCDEF...",
      PreviewHeadline": "ABCDEF...",
      PreviewContent": "ABCDEF...",
      AuthorPersonID": "ABCDEF...",
      CreateDateTime__Gen": "2013-12-09T17:47:20",
      UpdateDateTime__Gen": "2013-12-09T17:47:20",
   },
      NewsID": "ABCDEF...",
      Author": "ABCDEF...",
      PublicationDate": "2013-12-09T17:47:20",
      ModificationDate": "2013-12-09T17:47:20",
      Location": "ABCDEF...",

      NewsType": "ABCDEF...",
      NewsHeadline": "ABCDEF...",
      NewsContent": "ABCDEF...",
      PreviewHeadline": "ABCDEF...",
      PreviewContent": "ABCDEF...",
      AuthorPersonID": "ABCDEF...",
      CreateDateTime__Gen": "2013-12-09T17:47:20",
      UpdateDateTime__Gen": "2013-12-09T17:47:20",
   }...
]

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/public/requestpartnersaccount

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
Email String
FirstName String
LastName String
Phone String
Title String
RequestedUserId String
RequestedPassword String
WebSiteSendingRequest String
BrandRequested String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
HttpResponseMessage something for get

Examples

Example Request

GET http://io.myrheem.com/v1/public/requestpartnersaccount?Email=value&FirstName=value&LastName=value&Phone=value&Title=value&RequestedUserId=value&RequestedPassword=value&WebSiteSendingRequest=value&BrandRequested=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
   },
   }...
]

/v1/public/requestpartnersaccount

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
inputObj RequestPartnersAccount__InputType

RequestPartnersAccount__InputType

Field Name Type
Email System.String
FirstName System.String
LastName System.String
AddressLine1 System.String
AddressLine2 System.String
City System.String
State System.String
PostalCode System.String
Country System.String
Phone System.String
WebSiteSendingRequest System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
HttpResponseMessage A string containing a URL to the resource

Examples

Example Request

POST http://io.myrheem.com/v1/public/requestpartnersaccount HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Content-Length: 296
Accept: application/json, text/javascript, */*; q=0.01
X-Timestamp: 1386951460559
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8
{
   "Email":"somebody@gmail.com",
   "FirstName":"Example String",
   "LastName":"Example String",
   "AddressLine1":"Example String",
   "AddressLine2":"Example String",
   "City":"Example String",
   "State":"Example String",
   "PostalCode":"Example String",
   "Country":"Example String",
   "Phone":"Example String",
   "WebSiteSendingRequest":"Example String"
}

Example Response

HTTP/1.1 202 Accepted
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

https://io.myrheem.com/v1/public/requestpartnersaccount/12478

/v1/public/forgotmyrheemusername

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
EmailAddress String
Brand String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
HttpResponseMessage something for get

Examples

Example Request

GET http://io.myrheem.com/v1/public/forgotmyrheemusername?EmailAddress=value&Brand=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
   },
   }...
]

/v1/public/forgotmyrheempassword

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
UserName String
EmailAddress String
Brand String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
HttpResponseMessage something for get

Examples

Example Request

GET http://io.myrheem.com/v1/public/forgotmyrheempassword?UserName=value&EmailAddress=value&Brand=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
   },
   }...
]

/v1/public/resetmyrheempassword

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
FpID String
RequestedPassword String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
HttpResponseMessage something for get

Examples

Example Request

GET http://io.myrheem.com/v1/public/resetmyrheempassword?FpID=value&RequestedPassword=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
   },
   }...
]

Public routes about Products are found here

/v1/public/products/getbrandbyid

Description

Get a single Brand row by ID.

Remarks

Returns

An object of type Brand

Request Parameters

Parameter Name Type Description
id String Brand Id

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
GetBrands_Result something for get

GetBrands_Result

Field Name Type

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getbrandbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
   },
   }...
]

/v1/public/products/getbrands

Description

Get a list of Brands contained in the database.

Remarks

Returns

A list of objects of type Brand

Request Parameters

This route does not support input parameters.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
BrandsOutputType something for get

BrandsOutputType

Field Name Type
Brands System.Collections.Generic.IEnumerable`1[MySqlEntity.GetBrands_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getbrands HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getcategories

Description

Put documentation here for GetProductCategories

Remarks

Returns

A list of objects of type Product Category

Request Parameters

Parameter Name Type Description
categoryName String Category Name search parameter. If you do not wish to limit your search by Category Name, enter %.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
CategoriesOutputType something for get

CategoriesOutputType

Field Name Type
Categories System.Collections.Generic.IEnumerable`1[MySqlEntity.WAPI__ProductCategory__Get_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getcategories?categoryName=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getcategoriesbyid

Description

Get a single Product Category by ProductCategoryId

Remarks

Returns

An object of type Product Category

Request Parameters

Parameter Name Type Description
id String The ID that identifies the Product Category you are looking for.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
CategoriesOutputType something for get

CategoriesOutputType

Field Name Type
Categories System.Collections.Generic.IEnumerable`1[MySqlEntity.WAPI__ProductCategory__Get_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getcategoriesbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getproductbymodelnumber

Description

Get product model by AHRI model number and brand name

Remarks

If the model number pairings between Marketing Model Numbers and AHRI Model Numbers have not been accomplished, no data will be returned. Administrative personnel with access to the myrheem.com Products application can resolve this issue.

Returns

Product Model Object

Request Parameters

Parameter Name Type Description
AHRIModelNumber String AHRI model number
Brand String Brand name

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
GetProductByModelNumber__OutputType something for get

GetProductByModelNumber__OutputType

Field Name Type
ProductID System.String
BrandID System.String
ModelNumber System.String
BrandName System.String
Description System.String
ImageDocumentID System.String
ConsumerLiteratureDocumentID System.String
ModelsFound System.Collections.Generic.List`1[System.String]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getproductbymodelnumber?AHRIModelNumber=value&Brand=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      ProductID": "ABCDEF...",
      BrandID": "ABCDEF...",
      ModelNumber": "ABCDEF...",
      BrandName": "ABCDEF...",
      Description": "ABCDEF...",
      ImageDocumentID": "ABCDEF...",
      ConsumerLiteratureDocumentID": "ABCDEF...",

   },
      ProductID": "ABCDEF...",
      BrandID": "ABCDEF...",
      ModelNumber": "ABCDEF...",
      BrandName": "ABCDEF...",
      Description": "ABCDEF...",
      ImageDocumentID": "ABCDEF...",
      ConsumerLiteratureDocumentID": "ABCDEF...",

   }...
]

/v1/public/products/getmodels

Description

Get a list of Models that match the criteria of the params. All Parameters are optional.

Remarks

Returns

A list of Product Model objects

Request Parameters

Parameter Name Type Description
brandName String Brand Name of the Model
categoryName String Category Name of the Model
countryName String Country
groupName String Group Name
model String The Model name (RASL, 13AJM, 13AJ, etc.)
availableForLiterature Boolean If true, only return Products available for display on Literature, the default value is true
disabled Boolean If false, only NOT disabled products are returned. The default value is false.
ecoNetEnabled Boolean Optional Parameter, defaults to false, If TRUE only EcoNetEnabled products are returned, if false the EcoNetEnabled status is ignored.

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelsOutputType something for get

ModelsOutputType

Field Name Type
Models System.Collections.Generic.List`1[MySqlEntity.WAPI__Product__Get_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodels?brandName=value&categoryName=value&countryName=value&groupName=value&model=value&availableForLiterature=value&disabled=value&ecoNetEnabled=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/models

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
brandName String
categoryName String
countryName String
model String
availableForLiterature Boolean
disabled Boolean
ecoNetEnabled Boolean

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ProductModelsOutputType something for get

ProductModelsOutputType

Field Name Type
Models System.Collections.Generic.List`1[MySqlEntity.GetProductModels_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/models?brandName=value&categoryName=value&countryName=value&model=value&availableForLiterature=value&disabled=value&ecoNetEnabled=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodelbyid

Description

Get a single Model by ProductID.

Remarks

Returns

An object of type Product Model

Request Parameters

Parameter Name Type Description
id String Product ID of the Model as GUID

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
WAPI__Product__Get_Result something for get

WAPI__Product__Get_Result

Field Name Type

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodelbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
   },
   }...
]

/v1/public/products/getmodeldocumentsbyid

Description

Get Documents Associated with a Product

Remarks

Returns

A list of Product Model Document objects

Request Parameters

Parameter Name Type Description
id String The ProductID of the product you want documents for.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelDocumentsOutputType something for get

ModelDocumentsOutputType

Field Name Type
ModelDocuments System.Collections.Generic.List`1[Rheem.WebAPI2.ModelDocuments]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodeldocumentsbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodelimagesbyid

Description

Get Images Associated with a Product

Remarks

Returns

A list of Product Model Image objects

Request Parameters

Parameter Name Type Description
id String The ProductID of the product you want Images for.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelImagesOutputType something for get

ModelImagesOutputType

Field Name Type
ModelImages System.Collections.Generic.List`1[Rheem.WebAPI2.ModelImages]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodelimagesbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodelcertificationsbyid

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
id String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelCertificationsOutputType something for get

ModelCertificationsOutputType

Field Name Type
ModelCertifications System.Collections.Generic.IEnumerable`1[MySqlEntity.GetProductCertifications_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodelcertificationsbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodelnumbersbyid

Description

Get Model Numbers

Remarks

Returns

A list of Product Model Number objects

Request Parameters

Parameter Name Type Description
id String The productID you want to get the Models for

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelNumOutputType something for get

ModelNumOutputType

Field Name Type
MetaData System.Collections.Generic.List`1[Rheem.WebAPI2.ControllerMetaData]
DataOut System.Collections.Generic.List`1[System.Object]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodelnumbersbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {


   },


   }...
]

/v1/public/products/literaturedescription

Description

Get Literature records associated with a Model

Remarks

Returns

a list of Product Literature Records

Request Parameters

Parameter Name Type Description
prodId String The productID you want Literature records for.
brandName String Will limit the search to a specific brand, such as RHEEM.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
LiteratureDescriptionOutputType something for get

LiteratureDescriptionOutputType

Field Name Type
LiteratureDescription System.Collections.Generic.List`1[MySqlEntity.GetProductLiteratureDescriptions_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/literaturedescription?prodId=value&brandName=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodelbadgesbyid

Description

Get Badges Associated with a Model

Remarks

Returns

A list of Product Model Badge objects

Request Parameters

Parameter Name Type Description
id String The ProductId of the product you wish to search for.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelBadgesOutputType something for get

ModelBadgesOutputType

Field Name Type
ModelBadges System.Collections.Generic.IEnumerable`1[MySqlEntity.GetProductBadges_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodelbadgesbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodelpartsbyid

Description

Get Component Associated with a Model

Remarks

Returns

A list of Product Model Part objects

Request Parameters

Parameter Name Type Description
id String The model you want components for, such as RASL-024JEC. This search will look for any Models that start with RASL-024JEC

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelNumPartsOutputType something for get

ModelNumPartsOutputType

Field Name Type
ModelNumParts System.Collections.Generic.List`1[Rheem.WebAPI2.ModelParts]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodelpartsbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodelpartscomponents

Description

Get Component Associated with a Model

Remarks

Returns

A list of Product Model component objects

Request Parameters

Parameter Name Type Description
id String The model you want components for, such as RASL-024JEC. This search will look for any Models that start with RASL-024JEC

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
Components something for get

Components

Field Name Type
ComponentImages System.Collections.Generic.List`1[Rheem.WebAPI2.ComponentImageInfo]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodelpartscomponents?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getseries

Description

Get list of all Series contained in the database.

Remarks

Returns

A list of Series objects

Request Parameters

Parameter Name Type Description
brandID String An optional BrandId that identifies the Series you are looking for.
productCategoryID String An optional CategoryId that identifies the Series you are looking for.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
SeriesOutputType something for get

SeriesOutputType

Field Name Type
Series System.Collections.Generic.IEnumerable`1[MySqlEntity.GetSeries_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getseries?brandID=value&productCategoryID=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getseriesbyid

Description

Get a single Series by id

Remarks

Returns

An object of type Series

Request Parameters

Parameter Name Type Description
id String The ID that identifies the Series you are looking for.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
SeriesOutputType something for get

SeriesOutputType

Field Name Type
Series System.Collections.Generic.IEnumerable`1[MySqlEntity.GetSeries_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getseriesbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/modelwithmodelnumbers

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
BrandName String
CategoryName String
AvailableForLiterature Boolean
Disabled Boolean
bJustDistinct Boolean

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Boolean

Field Name Type
TrueString System.String
FalseString System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ModelWithModelNumbersOutputType something for get

ModelWithModelNumbersOutputType

Field Name Type
ModelsList System.Collections.Generic.List`1[MySqlEntity.WAPI__ProductModelsWithModelNumbers__Get_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/modelwithmodelnumbers?BrandName=value&CategoryName=value&AvailableForLiterature=value&Disabled=value&bJustDistinct=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/products/getmodeltagsbyid

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
id String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ProductTagOutputType something for get

ProductTagOutputType

Field Name Type
ProductTagList System.Collections.Generic.List`1[MySqlEntity.GetProductTags_Result]

Examples

Example Request

GET http://io.myrheem.com/v1/public/products/getmodeltagsbyid?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/public/tokens/refresh

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

This route does not support input parameters.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
Authenticate__OutputType something for get

Authenticate__OutputType

Field Name Type
AccessToken System.String
TokenType System.String
RefreshToken System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/tokens/refresh HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      AccessToken": "ABCDEF...",
      TokenType": "ABCDEF...",
      RefreshToken": "ABCDEF...",
   },
      AccessToken": "ABCDEF...",
      TokenType": "ABCDEF...",
      RefreshToken": "ABCDEF...",
   }...
]

MISSING CONTROLLER SUMMARY DOCUMENTATION IN CODE

/v1/public/test/ping

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

This route does not support input parameters.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
Ping__OutputType something for get

Ping__OutputType

Field Name Type
IntConstant System.Int32

Examples

Example Request

GET http://io.myrheem.com/v1/public/test/ping HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v3/public/test/rheemthings

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

This route does not support input parameters.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
RheemTest_OutputType something for get

RheemTest_OutputType

Field Name Type
Rows System.Collections.Generic.List`1[Rheem.WebAPI2.RheemTestOutputItemType]

Examples

Example Request

GET http://io.myrheem.com/v3/public/test/rheemthings HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v3/public/test/rheemthing

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
id String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
RheemTest_OutputType something for get

RheemTest_OutputType

Field Name Type
Rows System.Collections.Generic.List`1[Rheem.WebAPI2.RheemTestOutputItemType]

Examples

Example Request

GET http://io.myrheem.com/v3/public/test/rheemthing?id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v3/public/test/rheemthing/{id}

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
id String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
HttpResponseMessage A string indicating the status of the request

Examples

Example Request

DELETE http://io.myrheem.com/v3/public/test/rheemthing/{id} HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 18
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

["Object Deleted"]

/v3/public/test/rheemthing

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
savData RheemTest_InputType

RheemTest_InputType

Field Name Type
ID System.String
Number System.String
Description System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
RheemTest_OutputType A string containing a URL to the resource

RheemTest_OutputType

Field Name Type
Rows System.Collections.Generic.List`1[Rheem.WebAPI2.RheemTestOutputItemType]

Examples

Example Request

PUT http://io.myrheem.com/v3/public/test/rheemthing HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Content-Length: 296
Accept: application/json, text/javascript, */*; q=0.01
X-Timestamp: 1386951460559
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Authorization: Bearer: NjXXXXX0NDk4NTU4XXXXXXXXXXIvMTIvMjAxMyAXXXXXOjM1IFBN
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8
{
   "ID":"Example String",
   "Number":"Example String",
   "Description":"Example String"
}

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

https://io.myrheem.com/v3/public/test/rheemthing/12478

/v3/public/test/rheemthing

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
savData RheemTest_InputType

RheemTest_InputType

Field Name Type
ID System.String
Number System.String
Description System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
RheemTest_OutputType A string containing a URL to the resource

RheemTest_OutputType

Field Name Type
Rows System.Collections.Generic.List`1[Rheem.WebAPI2.RheemTestOutputItemType]

Examples

Example Request

POST http://io.myrheem.com/v3/public/test/rheemthing HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Content-Length: 296
Accept: application/json, text/javascript, */*; q=0.01
X-Timestamp: 1386951460559
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8
{
   "ID":"Example String",
   "Number":"Example String",
   "Description":"Example String"
}

Example Response

HTTP/1.1 202 Accepted
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

https://io.myrheem.com/v3/public/test/rheemthing/12478

Public routes about Warranties are found here

/v1/public/warranties/warrantyexpiration

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
serialNumber String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
WarrantyExpiration__OutputType something for get

WarrantyExpiration__OutputType

Field Name Type
IsExpired System.Boolean
ExpirationDate System.String
YearsTillExpires System.Int32
MonthsTillExpires System.Int32
DaysTillExpires System.Int32
ModelNumber System.String
Brand System.String
InstanceStatus System.String
ACWH System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/warrantyexpiration?serialNumber=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      IsExpired": false,
      ExpirationDate": "ABCDEF...",



      ModelNumber": "ABCDEF...",
      Brand": "ABCDEF...",
      InstanceStatus": "ABCDEF...",
      ACWH": "ABCDEF...",
   },
      IsExpired": false,
      ExpirationDate": "ABCDEF...",



      ModelNumber": "ABCDEF...",
      Brand": "ABCDEF...",
      InstanceStatus": "ABCDEF...",
      ACWH": "ABCDEF...",
   }...
]

/v1/public/warranties/validaterules

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
productIdInputObj ProductIdList__InputType

ProductIdList__InputType

Field Name Type
ProductIdArray System.Collections.Generic.List`1[System.String]

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ValidateWarrantyRules__OutputType A string containing a URL to the resource

ValidateWarrantyRules__OutputType

Field Name Type
AllRulesPassed System.Boolean
CanBeRegistered System.Boolean
RuleResults System.Collections.Generic.List`1[Rheem.WebAPI2.RuleResultType]

Examples

Example Request

POST http://io.myrheem.com/v1/public/warranties/validaterules HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Content-Length: 296
Accept: application/json, text/javascript, */*; q=0.01
X-Timestamp: 1386951460559
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8
{
   "ProductIdArray":not sure what to do for this type: System.Collections.Generic.List`1[System.String]
}

Example Response

HTTP/1.1 202 Accepted
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

https://io.myrheem.com/v1/public/warranties/validaterules/12478

/v1/public/warranties/registrationchecker

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
productid String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
RegistrationChecker_OutputType something for get

RegistrationChecker_OutputType

Field Name Type
CanBeRegistered System.Boolean
InstallationDate System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/registrationchecker?productid=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      CanBeRegistered": false,
      InstallationDate": "ABCDEF...",
   },
      CanBeRegistered": false,
      InstallationDate": "ABCDEF...",
   }...
]

/v1/public/warranties/getcategorynamesforrules

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
productid String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
GetRulesProductCategoryNames_OutputType something for get

GetRulesProductCategoryNames_OutputType

Field Name Type
RulesCategoryNameList System.Collections.Generic.List`1[System.String]

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/getcategorynamesforrules?productid=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/warranties/validatemodelwarrantyrule

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
unitProductId String
ruleModelProductId String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ValidateModelWarrantyRule_OutputType something for get

ValidateModelWarrantyRule_OutputType

Field Name Type
ValidatesRule System.Boolean

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/validatemodelwarrantyrule?unitProductId=value&ruleModelProductId=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      ValidatesRule": false,
   },
      ValidatesRule": false,
   }...
]

/v1/public/warranties/canberegisteredbyitself

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
product_id String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
CanBeRegisteredByItself_OutputType something for get

CanBeRegisteredByItself_OutputType

Field Name Type
CanBeRegistered System.Boolean

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/canberegisteredbyitself?product_id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      CanBeRegistered": false,
   },
      CanBeRegistered": false,
   }...
]

/v1/public/warranties/VerifyMetrix

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
productId1 String
productId2 String
productId3 String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
VerifyMetrix_OutputType something for get

VerifyMetrix_OutputType

Field Name Type
ValidatesMetrix System.Boolean

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/VerifyMetrix?productId1=value&productId2=value&productId3=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      ValidatesMetrix": false,
   },
      ValidatesMetrix": false,
   }...
]

/v1/public/warranties/registerunits

Description

Register warranty for multiple units by Instance ID

Remarks

Returns

HttpResponseMessage

Request Parameters

Parameter Name Type Description
input RegisterUnitsInputType RegisterUnitsInputType

RegisterUnitsInputType

Field Name Type
Units System.Collections.Generic.List`1[Rheem.WebAPI2.oneUnitInputType]
InstallationDate System.String
OwnerName System.String
OwnerLastName System.String
OwnerAddressLine1 System.String
OwnerAddressLine2 System.String
OwnerCity System.String
OwnerState System.String
OwnerCountry System.String
OwnerPostalCode System.String
OwnerPhone System.String
OwnerEmail System.String
ContractorOrgName System.String
ContractorName System.String
ContractorLastName System.String
ContractorAddressLine1 System.String
ContractorAddressLine2 System.String
ContractorCity System.String
ContractorState System.String
ContractorCountry System.String
ContractorPostalCode System.String
ContractorPhone System.String
ContractorEmail System.String
Brand System.String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
HttpResponseMessage A string containing a URL to the resource

Examples

Example Request

POST http://io.myrheem.com/v1/public/warranties/registerunits HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Content-Length: 296
Accept: application/json, text/javascript, */*; q=0.01
X-Timestamp: 1386951460559
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-ClientID: 4660422047764.apps.rheemapi.com
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8
{
   "Units":not sure what to do for this type: System.Collections.Generic.List`1[Rheem.WebAPI2.oneUnitInputType],
   "InstallationDate":"Example String",
   "OwnerName":"Example String",
   "OwnerLastName":"Example String",
   "OwnerAddressLine1":"Example String",
   "OwnerAddressLine2":"Example String",
   "OwnerCity":"Example String",
   "OwnerState":"Example String",
   "OwnerCountry":"Example String",
   "OwnerPostalCode":"Example String",
   "OwnerPhone":"Example String",
   "OwnerEmail":"somebody@gmail.com",
   "ContractorOrgName":"Example String",
   "ContractorName":"Example String",
   "ContractorLastName":"Example String",
   "ContractorAddressLine1":"Example String",
   "ContractorAddressLine2":"Example String",
   "ContractorCity":"Example String",
   "ContractorState":"Example String",
   "ContractorCountry":"Example String",
   "ContractorPostalCode":"Example String",
   "ContractorPhone":"Example String",
   "ContractorEmail":"somebody@gmail.com",
   "Brand":"Example String"
}

Example Response

HTTP/1.1 202 Accepted
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

https://io.myrheem.com/v1/public/warranties/registerunits/12478

/v1/public/warranties/printcertificate

Description

Generate/Print Warranty Certificate

Remarks

Returns

GeneratePrintWarrantyCertificateResultType

Request Parameters

Parameter Name Type Description
serialNumber String Serial Number of equipment
emailAddresses String This is an optional parameter, it should contain a list of comma seperated email addresses to send an email with the Generated PDF

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
GeneratePrintWarrantyCertificateResultType something for get

GeneratePrintWarrantyCertificateResultType

Field Name Type
CertificateURL System.String
Homeowner Rheem.WebAPI2.WarrantyPDFHomeOwnerType
Contractor Rheem.WebAPI2.WarrantyPDFContractorType
Units System.Collections.Generic.List`1[Rheem.WebAPI2.WarrantyPDFUnitType]

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/printcertificate?serialNumber=value&emailAddresses=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      CertificateURL": "ABCDEF...",



   },
      CertificateURL": "ABCDEF...",



   }...
]

/v1/public/warranties/validateserialnumber

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
SerialNumber String
brand String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
ValidateSerialsResultType something for get

ValidateSerialsResultType

Field Name Type
ModelNumber System.String
PartialFlag System.Boolean
Registered System.Boolean
InstanceID System.String
ProductID System.String
GroupName System.String
DocumentID System.String
IsCanadian System.Boolean
EquipmentType System.String
CategoryName System.String
ProductGroupId System.String
ProductSeries System.String
BrandName System.String
Subbrand System.String
ManufacturingDate System.String
SubbrandWarrantyType System.String
MarketingModel System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/validateserialnumber?SerialNumber=value&brand=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      ModelNumber": "ABCDEF...",
      PartialFlag": false,
      Registered": false,
      InstanceID": "ABCDEF...",
      ProductID": "ABCDEF...",
      GroupName": "ABCDEF...",
      DocumentID": "ABCDEF...",
      IsCanadian": false,
      EquipmentType": "ABCDEF...",
      CategoryName": "ABCDEF...",
      ProductGroupId": "ABCDEF...",
      ProductSeries": "ABCDEF...",
      BrandName": "ABCDEF...",
      Subbrand": "ABCDEF...",
      ManufacturingDate": "ABCDEF...",
      SubbrandWarrantyType": "ABCDEF...",
      MarketingModel": "ABCDEF...",
   },
      ModelNumber": "ABCDEF...",
      PartialFlag": false,
      Registered": false,
      InstanceID": "ABCDEF...",
      ProductID": "ABCDEF...",
      GroupName": "ABCDEF...",
      DocumentID": "ABCDEF...",
      IsCanadian": false,
      EquipmentType": "ABCDEF...",
      CategoryName": "ABCDEF...",
      ProductGroupId": "ABCDEF...",
      ProductSeries": "ABCDEF...",
      BrandName": "ABCDEF...",
      Subbrand": "ABCDEF...",
      ManufacturingDate": "ABCDEF...",
      SubbrandWarrantyType": "ABCDEF...",
      MarketingModel": "ABCDEF...",
   }...
]

/v1/public/warranties/certificatefromextdata

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
cAddr1 String
cAddr2 String
cCity String
cEmail String
cName String
cOrgName String
cPhone String
cZip String
cState String
hAddr1 String
hAddr2 String
hCity String
hEmail String
hFirstName String
hLastName String
hPhone String
hZip String
hState String
installDate String
brand String
registDate String
model String
serialNum String
unitType String
emailAddresses String
model2 String
unitType2 String
serialNum2 String
installDate2 String
model3 String
unitType3 String
serialNum3 String
installDate3 String
model4 String
unitType4 String
serialNum4 String
installDate4 String
model5 String
unitType5 String
serialNum5 String
installDate5 String
model6 String
unitType6 String
serialNum6 String
installDate6 String
model7 String
unitType7 String
serialNum7 String
installDate7 String
model8 String
unitType8 String
serialNum8 String
installDate8 String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
WarrantyCertificateOutputType something for get

WarrantyCertificateOutputType

Field Name Type
WarrantyUrl System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/certificatefromextdata?cAddr1=value&cAddr2=value&cCity=value&cEmail=value&cName=value&cOrgName=value&cPhone=value&cZip=value&cState=value&hAddr1=value&hAddr2=value&hCity=value&hEmail=value&hFirstName=value&hLastName=value&hPhone=value&hZip=value&hState=value&installDate=value&brand=value®istDate=value&model=value&serialNum=value&unitType=value&emailAddresses=value&model2=value&unitType2=value&serialNum2=value&installDate2=value&model3=value&unitType3=value&serialNum3=value&installDate3=value&model4=value&unitType4=value&serialNum4=value&installDate4=value&model5=value&unitType5=value&serialNum5=value&installDate5=value&model6=value&unitType6=value&serialNum6=value&installDate6=value&model7=value&unitType7=value&serialNum7=value&installDate7=value&model8=value&unitType8=value&serialNum8=value&installDate8=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      WarrantyUrl": "ABCDEF...",
   },
      WarrantyUrl": "ABCDEF...",
   }...
]

/v1/public/warranties/rulecategoriesandmodels

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
ruleid String
brandName String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
WarrantyRules_OutputType something for get

WarrantyRules_OutputType

Field Name Type
warrantyRulesList System.Collections.Generic.List`1[Rheem.WebAPI2.WarrantyRules_OutputItem]

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/rulecategoriesandmodels?ruleid=value&brandName=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/warranties/warrantyrulechoices

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
product_id String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
WarrantyRulesChoices_OutputType something for get

WarrantyRulesChoices_OutputType

Field Name Type
warrantyRuleChoiceList System.Collections.Generic.List`1[Rheem.WebAPI2.WarrantyRulesChoices_OutputItem]

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/warrantyrulechoices?product_id=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/warranties/rulecategoriesandmodelsreverse

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
prodId String
brandName String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
WarrantyRules_OutputType something for get

WarrantyRules_OutputType

Field Name Type
warrantyRulesList System.Collections.Generic.List`1[Rheem.WebAPI2.WarrantyRules_OutputItem]

Examples

Example Request

GET http://io.myrheem.com/v1/public/warranties/rulecategoriesandmodelsreverse?prodId=value&brandName=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

This controller provides methods for all resources related to Time Zones

/v1/public/timezones

Description

Get time zones supported by Rheem API

Remarks

Returns

A list of time zone objects

Request Parameters

This route does not support input parameters.

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
TimeZone__OutputType something for get

TimeZone__OutputType

Field Name Type
TimeZoneList System.Collections.Generic.List`1[Rheem.WebAPI2.TimeZone__OutputItem]

Examples

Example Request

GET http://io.myrheem.com/v1/public/timezones HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {

   },

   }...
]

/v1/public/latlongbyzip

Description

MISSING METHOD SUMMARY DOCUMENTATION IN CODE

Remarks

Returns

Request Parameters

Parameter Name Type Description
PostalCode String

Response

This route returns the following response.

Response Elements

The method returns the following elements.

Response Type Description
LatLong__OutputType something for get

LatLong__OutputType

Field Name Type
Latitude System.String
Longitude System.String

Examples

Example Request

GET http://io.myrheem.com/v1/public/latlongbyzip?PostalCode=value HTTP/1.1
Host: io.myrheem.com
Connection: keep -alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.Example.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
Content-Type: application/json; charset=UTF-8
Accept -Encoding : gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

Example Response

HTTP/1.1 200 OK
Content-Length: 597
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: https://s3.amazonaws.com
Date: Mon, 16 Dec 2013 15:55:23 GMT

[
   {
      Latitude": "ABCDEF...",
      Longitude": "ABCDEF...",
   },
      Latitude": "ABCDEF...",
      Longitude": "ABCDEF...",
   }...
]