POST waterscope/utility/mobile/metertransfer/transfer

Request Information

URI Parameters

None.

Body Parameters

AdminMeterTransferRequestModel
NameDescriptionTypeAdditional information
FromAccountId

Required. Source account the meter currently belongs to. Must be numeric.

string

None.

ToAccountId

Required. Destination account to move the meter to. Must be numeric, must exist, and must differ from fromAccountId.

string

None.

MeterId

Required. Meter (endpoint) identifier to transfer. Must be numeric.

string

None.

FromDate

Optional. Lower bound of the data window to transfer. Defaults to the meter's registered date when omitted. Cannot be earlier than the registered date, nor later than toDate. Note: the window only scopes which consumption logs migrate; the meter itself moves in full regardless of the dates.

date

None.

ToDate

Optional. Upper bound of the data window to transfer. Defaults to today when omitted. Must not be earlier than fromDate.

date

None.

Request Formats

application/json, text/json

Sample:
{
  "IdempotencyKey": "sample string 1",
  "OverwriteMeterData": true,
  "FromAccountId": "sample string 3",
  "ToAccountId": "sample string 4",
  "MeterId": "sample string 5",
  "FromDate": "2026-08-26T21:03:44.2738395+00:00",
  "ToDate": "2026-08-26T21:03:44.2738395+00:00",
  "AccountId": "sample string 6",
  "UserName": "sample string 7",
  "ProfileIds": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<AdminMeterTransferRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Base.VN.Core.ViewModels.ViewModels.UtilityMobile.AdminMeterTransfer.RequestModel">
  <AccountId xmlns="http://schemas.datacontract.org/2004/07/Base.VN.Core.ViewModels.ViewModels.UtilityMobile.Common">sample string 6</AccountId>
  <ProfileIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Base.VN.Core.ViewModels.ViewModels.UtilityMobile.Common">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ProfileIds>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/Base.VN.Core.ViewModels.ViewModels.UtilityMobile.Common">sample string 7</UserName>
  <FromAccountId>sample string 3</FromAccountId>
  <FromDate>2026-08-26T21:03:44.2738395+00:00</FromDate>
  <MeterId>sample string 5</MeterId>
  <ToAccountId>sample string 4</ToAccountId>
  <ToDate>2026-08-26T21:03:44.2738395+00:00</ToDate>
  <IdempotencyKey>sample string 1</IdempotencyKey>
  <OverwriteMeterData>true</OverwriteMeterData>
</AdminMeterTransferRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AdminMeterTransferRequestModel'.

Response Information

Resource Description

AdminMeterTransferResponseModel
NameDescriptionTypeAdditional information
IsTransferred

Whether the meter was successfully transferred to the destination account.

boolean

None.

MeterId

Meter (endpoint) identifier that was transferred.

string

None.

ToAccountId

Destination account the meter was moved to.

string

None.

ResponseCode

Application result code: 0 = Success, 1 = Error. Separate from the HTTP status code — a business failure is still returned as HTTP 200 with responseCode 1, so check both.

integer

None.

Message

Gets or sets the message.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsTransferred": true,
  "MeterId": "3003008",
  "ToAccountId": "1",
  "ResponseCode": 0,
  "Message": "Transfer of the meter is completed."
}

application/xml, text/xml

Sample:
<AdminMeterTransferResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Base.VN.Core.ViewModels.ViewModels.UtilityMobile.AdminMeterTransfer.ResponseModel">
  <Message xmlns="http://schemas.datacontract.org/2004/07/Base.VN.Core.ViewModels.ViewModels.UtilityMobile.Common">Transfer of the meter is completed.</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Base.VN.Core.ViewModels.ViewModels.UtilityMobile.Common">0</ResponseCode>
  <IdempotencyKey i:nil="true" />
  <IsTransferred>true</IsTransferred>
  <MeterId>3003008</MeterId>
  <ToAccountId>1</ToAccountId>
</AdminMeterTransferResponseModel>