GET 1.0/customermanagement/customers/{siteprefix}/{siteid}

Description

Gets all of the reseller settings for a specific customer

URI Parameters
Name Description Type Additional information
sitePrefix

Customer's SitePrefix

 string

Required
siteID

Customer's siteID

 integer

Required

None.

None.

A Customer Details object containg a list of all their settings grouped by the SystemConfigurationDescription Groupname in the case of brightlogic it will return all of the settings, for resellers it will only return those marked with reseller api enabled in their description record

CustomerDetails
Name Description Type Additional information
SitePrefix

string

None.
SiteID

integer

None.
SiteName

string

None.
BranchName

string

None.
SiteAddress

string

None.
SiteUrl

string

None.
SettingGroups

Collection of CustomerSettingGroup

None.
PortalSettingGroups

Collection of PortalSettingGroup

None.

application/json, text/json
Sample: 
{
  "sitePrefix": "sample string 1",
  "siteID": 2,
  "siteName": "sample string 3",
  "branchName": "sample string 4",
  "siteAddress": "sample string 5",
  "siteUrl": "sample string 6",
  "settingGroups": [
    {
      "groupName": "sample string 1",
      "customerSettings": [
        {
          "dataType": 1,
          "name": "sample string 2",
          "value": "sample string 3"
        },
        {
          "dataType": 1,
          "name": "sample string 2",
          "value": "sample string 3"
        }
      ]
    },
    {
      "groupName": "sample string 1",
      "customerSettings": [
        {
          "dataType": 1,
          "name": "sample string 2",
          "value": "sample string 3"
        },
        {
          "dataType": 1,
          "name": "sample string 2",
          "value": "sample string 3"
        }
      ]
    }
  ],
  "portalSettingGroups": [
    {
      "groupName": "sample string 1",
      "portalSettings": [
        {
          "groupName": "sample string 1",
          "dataType": 2,
          "name": "sample string 3",
          "value": "sample string 4"
        },
        {
          "groupName": "sample string 1",
          "dataType": 2,
          "name": "sample string 3",
          "value": "sample string 4"
        }
      ],
      "branchIDs": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ]
    },
    {
      "groupName": "sample string 1",
      "portalSettings": [
        {
          "groupName": "sample string 1",
          "dataType": 2,
          "name": "sample string 3",
          "value": "sample string 4"
        },
        {
          "groupName": "sample string 1",
          "dataType": 2,
          "name": "sample string 3",
          "value": "sample string 4"
        }
      ],
      "branchIDs": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml
Sample: 
<CustomerDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SitePrefix>sample string 1</SitePrefix>
  <SiteID>2</SiteID>
  <SiteName>sample string 3</SiteName>
  <BranchName>sample string 4</BranchName>
  <SiteAddress>sample string 5</SiteAddress>
  <SiteUrl>sample string 6</SiteUrl>
  <SettingGroups>
    <CustomerSettingGroup>
      <GroupName>sample string 1</GroupName>
      <CustomerSettings>
        <CustomerSetting>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <DataType>1</DataType>
        </CustomerSetting>
        <CustomerSetting>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <DataType>1</DataType>
        </CustomerSetting>
      </CustomerSettings>
    </CustomerSettingGroup>
    <CustomerSettingGroup>
      <GroupName>sample string 1</GroupName>
      <CustomerSettings>
        <CustomerSetting>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <DataType>1</DataType>
        </CustomerSetting>
        <CustomerSetting>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
          <DataType>1</DataType>
        </CustomerSetting>
      </CustomerSettings>
    </CustomerSettingGroup>
  </SettingGroups>
  <PortalSettingGroups>
    <PortalSettingGroup>
      <GroupName>sample string 1</GroupName>
      <PortalSettings>
        <PortalSetting>
          <Name>sample string 3</Name>
          <Value>sample string 4</Value>
          <DataType>2</DataType>
          <GroupName>sample string 1</GroupName>
        </PortalSetting>
        <PortalSetting>
          <Name>sample string 3</Name>
          <Value>sample string 4</Value>
          <DataType>2</DataType>
          <GroupName>sample string 1</GroupName>
        </PortalSetting>
      </PortalSettings>
      <BranchIDs>
        <NameValuePair>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </NameValuePair>
        <NameValuePair>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </NameValuePair>
      </BranchIDs>
    </PortalSettingGroup>
    <PortalSettingGroup>
      <GroupName>sample string 1</GroupName>
      <PortalSettings>
        <PortalSetting>
          <Name>sample string 3</Name>
          <Value>sample string 4</Value>
          <DataType>2</DataType>
          <GroupName>sample string 1</GroupName>
        </PortalSetting>
        <PortalSetting>
          <Name>sample string 3</Name>
          <Value>sample string 4</Value>
          <DataType>2</DataType>
          <GroupName>sample string 1</GroupName>
        </PortalSetting>
      </PortalSettings>
      <BranchIDs>
        <NameValuePair>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </NameValuePair>
        <NameValuePair>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </NameValuePair>
      </BranchIDs>
    </PortalSettingGroup>
  </PortalSettingGroups>
</CustomerDetails>