Web Service Documentation / Categories / Connection/Share Services / Get Pending Meter Share Requests

Get Pending Meter Share Requests

Updated on August 23, 2020

Description

This web service returns a list of pending property meter requests. These meter share requests belong to customers that you are already connected to. The corresponding properties do not have to be already shared with you. The list of pending meter share requests is returned in sets of 20.

Version

23.0

HTTP Method

GET

Resource URL

/share/meter/pending/list?page=(pageNumber)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
page Indicates the page number set of results to retrieve. This is typically omitted on the initial call and is provided if the results are paginated.

XML Schemas

Request/Response Schema Name
Request None
Response authorization.xsd

Example Request

The following example retrieves the list of pending meter share requests.

GET  /share/meter/pending/list

Example Response

The following example shows the list of pending meter share requests and provides a link to the next set. For example purposes, assume that over 20 records are returned.

<?xml version="1.0" encoding="UTF-8"?>
<pendingList>
     <meter>
          <meterId>6067821</meterId>
          <propertyId>3635611</propertyId>
          <accountId>87656</accountId>
          <username>vaschools</username>
          <customFieldList>
               <customField name="Meter Number">123</customField>
          </customFieldList>
          <accessLevel>Read Write</accessLevel>
          <propertyInfo>
               <name>Broadway Elementary</name>
               <address address1="91 Broadway Street" city="Arlington" postalCode="20221" state="VA" country="US"/>
               <numberOfBuildings>0</numberOfBuildings>
               <constructionStatus>Existing</constructionStatus>
               <primaryFunction>Office</primaryFunction>
               <yearBuilt>2000</yearBuilt>
               <grossFloorArea units="Square Feet" temporary="false" default="N/A">
                    <value>10000</value>
               </grossFloorArea>
               <occupancyPercentage>90</occupancyPercentage>
               <isFederalProperty>false</isFederalProperty>
               <notes><![CDATA[Permit license > 5 years old.]]></notes>
               <audit>
                    <createdBy>vaschools</createdBy>
                    <createdByAccountId>87656</createdByAccountId>
                    <createdDate>2012-08-02T18:32:24-04:00</createdDate>
                    <lastUpdatedBy>vaschools</lastUpdatedBy>
                    <lastUpdatedByAccountId>87656</lastUpdatedByAccountId>
                    <lastUpdatedDate>2012-08-02T18:33:16-04:00</lastUpdatedDate>
               </audit>
          </propertyInfo>
          <meterInfo>
               <name>Electric Grid Meter</name>
               <metered>true</metered>
               <firstBillDate>2000-01-01</firstBillDate>
               <inUse>true</inUse>
               <audit>
                    <createdBy>vaschools</createdBy>
                    <createdByAccountId>87656</createdByAccountId>
                    <createdDate>2012-08-02T18:33:41-04:00</createdDate>
                    <lastUpdatedBy>vaschools</lastUpdatedBy>
                    <lastUpdatedByAccountId>87656</lastUpdatedByAccountId>
                    <lastUpdatedDate>2012-08-02T18:33:41-04:00</lastUpdatedDate>
               </audit>
               <type>Electric</type>
               <unitOfMeasure>kWh (thousand Watt-hours)</unitOfMeasure>
          </meterInfo>
          <shareAudit>
               <createdBy>acme_school</createdBy>
               <createdByAccountId>87656</createdByAccountId>
               <createdDate>2014-12-03T11:29:54.000-05:00</createdDate>
               <lastUpdatedBy>acme_school</lastUpdatedBy>
               <lastUpdatedByAccountId>87656</lastUpdatedByAccountId>
               <lastUpdatedDate>2014-12-03T16:29:54.000-05:00</lastUpdatedDate>
          </shareAudit>
     </meter>
     <!-- assume more records -->
     <links>
          <link linkDescription="next page" link="/share/meter/pending/list?page=2" httpMethod="GET"/>
     </links>
</pendingList>
TEST