POST api/CommodityApi/GetCustomerInformation
Request Information
URI Parameters
None.
Body Parameters
ApiParamOfCustomerInfoCriteriaAndObjectName | Description | Type | Additional information |
---|---|---|---|
AuthKey | AuthenticationKey |
Required |
|
Criteria | CustomerInfoCriteria |
Required |
|
Data | Object |
Required |
Request Formats
application/json, text/json
Sample:
{ "AuthKey": { "WebServiceKey": "sample string 1", "CompanyID": 1, "AppSource": "sample string 2", "AppSourceTeam": "sample string 3" }, "Criteria": { "CompanyID": 1, "CustomerID": "sample string 1", "RefID": "sample string 2", "CommodityType": "sample string 3" }, "Data": {} }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiOutputCommonOfListOfCustomerInfoName | Description | Type | Additional information |
---|---|---|---|
ResponseCode | string |
None. |
|
ResponseMessage | string |
None. |
|
Data | Collection of CustomerInfo |
None. |
Response Formats
application/json, text/json
Sample:
{ "ResponseCode": "sample string 1", "ResponseMessage": "sample string 2", "Data": [ { "PremiseID": "sample string 1", "UtilityDUNS": "sample string 2", "ServiceCycle": 1, "CommodityType": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "CompanyName": "sample string 6", "BillingAddress1": "sample string 7", "BillingAddress2": "sample string 8", "BillingCity": "sample string 9", "BillingState": "sample string 10", "BillingZip": "sample string 11", "ServiceAddress1": "sample string 12", "ServiceAddress2": "sample string 13", "ServiceCity": "sample string 14", "ServiceState": "sample string 15", "ServiceZip": "sample string 16", "CustomerEmailID": "sample string 17", "CommodityRate": 1.0, "ID": 1, "ContractID": "sample string 18", "CompanyID": 1, "CustomerID": "sample string 19", "RefID": "sample string 20", "IsActive": true, "UpdatedBy": "sample string 21", "UpdatedDate": "2025-05-02T10:57:38.8032885-04:00", "CreatedBy": "sample string 22", "CreatedDate": "2025-05-02T10:57:38.8032885-04:00" }, { "PremiseID": "sample string 1", "UtilityDUNS": "sample string 2", "ServiceCycle": 1, "CommodityType": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "CompanyName": "sample string 6", "BillingAddress1": "sample string 7", "BillingAddress2": "sample string 8", "BillingCity": "sample string 9", "BillingState": "sample string 10", "BillingZip": "sample string 11", "ServiceAddress1": "sample string 12", "ServiceAddress2": "sample string 13", "ServiceCity": "sample string 14", "ServiceState": "sample string 15", "ServiceZip": "sample string 16", "CustomerEmailID": "sample string 17", "CommodityRate": 1.0, "ID": 1, "ContractID": "sample string 18", "CompanyID": 1, "CustomerID": "sample string 19", "RefID": "sample string 20", "IsActive": true, "UpdatedBy": "sample string 21", "UpdatedDate": "2025-05-02T10:57:38.8032885-04:00", "CreatedBy": "sample string 22", "CreatedDate": "2025-05-02T10:57:38.8032885-04:00" } ] }