Difference between revisions of "API/RetailServices/UsersByRealm"

Latest revision as of 17:31, 27 February 2017

Purpose

The UsersByRealm function allows you get RADIUS information about users for a given realm.
Please Note: This call is expecting you to authenticate as a Wholesale account and will expose end-user details. It will not return results if authenticated as a retail service provider.

Inputs

  <soapenv:Header/>
   <soapenv:Body>
      <ret:UsersByRealm>
	<ret:realm>1</ret:realm>
      </ret:UsersByRealm>
   </soapenv:Body>

Output

  <SOAP-ENV:Body>
      <ns1:UsersByRealmResponse>
         <ns1:ComplexUser>
	   <ns1:account_id>1</ns1:account_id>
	   <ns1:service_id>1</ns1:>
	   <ns1:service_subscription_id>1</ns1:service_subscription_id>
	   <ns1:account_name>1</ns1:account_name>
	   <ns1:fnn>1</ns1:fnn>
	   <ns1:username>1</ns1:username>
	   <ns1:password>1</ns1:password>
	   <ns1:reply_attributes>1</ns1:reply_attributes>
	   <ns1:ip_address>1</ns1:ip_address>
	   <ns1:framed_route>1</ns1:framed_route>
	   <ns1:shaping_attributes>1</ns1:shaping_attributes>
	   <ns1:service_name>1</ns1:service_name>
	   <ns1:total_period_upload_data>1</ns1:total_period_upload_data>
	   <ns1:total_period_download_data>1</ns1:total_period_download_data>
	   <ns1:total_allowance>1</ns1:total_allowance>
	   <ns1:usage_period_start>1</ns1:usage_period_start>
	   <ns1:usage_period_end>1</ns1:usage_period_end>
	 </ns1:ComplexUser>
      </ns1:UsersByRealmResponse>
   </SOAP-ENV:Body>

Error String

202. Invalid or Missing account id

203. Invalid or Missing realm

204. Records not found