Web Service Documentation / Categories / Connection/Share Services / Disconnect From Customer

Disconnect From Customer

Updated on August 12, 2014

Description

This web service removes the existing connection between you and a specific customer. Any existing property and meter shares between you and the specific customer are also automatically removed by default or can be kept in place. An optional note indicating the reason can be included too. This optional note is provided in the XML request.

Version

22.0

HTTP Method

POST

Resource URL

/disconnect/account/(accountId)?keepShares=(keepShares)

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
accountId Id to the account
keepShares Indicates whether to keep (set to true) or remove (set to false) any property and meters shares after the disconnect occurs. This is optional and the default is false.

XML Schemas

Request/Response Schema Name
Request authorization.xsd
Response response.xsd

Example Request

The following example disconnects from an account that has an id of 68023. Any property and meter shares are also removed.

POST  /disconnect/account/68023

<?xml version="1.0" encoding="UTF-8"?>
<terminateSharingResponse>
    <note>Account is delinquent.</note>
</terminateSharingResponse>

Example Response

The following example shows that the disconnect was successful.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>
LIVE