SolarWinds Backup Help

Enumerating customers in JSON-RPC API

To get the list of customers for your own company or your customers, use the EnumeratePartners method.

Required parameters

Parameter Description Supported values
parentPartnerId The ID of the parent customer Int

Optional parameters

Parameter Description Supported values
fetchRecursively The range of customers to retrieve
  • true (returns the full list of customers)
  • false (returns only 1 level of customers)
fields Lets you specify the type of information you need

Numbers of fields separated by a comma in square brackets.

  • 0 - Name
  • 1- Level
  • 3 - ChildServiceTypes
  • 4 - ServiceType
  • 5 - State
  • 8 - LocationId
  • 9 - Flags
  • 10 - Company info
  • 18 - ExternalCode, MailFrom
  • 20 - CreationTime

Sample request

{
	"id": "jsonrpc",
	"visa": "33491-50121-1-1512736778-A99E8BAC8AC82XXXXX0000000XXXXXXXXXXXX00000",
	"method": "EnumeratePartners",
	"jsonrpc": "2.0",
	"params": {
		"parentPartnerId": 33491,
		"fields": [0, 1, 3, 4, 5, 8],
		"fetchRecursively": true,
	}
}

Sample response

{
	"id": "jsonrpc",
	"visa": "33491-50121-1-1512736778-A99E8BAC8AC82XXXXX0000000XXXXXXXXXXXX00000",
	"jsonrpc": "2.0",
	"result": {
		"result":	[
		{
			"ChildServiceTypes":
			[
				"AllInclusive",
				"SoftwareOnly"
			],
			"Company": {"PostAddress": null},
			"ExternalPartnerProperties": null,
			"Id": 33492,
			"Level": "SubDistributor",
			"LocationId": 1,
			"Name": "Smart Telecom US (Orlando)",
			"ParentId": 33491,
			"ServiceType": "AllInclusive",
			"State": "InTrial"
		},
		{
			"ChildServiceTypes":
			[
				"AllInclusive",
				"SoftwareOnly"
			],
			"Company": {"PostAddress": null},
			"ExternalPartnerProperties": null,
			"Id": 33493,
			"Level": "SubDistributor",
			"LocationId": 1,
			"Name": "Smart Telecom US (Connecticut)",
			"ParentId": 33491,
			"ServiceType": "AllInclusive",
			"State": "Registered"
		},
		{
			"ChildServiceTypes": null,
			"Company": {"PostAddress": null},
			"ExternalPartnerProperties": null,
			"Id": 55958,
			"Level": "EndCustomer",
			"LocationId": 1,
			"Name": "Smart Telecom International,
			"ParentId": 33491,
			"ServiceType": "AllInclusive",
			"State": "Registered"
		}
		]
	},
}