Web Service Documentation / Categories / Connection/Share Services / Submit Meter-Level Custom Field Value

Submit Meter-Level Custom Field Value

Updated on July 17, 2013

Description

This web service submits data for a list of meter-level custom fields based on the data provided in the XML request from a specific Portfolio Manager customer to you. This web service is used within the Test environment to simulate a Portfolio Manager user providing data that is required by you during the share process. You must run this web service as the customer that you the data to be provided from.

Version

23.0

HTTP Method

PUT

Resource URL

/meter/(meterId)/customFieldList/recipient/(dxAccountId)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
dxAccountId Id to the account that the custom field data is provided to. This is typically the data exchange user.
meterId Id to the meter

XML Schemas

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

Example Request

The following example submits a list of meter-level custom fields and their values for a meter that has an id of 65. The meter-level custom fields are defined by the account that has an id of 872343.

PUT  /meter/65/customFieldList/recipient/872343

<?xml version="1.0" encoding="UTF-8"?>
<customFieldList>
    <customField name="Meter Identification Number">M-7222</customField>
</customFieldList>

Example Response

The following example shows that the data was successfully submitted.

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