Carrier Open Access Alliance Program

Infinity®/Evolution® Systems Open API

©2023 Carrier Corporation
Proprietary Information

To familiarize yourself with the technical specifications of this interface, please see the Specification and Getting Started Guides linked above. This page serves as a reference guide for the resources available.

/user

get

(Requires: Read-User)
Description

Returns information about the authorized user.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/user/locations

get

(Requires: Read-User)
Description

Returns a list of locations and systems belonging to the authorized user.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/locations/{id}

get

(Requires: Read-User)
Description

Returns information about the specified location.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}

get

(Requires: Read-System)
Description

Returns profile, configuration, and dealer information for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/status

get

(Requires: Read-System)
Description

Returns status information for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/profile

get

(Requires: Read-System)
Description

Returns profile information for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/config

get

(Requires: Read-System)
Description

Returns configuration information for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

put

(Requires: Write-System)
Description

Updates configuration information about the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
JSON / XML
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

/systems/{serialNumber}/energy

get

(Requires: Read-System)
Description

Returns energy usage information for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/dealer

get

(Requires: Read-System)
Description

Returns servicing dealer information for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/odu_config

get

(Requires: Read-Equip)
Description

Returns configuration information for the specified system's outdoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/odu_status

get

(Requires: Read-Equip)
Description

Returns status information for the specified system's outdoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

delete

(Requires: Read-Equip)
Description

Requests updated status information for the specified system's outdoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

/systems/{serialNumber}/odu_faults

get

(Requires: Read-Equip)
Description

Returns fault information for the specified system's outdoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/idu_config

get

(Requires: Read-Equip)
Description

Returns configuration information for the specified system's indoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/idu_status

get

(Requires: Read-Equip)
Description

Returns status information for the specified system's indoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

delete

(Requires: Read-Equip)
Description

Requests updated status information for the specified system's indoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

/systems/{serialNumber}/idu_faults

get

(Requires: Read-Equip)
Description

Returns fault information for the specified system's indoor unit.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/history

get

(Requires: Read-Equip)
Description

Returns historical information about the operation of the specified system and its components.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/equipment_events

get

(Requires: Read-Equip)
Description

Returns information about equipment events for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/root_cause

get

(Requires: Read-Equip)
Description

Returns root cause information about faults for the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

/systems/{serialNumber}/utility_events

get

(Requires: Read-UtilityEvents)
Description

Returns information about demand response events that apply to the specified system.

Security Schemes

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.

JSON / XML

post

(Requires: Write-UtilityEvents)
Description

Creates a new demand response event that will apply to the specified system.

Security Schemes

Additional Traits

Utility Client

Request
Headers

  • Authorization

    Required

    Used to send an OAuth 2.0 access token. The client should obtain an access token through the authorization process specified in the OAuth 2.0 Specification.

    Bearer KM2hwrAgzZzKliDNocKwKQ==
Response
Status Codes

  • 200

    The request was successful.

  • 400

    The request was bad. This can occur for the following reasons:

    • The Authorization header was missing from the request.
    • The request could not be understood by the server due to malformed syntax.

    Regardless of the reason, the client should not repeat the request without modifications.

  • 401

    The Authorization header contained an access token that was invalid. This can happen for the following reasons:

    • The access token was not readable.
    • The access token has expired.

    Regardless of the reason, the client should use the associated refresh token to request a new access token. If the refresh fails, the user may have revoked the client's access, and the client may need to follow the initial authorization process.

  • 403

    Although the access token was valid, it does not have access to the requested resource.

  • 404

    The requested resource was not found.

  • 405

    The request method is not supported for this resource. The response will contain an Allow header that specifies the supported methods.

  • 406

    The requested resource cannot be returned according to the request's Accept header.