GET CustomerBusinessInfluence/GetCustomerBusinessInfluences?customerId={customerId}

Returns a list of business influence types and the customers associated with the business influence.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
customerId

Customer ID to look at for the business influence type and the customers associated with it.

string

Required

Body Parameters

Response Information

Resource Description

Returns a list of business influence types and the customers associated with the business influence.

AgvCustomerBusinessInfluence
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
Count

Number of business influences returned.

string
BusinessInfluences

List of properties and values returned for each business influence.

Collection of ClsBusinessInfluence

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "BusinessInfluences": [
    {
      "businessInfluence": "sample string 1",
      "customers": [
        {
          "customerId": "sample string 1"
        },
        {
          "customerId": "sample string 1"
        }
      ]
    },
    {
      "businessInfluence": "sample string 1",
      "customers": [
        {
          "customerId": "sample string 1"
        },
        {
          "customerId": "sample string 1"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<AgvCustomerBusinessInfluence xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Customer">
  <BusinessInfluences xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Customer">
    <d2p1:ClsBusinessInfluence>
      <d2p1:businessInfluence>sample string 1</d2p1:businessInfluence>
      <d2p1:customers>
        <d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
          <d2p1:customerId>sample string 1</d2p1:customerId>
        </d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
        <d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
          <d2p1:customerId>sample string 1</d2p1:customerId>
        </d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
      </d2p1:customers>
    </d2p1:ClsBusinessInfluence>
    <d2p1:ClsBusinessInfluence>
      <d2p1:businessInfluence>sample string 1</d2p1:businessInfluence>
      <d2p1:customers>
        <d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
          <d2p1:customerId>sample string 1</d2p1:customerId>
        </d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
        <d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
          <d2p1:customerId>sample string 1</d2p1:customerId>
        </d2p1:ClsBusinessInfluence.ClsBusinessInfluenceCustomer>
      </d2p1:customers>
    </d2p1:ClsBusinessInfluence>
  </BusinessInfluences>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvCustomerBusinessInfluence>