Portfolio Manager will be unavailable due to system upgrades beginning Saturday, November 16, 12:00 AM EST through Monday, November 18, 11:59 PM EST.
Web Service Documentation / Categories / Connection/Share Services / Disconnect From Customer
Updated on August 12, 2014
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.
23.0
POST
/disconnect/account/(accountId)?keepShares=(keepShares)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials | |
Content-Type | application/xml |
Yes
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. |
Request/Response | Schema Name |
---|---|
Request | authorization.xsd |
Response | response.xsd |
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>
The following example shows that the disconnect was successful.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>