Checks the connection status for a Portfolio Manager account
Use this endpoint to verify whether a connection request has been accepted by the
specified Portfolio Manager account. Requires ENERGY STAR Submissions Manage permission.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| pmUserName | The Portfolio Manager username to check connection status for | string | Optional |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
AccountConnectionStatusResponseV202110
| Property | Description | Type |
|---|---|---|
| connectable | When true this database is connectable to Portfolio Manager | boolean |
| otherDatabaseRegistered | Whether some other database is registered to portfolio manager or not | boolean |
Example Response
{ "connectable": false, "otherDatabaseRegistered": false
}