Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
networks_and_client_users_api [2014/06/12 23:27]
ybarajas [Examples]
networks_and_client_users_api [2014/06/25 17:01] (current)
ybarajas [Examples]
Line 1: Line 1:
 +======Network & Client Users REST Interface======
 +
 +
 +<note important>​This call requires cookies from a Login API call. Please refer  to the [[:​api_login|How to Log In]] help page for more information.</​note>​
 +
 +The Network & Client Users report summarizes important user information like the how many users logged onto an iPass network and which have used Open Mobile. ​
 +
 +
 +
 +=====Prerequisites=====
 +
 +You need to create (or have access to) a user with the Bill Viewer role (and for child accounts, the user will need the Delegated Bill Viewer role). You can confirm that a user has the appropriate roles by logging into the Open Mobile Portal as this user and downloading the appropriate reports. ​
 +
 +
 +
 +=====Passwords with Special Characters=====
 +
 +Special characters in passwords will have to be converted to URL-encoding in order to work with these scripts.
 +
 +^ ASCII ^ URL-encoding ^
 +|(space)|%20|
 +|!|%21|
 +|"​|%22|
 +|#|%23|
 +|$|%24|
 +|%|%25|
 +|&|%26|
 +|'​|%27|
 +|(|%28|
 +|)|%29|
 +|*|%2A|
 +|+|%2B|
 +|,|%2C|
 +|-|%2D|
 +|.|%2E|
 +|/|%2F|
 +
 +=====Column Information=====
 +
 +  * **User Name**: The user name that appears in the CDR but without a prefix.
 +  * **User Domain**: The user's domain as it appears in the CDR.
 +  * **Network User?**: Indicates whether this user connected to an iPass network during the selected month (or there is at least one CDR this month for this user).
 +  * **OM User?**: Indicates whether this user connected to a network with an Open Mobile client during the selected month (or there is at least one Open Mobile SQM this month for this user).
 +  * **iPC User?**: Indicates whether this user connected to a network with an iPassConnect client during the selected month (or there is at least one iPassConnect SQM this month for this user).
 +
 +======Download Network & Client Users======
 +
 +==Resource URL==
 +
 +<​code>​
 +/​moservices/​rest/​api/​ipass/​{COMPANY_ID}/​mo/​cdrReports/​networkuser?​User-Agent=apiuser&​month={MONTH}
 +</​code>​
 +
 +==HTTP GET==
 +Return the Network & Client Users report in a file.
 +
 +==GET Parameters==
 +
 +Required parameters:
 +
 +^ Parameter ^ Description ^
 +|COMPANY_ID| N/A|
 +|MONTH|**Format:​** YYYY-MM|
 +|User-Agent|This helps us route your API call appropriately. **Default:​** //​apiuser//​|
 +
 +=====Examples=====
 +
 +Download the Network & Client Users report for the month of Jan of 2014 for Acme Company with Company ID 987654.
 +
 +==cURL:==
 +
 +<​code>​
 +curl -k --request GET -b tmpCookies.txt -o networkclientusers.csv "​https://​openmobile.ipass.com/​moservices/​rest/​api/​ipass/​$COMPANY/​mo/​cdrReports/​monthly/​networkuser?​month=$month&​User-Agent=apiuser"​
 +</​code>​
 +
 +==JAVA:==
 +
 +
 +
 +<​code>​
 +   // Prepare the Network & Client Users Report API call with the appropriate parameter
 +         ​String reportURI = 
 +"/​moservices/​rest/​api/​ipass/​987654/​mo/​cdrReports/​monthly/​networkuser?​User-Agent=apiuser&​month=2014-01";​
 + HttpGet reportGet = new HttpGet("​https://​openmobile.ipass.com"​ + reportURI);
 +
 + // Make the Monthly CDR API call to obtain the Monthly CDR report
 + HttpResponse reportGetResponse = httpClient.execute(reportGet);​
 + HttpEntity httpEntity = reportGetResponse.getEntity();​
 +
 +</​code>​
 +
 +
 +
 +Go to: **[[:​api_documentation|REST API Overview]] > [[:​reports_rest|Introduction]]**
 +
 +
  
 

©2015 iPass Inc. All rights reserved. Terms of Use