POST api/BillingImportExport/ImportProfile
Import billing profile details using JSON/XML data
Request Information
URI Parameters
None.
Header
Name | Description | Type |
---|---|---|
Authorization |
This field is use to authenticate user using 'Bearer Token'.This token is generated using login method.User must add this token to the header. |
string |
Body Parameters
Name | Description | Type |
---|---|---|
Billing Profile |
The Billing profile defined in the system |
BillingProfile |
Request Formats
application/json, text/json
Sample:
{ "ProfileName": "TestProfile", "Meters": [ { "MeterId": "3003008", "ConsumerId": "2600", "ConsumerName": "Jack", "ServiceAddress": "Florida", "Latitude": "44.033398", "Longitude": "-91.63816633" } ] }
application/xml, text/xml
Sample:
<?xml version="1.0" encoding="utf-16"?> <BillingProfile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ProfileName>TestProfile</ProfileName> <Meters> <MeterList> <MeterId>3003008</MeterId> <ConsumerId>2600</ConsumerId> <ConsumerName>Jack</ConsumerName> <ServiceAddress>Florida</ServiceAddress> <Latitude>44.033398</Latitude> <Longitude>-91.63816633</Longitude> </MeterList> </Meters> </BillingProfile>
Response Information
Resource Description
BillingImportResultViewModelName | Description | Type |
---|---|---|
TotalCount |
This is the number of meters attempted to import |
integer |
SuccessCount |
This is the number of meters successfully imported |
integer |
FailureCount |
This is the number of meters which were not successfully imported |
integer |
DuplicateCount |
This is the number of meters which were repeated |
integer |
FailureList |
This is the list of meters not successfully imported |
Collection of BillingImportFailureDetails |
DuplicateMeterList |
List of meters which had repeated entries |
Collection of string |
Response Formats
application/json, text/json
Sample:
{ "TotalCount": 4, "SuccessCount": 1, "FailureCount": 1, "DuplicateCount": 2, "FailureList": [ { "MeterId": "3003178", "Reason": "Meter does not exist in this account" } ], "DuplicateMeterList": [ "30031223", "30031223" ] }
application/xml, text/xml
Sample:
<?xml version="1.0" encoding="utf-16"?> <BillingImportResultViewModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <TotalCount>4</TotalCount> <SuccessCount>1</SuccessCount> <FailureCount>1</FailureCount> <DuplicateCount>2</DuplicateCount> <FailureList> <BillingImportFailureDetails> <MeterId>3003178</MeterId> <Reason>Meter does not exist in this account</Reason> </BillingImportFailureDetails> </FailureList> <DuplicateMeterList> <string>30031223</string> <string>30031223</string> </DuplicateMeterList> </BillingImportResultViewModel>