EUROTECH Everyware Cloud API: Reports

GET /reports

Request Parameters
name	type	description	default
endDate	query
startDate	query

Response Body
media type	data type	description
application/json	BillingReport (JSON)
application/xml	billingReport (XML)

Example

Request

GET /reports
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "BillingReportItems" : [ {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  }, {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  } ],
  "reportItems" : [ {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  }, {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  } ]
}

POST /reports

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Example

Request

POST /reports
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /reports/expiring

Request Parameters
name	type	description	default	constraints
numDays	query		7	required

Response Body
media type	data type	description
application/json	ExpiringAccountsResult (JSON)
application/xml	expiringAccountsResult (XML)

Example

Request

GET /reports/expiring
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "checkupDate" : 12345,
  "expirationDaysThreshold" : 12345,
  "numTotalAccounts" : 12345,
  "numActiveAccounts" : 12345,
  "numExpiringAccounts" : 12345,
  "numGraceAccounts" : 12345,
  "numExpiredAccounts" : 12345,
  "expiringAccount" : [ {
    "accountId" : 12345,
    "accountName" : "...",
    "expiration" : 12345,
    "daysToExpire" : 12345,
    "gracePeriod" : 12345,
    "graceExpiration" : 12345,
    "notificationEmail" : "...",
    "notificationStatus" : "SKIPPED",
    "notificationInfo" : "..."
  }, {
    "accountId" : 12345,
    "accountName" : "...",
    "expiration" : 12345,
    "daysToExpire" : 12345,
    "gracePeriod" : 12345,
    "graceExpiration" : 12345,
    "notificationEmail" : "...",
    "notificationStatus" : "ERROR",
    "notificationInfo" : "..."
  } ]
}

POST /reports/expiring

Request Parameters
name	type	description	default	constraints
numDays	query		7	required

Response Body
media type	data type	description
application/json	ExpiringAccountsResult (JSON)
application/xml	expiringAccountsResult (XML)

Example

Request

POST /reports/expiring
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "checkupDate" : 12345,
  "expirationDaysThreshold" : 12345,
  "numTotalAccounts" : 12345,
  "numActiveAccounts" : 12345,
  "numExpiringAccounts" : 12345,
  "numGraceAccounts" : 12345,
  "numExpiredAccounts" : 12345,
  "expiringAccount" : [ {
    "accountId" : 12345,
    "accountName" : "...",
    "expiration" : 12345,
    "daysToExpire" : 12345,
    "gracePeriod" : 12345,
    "graceExpiration" : 12345,
    "notificationEmail" : "...",
    "notificationStatus" : "NOT_SENT",
    "notificationInfo" : "..."
  }, {
    "accountId" : 12345,
    "accountName" : "...",
    "expiration" : 12345,
    "daysToExpire" : 12345,
    "gracePeriod" : 12345,
    "graceExpiration" : 12345,
    "notificationEmail" : "...",
    "notificationStatus" : "SENT",
    "notificationInfo" : "..."
  } ]
}

GET /reports/{accountId}

Request Parameters
name	type	constraints
accountId	path	required
endDate	query
startDate	query

Response Body
media type	data type	description
application/json	BillingReport (JSON)
application/xml	billingReport (XML)

Example

Request

GET /reports/{accountId}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "BillingReportItems" : [ {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  }, {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  } ],
  "reportItems" : [ {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  }, {
    "startDate" : 12345,
    "endDate" : 12345,
    "accountId" : 12345,
    "accountName" : "...",
    "parentId" : 12345,
    "parentName" : "...",
    "parentOrgName" : "...",
    "accountOrgEmail" : "...",
    "brokerDeploymentId" : "...",
    "brokerType" : "...",
    "accountCreatedOn" : 12345,
    "servicePlanExpirationDate" : 12345,
    "servicePlanMaxChildAccounts" : 12345,
    "childAccountsNumber" : 12345,
    "servicePlanMaxNumberProvisionRequest" : 12345,
    "provisionRequestsNumber" : 12345,
    "servicePlanMaxDeviceJob" : 12345,
    "deviceJobsNumber" : 12345,
    "servicePlanMaxDevicesNumber" : 12345,
    "devicesNumber" : 12345,
    "servicePlanVpnConnections" : 12345,
    "vpnConnectionsNumber" : 12345,
    "servicePlanMaxRulesNumber" : 12345,
    "rulesNumber" : 12345,
    "servicePlanDataTtl" : 12345,
    "servicePlanRxByteLimit" : 12345,
    "dataNumRxBytes" : 12345,
    "dataNumRxMessages" : 12345,
    "slaAvg" : 12345
  } ]
}

Reports Resource

GET /reports

Example

Request

Response

POST /reports

Example

Request

Response

GET /reports/expiring

Example

Request

Response

POST /reports/expiring

Example

Request

Response

GET /reports/{accountId}

Example

Request

Response