Get MV Equipment Groups API

This API fetches and delivers the list of equipment (feeder or substation bank) groups to a customer's data lake/business system. It can be used for the following use cases:

  • GIS operators receive daily update of connectivity data. Some connections may be automatically updated, some may be further validated automatically by utility back-office systems or manually by utility.

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. 4b7d57d2-8f28-41e9-840d-aba15862c8f6

  • Data latency. Three minutes or greater, depending on query parameters.

  • Maximum result size. Millions.

  • Data availability. Last 13 months.

Request

Copy 
POST /data-products/4b7d57d2-8f28-41e9-840d-aba15862c8f6/subscriptions/{subscriptionId}/batch-request
{
    "FileType": "Csv",
    "Tokens":
    {
        "StartRecievedDatetime": "2023-1-1",
        "EndRecievedDatetime": "2023-1-31",
    }
}

Response

Copy 
ReceivedTime,ReportTime,MvEquipmentId,MvEquipmentGroupId,CountTxfmrs,MvEquipmentType,XfmrsCentroidLatitude,XfmrsCentroidLongitude
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,KNY901,59,30,Feeder,-11.5773477,-58.03992627
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,XKR673,56,19,Bank,46.80101392,116.3092734
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,OPJ542,45,43,Bank,75.67532295,155.7855714
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,YOU145,98,31,Feeder,-50.18033628,159.8658806
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,XDD764,91,19,Feeder,-78.9127481,81.14868215
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,LME477,77,34,Bank,35.86173678,-100.8996206
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,KID811,77,23,Feeder,-27.64172683,173.0188031
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,SHM373,44,46,Bank,-57.32820153,-116.6051763
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,WAN304,24,22,Feeder,-68.13067311,-17.84550697
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,KSG83,44,20,Bank,-36.59234706,3.964409068
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,GAQ484,76,29,Feeder,-8.312749942,-174.4905132
2023-09-13T00:29:55.55Z,2023-09-13T00:29:55.55Z,WXO742,75,36,Feeder,60.98893037,-8.199811013

Parameters

Table 34  

Name

Description

Operators

Required

Type

Format

Default

Range

Origination

StartReportDatetime

API returns all meter connectivity recommendations from this date/time Range End

Greater than or equal to

No

Datetime

YYYY-MM-DDTHH:MM:SSZ

2020-01-01T00:00:00.0Z

(Current UTC Date - 13 mo.) to (Current UTC Date

Edge app

EndReportDatetime

API returns all meter connectivity recommendations from Range Start through this date/time

Less than or equal to

No

Datetime

YYYY-MM-DDTHH:MM:SSZ

9999-12-31T00:00:00.0Z

(Current UTC Date - 13 mo.) to (Current UTC Date

Edge app

StartReceivedDatetime

Min ReceivedTime data

Greater than or equal to

No

Datetime

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

Datetime

YYYY-MM-DDTHH:MM:SSZ

9999-12-31T00:00:00.0Z

(Current UTC Date) to (Current UTC Date - 13 months)

App Platform

Data values

Table 35  

Name

Description

Type

Units

Range

Format

Nullable

Origination

ReceivedTime

When the data was received by the App Platform

Datetime

N/A

N/A

YYYY-MM-DDTHH:MM:SSZ

No

App Platform

ReportTime

Date the associated children were connected to this group

Datetime

N/A

N/A

YYYY-MM-DDTHH:MM:SSZ

No

Edge app

MvEquipmentId

Equipment (feeder or substation bank) identifier provided by utility via GIS

String

N/A

N/A

N/A

Yes

App Platform

MvEquipmentGroupId

Equipment (feeder or substation bank) identifier created by DI

String

N/A

N/A

N/A

N/A

Edge app

CountTxfmrs

Count of txfmrs connected to feeder-bank

Integer

N/A

non-negative

N/A

N/A

Edge app

MvEquipmentType

Equipment type - either a feeder or a substation bank as determined by analysis

String

N/A

N/A

N/A

N/A

App Platform

XfmrsCentroidLatitude

Latitude of centroid of connected txfmrs

String

N/A

N/A

N/A

N/A

App Platform

XfmrsCentroidLongitude

Longitude of centroid of connected txfmrs

String

N/A

N/A

N/A

N/A

App Platform