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

Get Pending Connection Requests

Updated on February 11, 2015

Description

This web service returns a list of pending customer connection requests. A connection to the customer must be established first before any properties and meters can be shared with you. The list of pending customer connection requests is returned in sets of 20.

Version

9.0

HTTP Method

GET

Resource URL

/connect/account/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 connection requests.

GET  /connect/account/pending/list

Example Response

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

<pendingList>
    <account>
        <accountId>68023</accountId>
        <customFieldList>
            <customField name="Customer Number">D987DDD</customField>
            <customField name="Group Code">G81113</customField>
        </customFieldList>
        <accountInfo>
            <firstName>Jane</firstName>
            <lastName>Doe</lastName>
            <address address1="2343 Main Street" city="Arlington"
                     state="VA" postalCode="22201" country="US"/>
            <email>jane_doe@acme.com</email>
            <organization>ACME Corp</organization>
            <jobTitle>Building Adminstrator</jobTitle>
            <phone>800-555-1515</phone>
        </accountInfo>
        <connectionAudit>
            <createdBy>acme_jane</createdBy>
            <createdByAccountId>68023</createdByAccountId>
            <createdDate>2014-12-04T11:29:54.000-05:00</createdDate>
            <lastUpdatedBy>acme_jane</lastUpdatedBy>
            <lastUpdatedByAccountId>68023</lastUpdatedByAccountId>
            <lastUpdatedDate>2014-12-04T16:29:54.000-05:00</lastUpdatedDate>
        </connectionAudit>
    </account>
    <account>
        <accountId>3243</accountId>
        <customFieldList>
            <customField name="Customer Number">X868867D</customField>
            <customField name="Group Code">G93328788</customField>
        </customFieldList>
        <accountInfo>
            <firstName>Joe</firstName>
            <lastName>Smith</lastName>
            <address address1="3432 Times Square Blvd" city="New York City"
                     postalCode="10453" state="NY" country="US"/>
            <email>joe_smith@sample.com</email>
            <organization>Sample Company</organization>
            <jobTitle>Building Adminstrator</jobTitle>
            <phone>800-555-1515</phone>
        </accountInfo>
        <connectionAudit>
            <createdBy>acme_smith</createdBy>
            <createdByAccountId>3243</createdByAccountId>
            <createdDate>2014-12-03T11:29:54.000-05:00</createdDate>
            <lastUpdatedBy>acme_smith</lastUpdatedBy>
            <lastUpdatedByAccountId>3243</lastUpdatedByAccountId>
            <lastUpdatedDate>2014-12-03T16:29:54.000-05:00</lastUpdatedDate>
        </connectionAudit>
    </account>

    ...

    <links>
        <link linkDescription="next page" link="/connect/account/pending/list?page=2" httpMethod="GET"/>
    </links>
</pendingList>
TEST