Install Events REST Endpoints

Sort by

Task Path Method

V-Model/Install Events

Install Events manage the physical installation of devices such as meters or badged items at service point connection locations including relationships to markets and service providers and communication between devices or schedules for manual meter reading. Whenever a device is installed at a Service Point, an installation event is created. Installation events capture the history of the devices that have been installed at a Service Point. This allows consumption for a Service Point to be calculated over time. In technical terms, installation events (or Install Events) link a specific Device Configuration to a Service Point. There are specific Install Event business objects for different types of devices, including smart meters, items, manual meters, and communication components. When creating Install Events for items, only "badged" items (those that are uniquely identified in some way) use item Install Events. "Unbadged" items do not use Install Events. Instead, the number of each type of item is specified in the "Multi-Item Detail" section of the Service Point. While a device is installed at a Service Point, it may be turned off (and back on again). The installation event that records the original installation date and time also records the dates and times when the device has been turned on and off. When a device is removed, the original installation event is updated with the removal date and time.

Create Install Event

Method: post

Path: /rest/apis/meter/v-model/installEvents/

Delete Install Event Details

Method: delete

Path: /rest/apis/meter/v-model/installEvents/{installEventId}

Get Install Event

Method: get

Path: /rest/apis/meter/v-model/installEvents/{installEventId}

Update Install Event Details

Method: put

Path: /rest/apis/meter/v-model/installEvents/{installEventId}