POST /api/v202407/import/esareading

This endpoint allows the import of an ESA reading import file. The file should be a base64-encoded file with a UTF8 character set.

ImportEsaReadingWithProfileV202407 Permissions: Meters (Create)

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, including the request body.

Request Body

EsaReadingImportRequest
Property Description Type
completeWithErrorsNotificationType The type of notification to send when the import is completed with errors. Default is “SystemMessages”. Must be a valid value for NotificationTypeEnum: SystemMessages = 1, BillImportAutomation = 2, BillExportToApAutomation = 3, IntervalDataAutomation = 4, UserGroupMessages = 5, UpdatesAndNewFeatures = 6, HelpArticlesTipsAndSuggestions = 7, CustomerServiceMessages = 8, EnergyStarSubmissionFailures = 9, BillExportToGlAutomation = 10, AutomaticallyCreatedMetersOrAccounts = 11, ExceededLicensedObjectCount = 12, BillCaptureAutomation = 13, TrendInsights = 14, ESADataImports = 15 integer (int32)
fileContent The base64 encoded file Required string
fileName FileName for the import file. Should include extension. The extension allows the importer to read the data in the proper format (csv, xlsx, zip) Required string
importNote Optional note/comment. string
inlineProfile EsaReadingImportProfile
EsaReadingImportProfile properties
Property Description Type
channelImportId ColumnNumberOrOverrideValueString
ColumnNumberOrOverrideValueString properties
Property Description Type
columnNumber Column number integer (int32)
overrideValue The value of the column string
dataPointImportId ColumnNumberOrOverrideValueString
ColumnNumberOrOverrideValueString properties
Property Description Type
columnNumber Column number integer (int32)
overrideValue The value of the column string
dateColumnNumber The number of the column that holds the date Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 integer (int32)
dateFormat The format for the date of the readings. An example is MM/dd/yyyy Only one of DateFormat, DateTimeFormat can be set string
dateTimeColumnNumber The number of the column that holds the Date and Time Mandatory when Date Time Format column is provided Required when DateTimeFormat is set Must be between 1 and 104 integer (int32)
dateTimeFormat The format for the Date and Time of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz Only one of DateFormat, DateTimeFormat can be set Only one of TimeFormat, DateTimeFormat can be set string
decimalSeparator The string that represents how the decimal values are separated Must be between 1 and 2 characters One of ‘,’, ‘.’ Case sensitive string
delimiter The string that represents how the file contents are delimited Required Must be between 1 and 2 characters string
estimated Estimated
Estimated properties
Property Description Type
columnNumber Column number specifying where to look for the estimated indicator Required Must be between 1 and 2147483647 integer (int32)
indicator The string used to indicate the reading is estimated If this value is found in the column number specified the reading will be marked as estimated Example: e, E, 1, 0, est, *, this is my estimated read Required string
interval ColumnNumberOrOverrideValueNullableInt32
ColumnNumberOrOverrideValueNullableInt32 properties
Property Description Type
columnNumber Column number integer (int32)
overrideValue The value of the column integer (int32)
intervalDataTypes A list of columns from the import sheet with their observation type and unit Cannot be Empty NULL Valid Required when DataPointImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set EsaReadingImportProfileColumn[]
EsaReadingImportProfileColumn properties
Property Description Type
columnNumber The number of the column Must be between 1 and 104 integer (int32)
observationTypeCode The observation type code of the reading Required Must be between 0 and 16 characters string
numberOfHeaderRows Number of header rows before the data begins (Skip Rows) Required Must be between 0 and 2147483647 integer (int32)
readingNoteColumnNumber Column number that holds a note to be stored with the reading Must be between 1 and 104 integer (int32)
readingValueColumnNumber Column number that holds reading value to be imported onto the ChannelImportId Must be between 1 and 104 Required when ChannelImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set integer (int32)
timeColumnNumber The number of the column that holds the time Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 integer (int32)
timeFormat The format for the time of the readings. An example is mm:hh:ss:zzz Mandatory when Date Format column is provided Required when DateFormat is set Only one of TimeFormat, DateTimeFormat can be set string
timeZoneId The time zone for the import profile integer (int32)
profileInfo Name of the import profile Must be between 0 and 64 characters Only one of ProfileInfo, InlineProfile can be set string
Example Request Body application/json 
{  "completeWithErrorsNotificationType": 1,  "fileContent": "string",  "fileName": "string",  "importNote": "string",  "inlineProfile": {    "channelImportId": {      "columnNumber": 1,      "overrideValue": "string"
    },    "dataPointImportId": {      "columnNumber": 1,      "overrideValue": "string"
    },    "dateColumnNumber": 1,    "dateFormat": "string",    "dateTimeColumnNumber": 1,    "dateTimeFormat": "string",    "decimalSeparator": "string",    "delimiter": "string",    "estimated": {      "columnNumber": 1,      "indicator": "string"
    },    "interval": {      "columnNumber": 1,      "overrideValue": 1
    },    "intervalDataTypes": [
      {      "columnNumber": 1,      "observationTypeCode": "string"
    }
    ],    "numberOfHeaderRows": 1,    "readingNoteColumnNumber": 1,    "readingValueColumnNumber": 1,    "timeColumnNumber": 1,    "timeFormat": "string",    "timeZoneId": 1
  },  "profileInfo": "string"
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

DetailedGuidResponse
Property Description Type
fileName The name of the file that was uploaded string
taskGUId A guid that identifies the current task string (uuid)
Example Response application/json 
[
  {    "fileName": "string",    "taskGUId": "string"
  }
]