Get Advanced Temperature Events API

This API fetches and delivers Advanced Temperature Monitoring events to a customer's data lake/business system. It can be used for the following use cases:

Field operations act on Advanced Temperature Monitoring recommendations, out of the business system (work order management system).

Get Bulk request and response examples

Used to request a large data file in the format of your choice (Parquet, Orc, Json, CSV) for downloading when the request can take several minutes to complete.

Data product ID. a4232188-69e7-42d0-8583-5dded17c2710
Data latency. Three minutes or greater, depending on query parameters.
Maximum result size. Millions.
Data availability. Last 13 months.

Example request

Copy

POST /dpss/api/v1/subscriptions/{{subscriptionid}}/batch-request HTTP/1.1
Host: k8s.itrontotal.com
Authorization: Bearer 
Itron-CorrelationId:{{UUID}}
DataSubscriberId: {{DataSubscriberId}}
Content-Type: application/json
Content-Length: 476

{
    "filetype": "csv",
    "Tokens": {
        "StartEventDate": "2024-07-01",
        "EndEventDate": "",
        "StartReceivedDateTime": "2024-07-02",
        "EndReceivedDateTime": "",
        "Device": "",
        "ElectronicSerialNumber": "",
        "Meter": "",
        "MeterNumber": "",
        "ServicePoint": "",
        "Premises": "",
        "Transformer": "X1-01-AX",
        "Feeder": "",
        "AlgorithmIdInput": "1.2"
    },
    "isOhsRequest": false
}

Example response CSV

Copy

RecievedTime    ServicePointId     MeterId    MeterNumber    ElectronicSerialNumber    TransformerId    PremiseId    AlgorithmId    MaxTemp    AvgTemp    EventDate
2023-09-13T00:29:55.55Z    9000372474    1000634831    1000634831    2.16.840.1.114416.15.80.1000634831    4929542183-90777887    P9000372474    2    147.5    175    2023-09-13
2023-09-13T00:29:55.55Z    9000502815    1000838385    1000838385    2.16.840.1.114416.15.80.1000838385    --    P9000502815    3    245    106    2023-09-13
2023-09-13T00:29:55.55Z    9000053282    1000092413    1000092413    2.16.840.1.114416.15.80.1000092413    2594744147-91918635    P9000053282    3    146.25    129    2023-09-13
2023-09-13T00:29:55.55Z    9000585414    1000448760    1000448760    2.16.840.1.114416.15.80.1000448760    2662535221-10734063    P9000585414    1    103.75    124    2023-09-13
2023-09-13T00:29:55.55Z    9000594308    1000508737    1000508737    2.16.840.1.114416.15.80.1000508737    2949637457-92808645    P9000594308    1    206.25    136    2023-09-13
2023-09-13T00:29:55.55Z    9000580263    1000071660    1000071660    2.16.840.1.114416.15.80.1000071660    2435841314-92195447    P9000580263    2    183.75    193    2023-09-13
2023-09-13T00:29:55.55Z    9000372477    1000836297    1000836297    2.16.840.1.114416.15.80.1000836297    4495046038-10795431    P9000372477    2    203.75    98    2023-09-13
2023-09-13T00:29:55.55Z    9000007738    1000561269    1000561269    2.16.840.1.114416.15.80.1000561269    2604141857-10581404    P9000007738    1    143.75    113    2023-09-13
2023-09-13T00:29:55.55Z    9000389087    1000326772    1000326772    2.16.840.1.114416.15.80.1000326772    2768938379-10477102    P9000389087    2    221.25    107    2023-09-13
2023-09-13T00:29:55.55Z    9000530026    1000062826    1000062826    2.16.840.1.114416.15.80.1000062826    2302540356-10169202    P9000530026    3    203.75    77    2023-09-13
2023-09-13T00:29:55.55Z    9000098919    1000567185    1000567185    2.16.840.1.114416.15.80.1000567185    3393042722-93886808    P9000098919    2    196.25    198    2023-09-13
2023-09-13T00:29:55.55Z    9001805366    1000846429    1000846429    2.16.840.1.114416.15.80.1000846429    --    P9001805366    1    126.25    187    2023-09-13

Get Synchronous request and response examples

Used to request a smaller data set 'on demand' with very low latency.

Data latency. Three minutes or greater, depending on query parameters.
Maximum result size. 1,000 rows.
Data availability. Last 13 months.

Example request

Copy

