Web Service Documentation / Categories / Connection/Share Services / Get Notifications

Get Notifications

Updated on August 8, 2016

Description

This web service returns a list of notifications that are generated when another user deletes or unshares a property or meter that you have access to. The purpose of these notifications is to help you stay in synch with your customer's data. Once a notification is read, it is marked as read and will not be available in subsequent calls.

The possible notification types are:
     UNSHARE - Indicates that your access to a property or meter has been removed.
     SHAREUPDATE - Indicates that your access level to a property or meter has changed.
     DISCONNECT - Indicates that you are no longer connected to a specific user.
     TRANSFERPROPERTY - Indicates that a property that you have access to has been transferred to a different user.

Version

10.0

HTTP Method

GET

Resource URL

/notification/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

None

XML Schemas

Request/Response Schema Name
Request None
Response authorization.xsd

Example Request

The following example retrieves the list of notifications.

GET  /notification/list

Example Response

The following example lists the current set of notifications and marks them as "read". Any subsequent calls will not include these notification items.

<notificationList>
    <notification>
        <notificationTypeCode>UNSHARE</notificationTypeCode>
        <notificationId>1</notificationId>
        <description>Electric Meter - Share terminated by John Doe.</description>
        <accountId>68005</accountId>
        <propertyId>5000006</propertyId>
        <meterId>2</meterId>
        <notificationCreatedDate>2014-12-20T11:50:44-04:00</notificationCreatedDate>
        <notificationCreatedBy>acme_john</notificationCreatedBy>
        <notificationCreatedByAccountId>68005</notificationCreatedByAccountId>
    </notification>
    <notification>
        <notificationTypeCode>DISCONNECT</notificationTypeCode>
        <notificationId>2</notificationId>
        <description>You are disconnected from Jane Doe.</description>
        <accountId>68032</accountId>
        <notificationCreatedDate>2014-12-21T11:50:44-04:00</notificationCreatedDate>
        <notificationCreatedBy>acme_jane</notificationCreatedBy>
        <notificationCreatedByAccountId>68032</notificationCreatedByAccountId>
    </notification>
    <notification>
        <notificationTypeCode>SHAREUPDATE</notificationTypeCode>
        <notificationId>3</notificationId>
        <description>Office Suite #10 - Access level revised to Exchange Data - Read Only by Joe Doe.</description>
        <accountId>68005</accountId>
        <propertyId>5000206</propertyId>
        <notificationCreatedDate>2014-12-21T10:50:44-04:00</notificationCreatedDate>
        <notificationCreatedBy>acme_joe</notificationCreatedBy>
        <notificationCreatedByAccountId>98866</notificationCreatedByAccountId>
    </notification>
    <notification>           
        <notificationTypeCode>TRANSFERPROPERTY</notificationTypeCode>
        <notificationId>4</notificationId>
        <description>Shoreline Building (453211) has been transferred to owner account UTCOwner (202270)</description>
        <accountId>202270</accountId>
        <propertyId>453211</propertyId>
        <notificationCreatedDate>2014-12-19T10:50:44-04:00</notificationCreatedDate>
        <notificationCreatedBy>acme_jack</notificationCreatedBy>
        <notificationCreatedByAccountId>6574</notificationCreatedByAccountId>
    </notification>           
</notificationList>
TEST