GET api/ping

Get information about API version and the subsystems which are being used.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

PingResponse
NameDescriptionTypeAdditional information
Version

Version of the API assembly.

string

None.

DatabaseName

Name of the database.

string

None.

CustomerWebApiBaseUrl

Base URL for the customer web's API.

string

None.

CacheEndPoint

End point for the cache.

string

None.

CloudEnvironmentIsAvailable

If CloudEnvironment is available.

boolean

None.

UseDummyDevices

If we must use dummy devices in this configuration.

boolean

None.

DummyMeterId

Dummy meter ID.

string

None.

DummyAssetId

Dummy asset ID.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Version": "sample string 1",
  "DatabaseName": "sample string 2",
  "CustomerWebApiBaseUrl": "sample string 3",
  "CacheEndPoint": "sample string 4",
  "CloudEnvironmentIsAvailable": true,
  "UseDummyDevices": true,
  "DummyMeterId": "sample string 7",
  "DummyAssetId": 8
}

text/html

Sample:
{"$id":"1","Version":"sample string 1","DatabaseName":"sample string 2","CustomerWebApiBaseUrl":"sample string 3","CacheEndPoint":"sample string 4","CloudEnvironmentIsAvailable":true,"UseDummyDevices":true,"DummyMeterId":"sample string 7","DummyAssetId":8}