POST /dpss/api/v1/subscriptions/{{subscriptionid}}/on-demand HTTP/1.1
Host: k8s.itrontotal.com
Authorization: Bearer 
Itron-CorrelationId: {{UUID}}
DataSubscriberId: {{DataSubscriberId}}
Content-Type: application/json
Content-Length: 362

{
    "StartEventDate": "7/1/2024",
    "EndEventDate": "",
    "StartReceivedDateTime": "",
    "EndReceivedDateTime": "",
    "Device": "",
    "ElectronicSerialNumber": "",
    "Meter": "",
    "MeterNumber": "",
    "ServicePoint": "",
    "Premises": "",
    "Transformer": "333743971X-9082057Y",
    "Feeder": "",
    "AlgorithmIdInput": ""
}

Example response

Copy

[
    {
        "ReceivedTime": "2024-07-01T14:02:36",
        "ServicePointId": "900056741X",
        "MeterId": "100071693X",
        "MeterNumber": "100071693X",
        "ElectronicSerialNumber": "2.16.840.1.114416.15.80.100071693X",
        "TransformerId": "3337439715-9082057X",
        "PremiseId": "900056741X",
        "AlgorithmId": "1.1",
        "MaxTemp": 122,
        "AvgTemp": 74,
        "EventDate": "2024-07-01T00:00:00"
    }
]

Parameters

Table 16
Name	Description	Operators	Required	Type	Format	Default	Range	Origination
StartEventDate	Start date being queried as Min(EventDate)	Greater than or equal to	Yes	Date time	YYYY-MM-DDTHH:MM:SSZ	2020-01-01T00:00:00.0Z	(Current UTC Date) to (Current UTC Date - 13 months)	Edge app
EndEventDate	End date being queried as Max(EventDate)	Less than or equal to	No	Date time	YYYY-MM-DDTHH:MM:SSZ	9999-12-31T00:00:00.0Z	(Current UTC Date) to (Current UTC Date - 13 months)	Edge app
StartReceivedDatetime	Min ReceivedTime data	Greater than or equal to	No	Date time	YYYY-MM-DDTHH:MM:SSZ	2020-01-01T00:00:00.0Z	(Current UTC Date) to (Current UTC Date - 13 months)	App Platform
EndReceivedDatetime	Max ReceivedTime data	Less than or equal to	No	Date time	YYYY-MM-DDTHH:MM:SSZ	9999-12-31T00:00:00.0Z	(Current UTC Date) to (Current UTC Date - 13 months)	App Platform
Device	Device IDs as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
ElectronicSerialNumber	ESNs as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
Meter	Meter IDs as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
MeterNumber	Meter numbers as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
MeterNumber	Meter numbers as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
ServicePoint	Service point IDs as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
Premises	Premise IDs as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
Transformer	Transformer IDs as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
Feeder	Feeder IDs as an array or CSV	In list	No	String	N/A	N/A	N/A	CIS MDMS GIS
AlgorithmIdInput	The index of the algorithm that identified the event	Equals	No	Integer	N	N/A	1 to 3	Edge app

Data values

Table 17
Name	Description	Type	Units	Range	Format	Nullable	Origination
ReceivedTime	When the data was received by the App Platform	Date time	N/A	N/A	YYYY-MM-DDTHH:MM:SSZ	No	App Platform
ServicePointId	Service Point ID as of EventDate	String	N/A	N/A	N/A	No	CIS MDMS GIS
MeterId	Meter ID as of EventDate	String	N/A	N/A	N/A	No	CIS MDMS GIS
MeterNumber	Meter Number as of EventDate	String	N/A	N/A	N/A	Yes	CIS MDMS GIS
ElectronicSerialNumber	Electronic Serial Number	String	N/A	N/A	N/A	No	CIS MDMS GIS
TransformerId	Transformer ID as of EventDate	String	N/A	N/A	N/A	Yes	CIS MDMS GIS
PremiseId	Premise ID as of EventDate	String	N/A	N/A	N/A	Yes	CIS MDMS GIS
AlgorithmId	The index of the algorithm that identified the event	Integer	N/A	1 to 3	N.N	No	Edge app
MaxTemp	Maximum temperature over the days in which a recommendation was identified	Real	Celsius	-256 to 255	N.NN	No	Edge app
AvgTemp	Average temperature over the days in which a recommendation was identified	Real	Celsius	-256 to 255	N.NN	No	Edge app
EventDate	UTC day for which the statistics have been collected	Date	N/A	N/A	YYYY-MM-DD	No	Edge app