User Tools

Site Tools

Trace:
cygnus_track_portal_web_services_reference_guide

Differences

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

Link to this comparison view

cygnus_track_portal_web_services_reference_guide [2015/08/20 03:08]
127.0.0.1 external edit 		cygnus_track_portal_web_services_reference_guide [2015/09/16 02:00] (current)
admin
Line 1: Line 1:
-====== ​Cygnus_Track_Portal_Web_Services_Reference_Guide ​======+====== ​Cygnus Track Portal Web Services Reference Guide ======
  
 This is a complete list of the methods exposed in the Cygnus Track 6.0 web portal web services. These services allow you to manipulate your Cygnus Track web portal accounts, users, departments,​ devices and more. This is a complete list of the methods exposed in the Cygnus Track 6.0 web portal web services. These services allow you to manipulate your Cygnus Track web portal accounts, users, departments,​ devices and more.
Line 10: Line 10:
  
 ===== Account Web Service APIs ===== ===== Account Web Service APIs =====
-<​small>​Available in all Cygnus Track editions</​small>​+Available in all Cygnus Track editions
  
 ==== WSOrganizationManager Web Service ==== ==== WSOrganizationManager Web Service ====
Line 16: Line 16:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​securityKey</​code> ​|| Required,​user ID +|''​securityKey'' ​|| Required,​user ID | 
-|- +|''​accountID'' ​|| Required, Account ID | 
-|<​code>​accountID</​code> ​|| Required, Account ID +
-|}+
  
 Return value: String Return value: String
Line 29: Line 28:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication | 
-|- +|''​password'' ​|| Required, password for authentication | 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, Account ID |
-|- +
-|<​code>​accountID</​code> ​|| Required, Account ID +
-|}+
  
 Return value: String Return value: String
Line 44: Line 40:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px"​ +|''​userName'' ​|| Required, user name for authentication | 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​password'' ​|| Required, password for authentication | 
-|- +|''​orgID'' ​|| Required, Organization ID |
-|<​code>​password</​code> ​|| Required, password for authentication +
-|- +
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|}+
  
 Return value: String Return value: String
Line 59: Line 51:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px"​ +|''​userName'' ​|| Required, user name for authentication | 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​password'' ​|| Required, password for authentication | 
-|- +|''​accountID'' ​|| Required, account ID | 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgName'' ​|| Required, organization name | 
-|- +|''​Description'' ​|| Organization description | 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​mapDataID'' ​|| Required, map Data ID | 
-|- +|''​timeZone'' ​|| Required, time zone of the organization'​s location | 
-|<​code>​orgName</​code> ​|| Required, organization name +|''​metric'' ​|| Required, selects whether the organization'​s unit system is metric or imperial | 
-|- +|''​status'' ​|| Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE | 
-|<​code>​Description</​code> ​|| Organization description +|''​externalID'' ​|| Required, Reserved field |
-|- +
-|<​code>​mapDataID</​code> ​|| Required, map Data ID +
-|- +
-|<​code>​timeZone</​code> ​|| Required, time zone of the organization'​s location +
-|- +
-|<​code>​metric</​code> ​|| Required, selects whether the organization'​s unit system is metric or imperial +
-|- +
-|<​code>​status</​code> ​|| Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE +
-|- +
-|<​code>​externalID</​code> ​|| Required, Reserved field +
-|}+
  
 Return value: OrganizationID Return value: OrganizationID
Line 88: Line 69:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication 
-|- +| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​password'' ​|| Required, password for authentication 
-|- +| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​accountID'' ​|| Required, account ID 
-|- +| 
-|<​code>​orgID</​code> ​|| Required, organization ID +|''​orgID'' ​|| Required, organization ID 
-|- +| 
-|<​code>​orgName</​code> ​|| Required, organization name +|''​orgName'' ​|| Required, organization name 
-|- +| 
-|<​code>​description</​code> ​|| Organization description +|''​description'' ​|| Organization description 
-|- +| 
-|<​code>​manager</​code> ​|| Manager of the organization +|''​manager'' ​|| Manager of the organization 
-|- +| 
-|<​code>​imageName</​code> ​|| The path of the organization image +|''​imageName'' ​|| The path of the organization image 
-|- +| 
-|<​code>​mapDataID</​code> ​|| Required, map data ID +|''​mapDataID'' ​|| Required, map data ID 
-|- +| 
-|<​code>​timeZone</​code> ​|| Required, time zone of the organization'​s location +|''​timeZone'' ​|| Required, time zone of the organization'​s location 
-|- +| 
-|<​code>​metric</​code> ​|| Required, selects whether the organization'​s unit system is metric or imperial +|''​metric'' ​|| Required, selects whether the organization'​s unit system is metric or imperial 
-|- +| 
-|<​code>​status</​code> ​|| Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE +|''​status'' ​|| Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE 
-|- +| 
-|<​code>​externalID</​code> ​|| Required, Reserved field +|''​externalID'' ​|| Required, Reserved field 
-|- +| 
-|}+
  
 Return value: String Return value: String
Line 124: Line 105:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication 
-|- +| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​password'' ​|| Required, password for authentication 
-|- +| 
-|<​code>​orgID</​code> ​|| Required, Organization ID +|''​orgID'' ​|| Required, Organization ID 
-|}+
  
 Return value: String Return value: String
Line 139: Line 120:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication 
-|- +| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​password'' ​|| Required, password for authentication 
-|- +| 
-|<​code>​orgID</​code> ​|| Required, Organization ID +|''​orgID'' ​|| Required, Organization ID 
-|- +| 
-|<​code>​deviceID</​code> ​|| Required, device ID +|''​deviceID'' ​|| Required, device ID 
-|}+
  
 Return value: String Return value: String
Line 156: Line 137:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication 
-|- +| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​password'' ​|| Required, password for authentication 
-|- +| 
-|<​code>​orgID</​code> ​|| Required, Organization ID +|''​orgID'' ​|| Required, Organization ID 
-|- +| 
-|<​code>​carrierID</​code> ​|| Required, carrier ID +|''​carrierID'' ​|| Required, carrier ID 
-|}+
  
 Return value: String Return value: String
Line 173: Line 154:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication 
-|- +| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​password'' ​|| Required, password for authentication 
-|- +| 
-|<​code>​orgID</​code> ​|| Required, Organization ID +|''​orgID'' ​|| Required, Organization ID 
-|- +| 
-|<​code>​monitorID</​code> ​|| Required, monitor ID +|''​monitorID'' ​|| Required, monitor ID 
-|}+
  
 Return value: String Return value: String
Line 190: Line 171:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, Organization ID| 
-|- +
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|}+
  
 Return value: String Return value: String
Line 205: Line 184:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, Organization ID| 
-|- +
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|}+
  
 Return value: String Return value: String
Line 220: Line 197:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, Organization ID| 
-|- +
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|}+
  
 Return value: String Return value: String
Line 235: Line 210:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, Organization ID| 
-|- +|''​carrierID'' ​|| Required, carrier ID| 
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|- +
-|<​code>​carrierID</​code> ​|| Required, carrier ID +
-|}+
  
 Return value: String Return value: String
Line 252: Line 224:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, Organization ID| 
-|- +|''​deviceID'' ​|| Required, device ID| 
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|- +
-|<​code>​deviceID</​code> ​|| Required, device ID +
-|}+
  
 Return value: String Return value: String
Line 269: Line 238:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, Organization ID| 
-|- +|''​monitorID'' ​|| Required, monitor ID| 
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|- +
-|<​code>​monitorID</​code> ​|| Required, monitor ID +
-|}+
  
 Return value: String Return value: String
Line 286: Line 252:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, Account ID| 
-|- +
-|<​code>​accountID</​code> ​|| Required, Account ID +
-|}+
  
 Return value: String Return value: String
Line 302: Line 266:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​accountID'' ​|| Required, Account ID| 
-|- +|''​name'' ​|| Required, Monitor name| 
-|<​code>​accountID</​code> ​|| Required, Account ID +|''​description'' ​|| Monitor description| 
-|- +|''​userName'' ​|| Required, user name| 
-|<​code>​name</​code> ​|| Required, Monitor name +|''​password'' ​|| Required, password| 
-|- +|''​accountID'' ​|| Required, Account ID| 
-|<​code>​description</​code> ​|| Monitor description +|''​entryReference'' ​|| Required, selects which page is the default entry page - Dashboard or Map Area| 
-|- +|''​status'' ​|| Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|<​code>​userName</​code> ​|| Required, user name +|''​externalID'' ​|| Reserved field| 
-|- +
-|<​code>​password</​code> ​|| Required, password +
-|- +
-|<​code>​accountID</​code> ​|| Required, Account ID +
-|- +
-|<​code>​entryReference</​code> ​|| Required, selects which page is the default entry page - Dashboard or Map Area +
-|- +
-|<​code>​status</​code> ​|| Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE +
-|- +
-|<​code>​externalID</​code> ​|| Reserved field +
-|}+
  
 Return value: MonitorID Return value: MonitorID
Line 333: Line 287:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​accountID'' ​|| Required, Account ID| 
-|- +|''​monitorID'' ​|| Monitor ID| 
-|<​code>​accountID</​code> ​|| Required, Account ID +|''​name'' ​|| Required, Monitor name| 
-|- +|''​description'' ​|| Monitor description| 
-|<​code>​monitorID</​code> ​|| Monitor ID +|''​userName'' ​|| Required, user name| 
-|- +|''​password'' ​|| Required, password| 
-|<​code>​name</​code> ​|| Required, Monitor name +|''​accountID'' ​|| Required, Account ID| 
-|- +|''​entryReference'' ​|| Required, selects which page is the default entry page - Dashboard or Map Area| 
-|<​code>​description</​code> ​|| Monitor description +|''​status'' ​|| Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|- +|''​externalID'' ​|| Reserved field| 
-|<​code>​userName</​code> ​|| Required, user name +
-|- +
-|<​code>​password</​code> ​|| Required, password +
-|- +
-|<​code>​accountID</​code> ​|| Required, Account ID +
-|- +
-|<​code>​entryReference</​code> ​|| Required, selects which page is the default entry page - Dashboard or Map Area +
-|- +
-|<​code>​status</​code> ​|| Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE +
-|- +
-|<​code>​externalID</​code> ​|| Reserved field +
-|}+
  
 Return value: String Return value: String
Line 366: Line 309:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​MonitorID'' ​|| Required, Monitor ID|
-|- +
-|<​code>​MonitorID</​code> ​|| Required, Monitor ID +
-|}+
  
 Return value: String Return value: String
Line 381: Line 321:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​MonitorID'' ​|| Required, Monitor ID|
-|- +
-|<​code>​MonitorID</​code> ​|| Required, Monitor ID +
-|}+
  
 Return value: String Return value: String
Line 396: Line 333:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​accountID'' ​|| Required, account ID|
-|- +
-|<​code>​accountID</​code> ​|| Required, account ID +
-|}+
  
 Return value: String Return value: String
Line 411: Line 345:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​orgID'' ​|| Required, Organization ID| 
-|- +
-|<​code>​orgID</​code> ​|| Required, Organization ID +
-|}+
  
 Return value: String Return value: String
Line 427: Line 359:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +
-|<​code>​accountID</​code> ​|| Required, account ID +
-|}+
  
 Return value: String Return value: String
Line 442: Line 372:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​userID'' ​|| Required, user ID| 
-|- + 
-|<​code>​userID</​code> ​|| Required, user ID +
-|}+
  
 Return value: String Return value: String
Line 457: Line 386:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​userName'' ​|| Required, user name| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​password'' ​|| Required, password| 
-|- +|''​status'' ​|| Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|<​code>​userName</​code> ​|| Required, user name +|''​externalID'' ​|| Reserved field| 
-|- +|''​entryReference'' ​|| Required, selects which page is the default entry page - Dashboard or Map Area| 
-|<​code>​password</​code> ​|| Required, password +|''​firstName'' ​|| First name| 
-|- +|''​lastName'' ​|| Last name| 
-|<​code>​status</​code> ​|| Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE +|''​emailAddress'' ​|| Email address| 
-|- +|''​activateDate'' ​|| Activation date| 
-|<​code>​externalID</​code> ​|| Reserved field +|''​deactiveDate'' ​|| Deactivation date| 
-|- +|''​allowMultipleSessions'' ​|| Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| 
-|<​code>​entryReference</​code> ​|| Required, selects which page is the default entry page - Dashboard or Map Area +|''​checkMessageInterval'' ​|| Check message interval| 
-|- +
-|<​code>​firstName</​code> ​|| First name +
-|- +
-|<​code>​lastName</​code> ​|| Last name +
-|- +
-|<​code>​emailAddress</​code> ​|| Email address +
-|- +
-|<​code>​activateDate</​code> ​|| Activation date +
-|- +
-|<​code>​deactiveDate</​code> ​|| Deactivation date +
-|- +
-|<​code>​allowMultipleSessions</​code> ​|| Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously +
-|- +
-|<​code>​checkMessageInterval</​code> ​|| Check message interval +
-|}+
  
 Return value: UserID Return value: UserID
Line 496: Line 411:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​userID'' ​|| Required, user ID| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​userName'' ​|| Required, user name| 
-|- +|''​password'' ​|| Required, password| 
-|<​code>​userID</​code> ​|| Required, user ID +|''​status'' ​|| Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|- +|''​externalID'' ​|| Reserved field| 
-|<​code>​userName</​code> ​|| Required, user name +|''​entryReference'' ​|| Required, selects which page is the default entry page - Dashboard or Map Area| 
-|- +|''​firstName'' ​|| First name| 
-|<​code>​password</​code> ​|| Required, password +|''​lastName'' ​|| Last name| 
-|- +|''​emailAddress'' ​|| Email address| 
-|<​code>​status</​code> ​|| Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE +|''​activateDate'' ​|| Activation date| 
-|- +|''​deactiveDate'' ​|| Deactivation date| 
-|<​code>​externalID</​code> ​|| Reserved field +|''​allowMultipleSessions'' ​|| Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| 
-|- +|''​checkMessageInterval'' ​|| Check message interval| 
-|<​code>​entryReference</​code> ​|| Required, selects which page is the default entry page - Dashboard or Map Area +
-|- +
-|<​code>​firstName</​code> ​|| First name +
-|- +
-|<​code>​lastName</​code> ​|| Last name +
-|- +
-|<​code>​emailAddress</​code> ​|| Email address +
-|- +
-|<​code>​activateDate</​code> ​|| Activation date +
-|- +
-|<​code>​deactiveDate</​code> ​|| Deactivation date +
-|- +
-|<​code>​allowMultipleSessions</​code> ​|| Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously +
-|- +
-|<​code>​checkMessageInterval</​code> ​|| Check message interval +
-|}+
  
 Return value: String Return value: String
Line 537: Line 437:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​userID'' ​|| Required, user ID| 
-|- +
-|<​code>​userID</​code> ​|| Required, user ID +
-|}+
  
 Return value: String Return value: String
Line 552: Line 450:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​userName'' ​|| Required, user name| 
-|- +|''​newPassword'' ​|| Required, new password|
-|<​code>​userName</​code> ​|| Required, user name +
-|- +
-|<​code>​newPassword</​code> ​|| Required, new password +
-|}+
  
 Return value: String Return value: String
Line 569: Line 463:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​username</​code> ​|| Required, the user name to check for +|''​username'' ​|| Required, the user name to check for| 
-|}+
  
 Return value: bool Return value: bool
Line 580: Line 474:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​emailAddress</​code> ​|| Required, the email address to check for +|''​emailAddress'' ​|| Required, the email address to check for| 
-|}+
  
 Return value: bool Return value: bool
Line 592: Line 486:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​securityKey</​code> ​|| Required, user ID +|''​securityKey'' ​|| Required, user ID| 
-|- +|''​organizationID'' ​|| Required, organization ID| 
-|<​code>​organizationID</​code> ​|| Required, organization ID +
-|}+
  
 Return value: String Return value: String
Line 605: Line 498:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountid'' ​|| Required, account ID| 
-|- +
-|<​code>​accountid</​code> ​|| Required, account ID +
-|}+
  
 Return value: String Return value: String
Line 620: Line 511:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, organization ID| 
-|- +
-|<​code>​orgID</​code> ​|| Required, organization ID +
-|}+
  
 Return value: String Return value: String
Line 635: Line 524:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountid'' ​|| Required, account ID| 
-|- +
-|<​code>​accountid</​code> ​|| Required, account ID +
-|}+
  
 Return value: String Return value: String
Line 650: Line 537:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​deviceID'' ​|| Required, device ID| 
-|- +
-|<​code>​deviceID</​code> ​|| Required, device ID +
-|}+
  
 Return value: String Return value: String
Line 665: Line 550:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​deviceName'' ​|| Required, device name| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​description'' ​|| Device description| 
-|- +|''​topSpeed'' ​|| Required, top speed| 
-|<​code>​deviceName</​code> ​|| Required, device name +|''​status'' ​|| Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|- +|''​externalID'' ​|| Reserved field| 
-|<​code>​description</​code> ​|| Device description +|''​imei'' ​|| Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem| 
-|- +|''​cannedMessage'' ​|| Required, specifies whether or not the device supports two-way communication| 
-|<​code>​topSpeed</​code> ​|| Required, top speed +|''​deviceCategoryID'' ​|| Device category ID| 
-|- +|''​colorCode'' ​|| Choose a color to associate with the device, default is a random color| 
-|<​code>​status</​code> ​|| Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE +
-|- +
-|<​code>​externalID</​code> ​|| Reserved field +
-|- +
-|<​code>​imei</​code> ​|| Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem +
-|- +
-|<​code>​cannedMessage</​code> ​|| Required, specifies whether or not the device supports two-way communication +
-|- +
-|<​code>​deviceCategoryID</​code> ​|| Device category ID +
-|- +
-|<​code>​colorCode</​code> ​|| Choose a color to associate with the device, default is a random color +
-|}+
  
 Return value: DeviceID Return value: DeviceID
Line 698: Line 572:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​deviceID'' ​|| Required, device ID| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​deviceName'' ​|| Required, device name| 
-|- +|''​description'' ​|| Device description| 
-|<​code>​deviceID</​code> ​|| Required, device ID +|''​topSpeed'' ​|| Required, top speed| 
-|- +|''​status'' ​|| Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|<​code>​deviceName</​code> ​|| Required, device name +|''​externalID'' ​|| Reserved field| 
-|- +|''​imei'' ​|| Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem| 
-|<​code>​description</​code> ​|| Device description +|''​cannedMessage'' ​|| Required, specifies whether or not the device supports two-way communication| 
-|- +|''​deviceCategoryID'' ​|| Device category ID| 
-|<​code>​topSpeed</​code> ​|| Required, top speed +|''​colorCode'' ​|| Choose a color to associate with the device, default is a random color| 
-|- +
-|<​code>​status</​code> ​|| Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE +
-|- +
-|<​code>​externalID</​code> ​|| Reserved field +
-|- +
-|<​code>​imei</​code> ​|| Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem +
-|- +
-|<​code>​cannedMessage</​code> ​|| Required, specifies whether or not the device supports two-way communication +
-|- +
-|<​code>​deviceCategoryID</​code> ​|| Device category ID +
-|- +
-|<​code>​colorCode</​code> ​|| Choose a color to associate with the device, default is a random color +
-|}+
  
 Return value: String Return value: String
Line 733: Line 595:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​deviceID'' ​|| Required, device ID| 
-|- +
-|<​code>​deviceID</​code> ​|| Required, device ID +
-|}+
  
 Return value: String Return value: String
Line 749: Line 609:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +
-|<​code>​accountID</​code> ​|| Required, account ID +
-|}+
  
 Return value: String Return value: String
Line 764: Line 622:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​orgID'' ​|| Required, organization ID| 
-|- +
-|<​code>​orgID</​code> ​|| Required, organization ID +
-|}+
  
 Return value: String Return value: String
Line 779: Line 635:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​carrierID'' ​|| Required, carrier ID| 
-|- +
-|<​code>​carrierID</​code> ​|| Required, carrier ID +
-|}+
  
 Return value: String Return value: String
Line 794: Line 648:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​carrierID'' ​|| Required, carrier ID| 
-|- +
-|<​code>​carrierID</​code> ​|| Required, carrier ID +
-|}+
  
 Return value: String Return value: String
Line 809: Line 661:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​carrierName'' ​|| Required, carrier name| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​carrierPin'' ​|| Carrier'​s personal identification number, the default value is 0000| 
-|- +|''​status'' ​|| Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|<​code>​carrierName</​code> ​|| Required, carrier name +|''​externalID'' ​|| Reserved field| 
-|- +|''​colorCode'' ​|| Choose a color to associate with the device, default is a random color| 
-|<​code>​carrierPin</​code> ​|| Carrier'​s personal identification number, the default value is 0000 +
-|- +
-|<​code>​status</​code> ​|| Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE +
-|- +
-|<​code>​externalID</​code> ​|| Reserved field +
-|- +
-|<​code>​colorCode</​code> ​|| Choose a color to associate with the device, default is a random color +
-|}+
  
 Return value: CarrierID Return value: CarrierID
Line 834: Line 679:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​carrierID'' ​|| Required, carrier ID| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​carrierName'' ​|| Required, carrier name| 
-|- +|''​description'' ​|| Required, description of the carrier| 
-|<​code>​carrierID</​code> ​|| Required, carrier ID +|''​otherInformation'' ​|| Other information about the carrier, HTML supported. Will be displayed in a popup bubble on the tracking screen.| 
-|- +|''​carrierPin'' ​|| Carrier'​s personal identification number, the default value is 0000| 
-|<​code>​carrierName</​code> ​|| Required, carrier name +|''​status'' ​|| Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|- +|''​externalID'' ​|| Reserved field| 
-|<​code>​description</​code> ​|| Required, description of the carrier +|''​colorCode'' ​|| Choose a color to associate with the device, default is a random color| 
-|- +
-|<​code>​otherInformation</​code> ​|| Other information about the carrier, HTML supported. Will be displayed in a popup bubble on the tracking screen. +
-|- +
-|<​code>​carrierPin</​code> ​|| Carrier'​s personal identification number, the default value is 0000 +
-|- +
-|<​code>​status</​code> ​|| Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE +
-|- +
-|<​code>​externalID</​code> ​|| Reserved field +
-|- +
-|<​code>​colorCode</​code> ​|| Choose a color to associate with the device, default is a random color +
-|}+
  
 Return value: String Return value: String
Line 865: Line 700:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​carrierID'' ​|| Required, carrier ID|
-|- +
-|<​code>​carrierID</​code> ​|| Required, carrier ID +
-|}+
  
 Return value: String Return value: String
Line 880: Line 712:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​carrierID'' ​|| Required, carrier ID| 
-|- +|''​deviceID'' ​|| Required, device ID| 
-|<​code>​carrierID</​code> ​|| Required, carrier ID +
-|- +
-|<​code>​deviceID</​code> ​|| Required, device ID +
-|}+
  
 Return value: String Return value: String
Line 897: Line 726:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​carrierID'' ​|| Required, carrier ID| 
-|- +|''​deviceID'' ​|| Required, device ID|
-|<​code>​carrierID</​code> ​|| Required, carrier ID +
-|- +
-|<​code>​deviceID</​code> ​|| Required, device ID +
-|}+
  
 Return value: String Return value: String
Line 915: Line 740:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​severity'' ​|| Required, severity level| 
-|<​code>​accountID</​code> ​|| Required, account ID +
-|- +
-|<​code>​severity</​code> ​|| Required, severity level +
-|}+
  
 Return value: String Return value: String
Line 932: Line 754:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​organizationID'' ​|| Required, organization ID| 
-|- +|''​severity'' ​|| Required, severity level| 
-|<​code>​organizationID</​code> ​|| Required, organization ID +
-|- +
-|<​code>​severity</​code> ​|| Required, severity level +
-|}+
  
 Return value: String Return value: String
Line 949: Line 768:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​severity'' ​|| Required, severity level| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​additionalEmailAddresses'' ​|| Required| 
-|- +|''​alertPopupAction'' ​|| Required, popup action| 
-|<​code>​severity</​code> ​|| Required, severity level +|''​alertThreshold'' ​|| Required, alert threshold| 
-|- +|''​friendlyName'' ​|| Required, friendly name| 
-|<​code>​additionalEmailAddresses</​code> ​|| Required +|''​iconPath'' ​|| Required| 
-|- +|''​noisePath'' ​|| Required| 
-|<​code>​alertPopupAction</​code> ​|| Required, popup action +|''​overridden'' ​|| Required| 
-|- +|''​overrides'' ​|| Required| 
-|<​code>​alertThreshold</​code> ​|| Required, alert threshold +|''​repeat'' ​|| Required| 
-|- +|''​sendEmail'' ​|| Required| 
-|<​code>​friendlyName</​code> ​|| Required, friendly name +|''​severityColor'' ​|| Required| 
-|- +
-|<​code>​iconPath</​code> ​|| Required +
-|- +
-|<​code>​noisePath</​code> ​|| Required +
-|- +
-|<​code>​overridden</​code> ​|| Required +
-|- +
-|<​code>​overrides</​code> ​|| Required +
-|- +
-|<​code>​repeat</​code> ​|| Required +
-|- +
-|<​code>​sendEmail</​code> ​|| Required +
-|- +
-|<​code>​severityColor</​code> ​|| Required +
-|}+
  
 Return value: String Return value: String
Line 988: Line 793:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​organizationID'' ​|| Required, organization ID| 
-|- +|''​severity'' ​|| Required, severity level| 
-|<​code>​organizationID</​code> ​|| Required, organization ID +|''​additionalEmailAddresses'' ​|| Required| 
-|- +|''​alertPopupAction'' ​|| Required, popup action| 
-|<​code>​severity</​code> ​|| Required, severity level +|''​alertThreshold'' ​|| Required, alert threshold| 
-|- +|''​friendlyName'' ​|| Required, friendly name| 
-|<​code>​additionalEmailAddresses</​code> ​|| Required +|''​iconPath'' ​|| Required| 
-|- +|''​noisePath'' ​|| Required| 
-|<​code>​alertPopupAction</​code> ​|| Required, popup action +|''​overridden'' ​|| Required| 
-|- +|''​overrides'' ​|| Required| 
-|<​code>​alertThreshold</​code> ​|| Required, alert threshold +|''​repeat'' ​|| Required| 
-|- +|''​sendEmail'' ​|| Required| 
-|<​code>​friendlyName</​code> ​|| Required, friendly name +|''​severityColor'' ​|| Required| 
-|- +
-|<​code>​iconPath</​code> ​|| Required +
-|- +
-|<​code>​noisePath</​code> ​|| Required +
-|- +
-|<​code>​overridden</​code> ​|| Required +
-|- +
-|<​code>​overrides</​code> ​|| Required +
-|- +
-|<​code>​repeat</​code> ​|| Required +
-|- +
-|<​code>​sendEmail</​code> ​|| Required +
-|- +
-|<​code>​severityColor</​code> ​|| Required +
-|}+
  
 Return value: String Return value: String
Line 1028: Line 819:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for authentication +|''​adminUserName'' ​|| Required, admin user name for authentication| 
-|- +|''​adminPassword'' ​|| Required, admin password for authentication| 
-|<​code>​adminPassword</​code> ​|| Required, admin password for authentication +|''​IMEI'' ​|| Required, Device IMEI| 
-|- +|''​locationID'' ​|| Required, New Guid| 
-|<​code>​IMEI</​code> ​|| Required, Device IMEI +|''​logTime'' ​|| Required, GPS date time of message| 
-|- +|''​ypoint'' ​|| Required, Latitude| 
-|<​code>​locationID</​code> ​|| Required, New Guid +|''​xpoint'' ​|| Required, Longitude| 
-|- +|''​altitude'' ​|| Required, altitude| 
-|<​code>​logTime</​code> ​|| Required, GPS date time of message +|''​speed'' ​|| Required, device speed| 
-|- +|''​travelDirection'' ​|| Required, Travel Direction| 
-|<​code>​ypoint</​code> ​|| Required, Latitude +|''​speedUncertainty'' ​|| Required, Speed Uncertainty or not| 
-|- +|''​responseCode'' ​|| Required| 
-|<​code>​xpoint</​code> ​|| Required, Longitude +|''​assistanceUsed'' ​|| Required|
-|- +
-|<​code>​altitude</​code> ​|| Required, altitude +
-|- +
-|<​code>​speed</​code> ​|| Required, device speed +
-|- +
-|<​code>​travelDirection</​code> ​|| Required, Travel Direction +
-|- +
-|<​code>​speedUncertainty</​code> ​|| Required, Speed Uncertainty or not +
-|- +
-|<​code>​responseCode</​code> ​|| Required +
-|- +
-|<​code>​assistanceUsed</​code> ​|| Required +
-|}+
  
 Return value: LocationID Return value: LocationID
Line 1063: Line 841:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​locationID'' ​|| Required|
-|- +
-|<​code>​locationID</​code> ​|| Required +
-|}+
  
 Return value: String Return value: String
Line 1078: Line 853:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​userName</​code> ​|| Required, user name for authentication +|''​userName'' ​|| Required, user name for authentication| 
-|- +|''​password'' ​|| Required, password for authentication| 
-|<​code>​password</​code> ​|| Required, password for authentication +|''​lsessionD'' ​|| Required| 
-|- +
-|<​code>​lsessionD</​code> ​|| Required +
-|}+
  
 Return value: String Return value: String
Line 1097: Line 870:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installPassword</​code> ​|| Required, installer password for authentication +|''​adminUserName'' ​|| Required, admin user name for the account| 
-|- +|''​adminPassword'' ​|| Required, admin password| 
-|<​code>​adminUserName</​code> ​|| Required, admin user name for the account +|''​accountName'' ​|| Required, account name| 
-|- +|''​externalID'' ​|| Reserved field| 
-|<​code>​adminPassword</​code> ​|| Required, admin password +|''​status'' ​|| Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|- +|''​activateDate'' ​|| Account activation date| 
-|<​code>​accountName</​code> ​|| Required, account name +|''​deactivateDate'' ​|| Account deactivation date| 
-|- +|''​manageSecurity'' ​|| Can manage security or not| 
-|<​code>​externalID</​code> ​|| Reserved field +|''​manageBrand'' ​|| Can manage brand or not| 
-|- +|''​processLocationInfo'' ​|| Can process Location Information of map or not in account level| 
-|<​code>​status</​code> ​|| Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE +|''​termsOfUse'' ​|| Can use terms of use or not| 
-|- +|''​orgLimit'' ​|| Organization limit, default is -1 (unlimited)| 
-|<​code>​activateDate</​code> ​|| Account activation date +|''​monitorLimit'' ​|| Monitor limit, default is -1 (unlimited)| 
-|- +|''​carrierLimit'' ​|| Carrier limit, default is -1 (unlimited)| 
-|<​code>​deactivateDate</​code> ​|| Account deactivation date +|''​deviceLimit'' ​|| Device limit, default is -1 (unlimited)| 
-|- +|''​targetLimit'' ​|| Target limit, default is -1 (unlimited)| 
-|<​code>​manageSecurity</​code> ​|| Can manage security or not +|''​areaLimit'' ​|| Area limit, default is -1 (unlimited)| 
-|- +|''​securityPath'' ​|| If Two-Factor Authentication is enabled in Account General Settings, the security binary path will be used to judge whether or not this account is TwoFactorSecurity Valid when a user logs in.| 
-|<​code>​manageBrand</​code> ​|| Can manage brand or not +
-|- +
-|<​code>​processLocationInfo</​code> ​|| Can process Location Information of map or not in account level +
-|- +
-|<​code>​termsOfUse</​code> ​|| Can use terms of use or not +
-|- +
-|<​code>​orgLimit</​code> ​|| Organization limit, default is -1 (unlimited) +
-|- +
-|<​code>​monitorLimit</​code> ​|| Monitor limit, default is -1 (unlimited) +
-|- +
-|<​code>​carrierLimit</​code> ​|| Carrier limit, default is -1 (unlimited) +
-|- +
-|<​code>​deviceLimit</​code> ​|| Device limit, default is -1 (unlimited) +
-|- +
-|<​code>​targetLimit</​code> ​|| Target limit, default is -1 (unlimited) +
-|- +
-|<​code>​areaLimit</​code> ​|| Area limit, default is -1 (unlimited) +
-|- +
-|<​code>​securityPath</​code> ​|| If Two-Factor Authentication is enabled in Account General Settings, the security binary path will be used to judge whether or not this account is TwoFactorSecurity Valid when a user logs in. +
-|}+
  
 Return value: AccountID Return value: AccountID
Line 1146: Line 900:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +
-|<​code>​accountID</​code> ​|| Required, account ID +
-|}+
  
 Return value: String Return value: String
Line 1161: Line 913:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +
-|}+
  
 Return value: String Return value: String
Line 1174: Line 925:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installPassword</​code> ​|| Required, installer password for authentication +|''​accountID'' ​|| Required, account ID| 
-|- +|''​accountName'' ​|| Required, account name| 
-|<​code>​accountID</​code> ​|| Required, account ID +|''​externalID'' ​|| Reserved field| 
-|- +|''​status'' ​|| Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-|<​code>​accountName</​code> ​|| Required, account name +|''​activateDate'' ​|| Account activation date| 
-|- +|''​deactivateDate'' ​|| Account deactivation date| 
-|<​code>​externalID</​code> ​|| Reserved field +|''​manageSecurity'' ​|| Can manage security or not| 
-|- +|''​manageBrand'' ​|| Can manage brand or not| 
-|<​code>​status</​code> ​|| Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE +|''​processLocationInfo'' ​|| Can process Location Information of map or not in account level| 
-|- +|''​termsOfUse'' ​|| Can use terms of use or not| 
-|<​code>​activateDate</​code> ​|| Account activation date +|''​orgLimit'' ​|| Organization limit, default is -1 (unlimited)| 
-|- +|''​monitorLimit'' ​|| Monitor limit, default is -1 (unlimited)| 
-|<​code>​deactivateDate</​code> ​|| Account deactivation date +|''​carrierLimit'' ​|| Carrier limit, default is -1 (unlimited)| 
-|- +|''​deviceLimit'' ​|| Device limit, default is -1 (unlimited)| 
-|<​code>​manageSecurity</​code> ​|| Can manage security or not +|''​targetLimit'' ​|| Target limit, default is -1 (unlimited)| 
-|- +|''​areaLimit'' ​|| Area limit, default is -1 (unlimited)| 
-|<​code>​manageBrand</​code> ​|| Can manage brand or not +|''​securityPath'' ​|| If Two-Factor Authentication is enabled in Account General Settings, the security binary path will be used to judge whether or not this account is TwoFactorSecurity Valid when a user logs in.| 
-|- +
-|<​code>​processLocationInfo</​code> ​|| Can process Location Information of map or not in account level +
-|- +
-|<​code>​termsOfUse</​code> ​|| Can use terms of use or not +
-|- +
-|<​code>​orgLimit</​code> ​|| Organization limit, default is -1 (unlimited) +
-|- +
-|<​code>​monitorLimit</​code> ​|| Monitor limit, default is -1 (unlimited) +
-|- +
-|<​code>​carrierLimit</​code> ​|| Carrier limit, default is -1 (unlimited) +
-|- +
-|<​code>​deviceLimit</​code> ​|| Device limit, default is -1 (unlimited) +
-|- +
-|<​code>​targetLimit</​code> ​|| Target limit, default is -1 (unlimited) +
-|- +
-|<​code>​areaLimit</​code> ​|| Area limit, default is -1 (unlimited) +
-|- +
-|<​code>​securityPath</​code> ​|| If Two-Factor Authentication is enabled in Account General Settings, the security binary path will be used to judge whether or not this account is TwoFactorSecurity Valid when a user logs in. +
-|}+
  
 Return value: AccountID Return value: AccountID
Line 1221: Line 954:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +|''​accountID'' ​|| Required, account ID|
-|- +
-|<​code>​accountID</​code> ​|| Required, account ID +
-|}+
  
 Return value: String Return value: String
Line 1237: Line 967:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication|
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +
-|}+
  
 Return value: String Return value: String
Line 1250: Line 978:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +|''​languageID'' ​|| Required, language ID| 
-|- +
-|<​code>​languageID</​code> ​|| Required, language ID +
-|}+
  
 Return value: String Return value: String
Line 1265: Line 991:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication|
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +
-|}+
  
 Return value: String Return value: String
Line 1278: Line 1002:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +|''​languageID'' ​|| Required, language ID| 
-|- +
-|<​code>​languageID</​code> ​|| Required, language ID +
-|}+
  
 Return value: String Return value: String
Line 1293: Line 1015:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +|''​languageName'' ​|| Required, language name| 
-|- +|''​isSystem'' ​|| Required| 
-|<​code>​languageName</​code> ​|| Required, language name +|''​Status'' ​|| Required, status| 
-|- +
-|<​code>​isSystem</​code> ​|| Required +
-|- +
-|<​code>​Status</​code> ​|| Required, status +
-|}+
  
 Return value: String Return value: String
Line 1312: Line 1030:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +|''​languageID'' ​|| Required, language ID| 
-|- +|''​isSystem'' ​|| Required| 
-|<​code>​languageID</​code> ​|| Required, language ID +|''​Status'' ​|| Required, status| 
-|- +
-|<​code>​isSystem</​code> ​|| Required +
-|- +
-|<​code>​Status</​code> ​|| Required, status +
-|}+
  
 Return value: String Return value: String
Line 1331: Line 1045:
 Parameters: Parameters:
  
-:{| style="​width:​ 350px" + 
-|<​code>​installUserName</​code> ​|| Required, installer user name for authentication +|''​installUserName'' ​|| Required, installer user name for authentication| 
-|- +|''​installerPassword'' ​|| Required, installer password for authentication| 
-|<​code>​installerPassword</​code> ​|| Required, installer password for authentication +|''​languageID'' ​|| Required, language ID| 
-|- +|''​accountID'' ​|| Required, account ID| 
-|<​code>​languageID</​code> ​|| Required, language ID +|''​Status'' ​|| Required, status|
-|- +
-|<​code>​accountID</​code> ​|| Required, account ID +
-|- +
-|<​code>​Status</​code> ​|| Required, status +
-|}+
  
 Return value: String Return value: String
Line 1348: Line 1057:
  
 Return to the: [[Cygnus Track Developer Center]] Return to the: [[Cygnus Track Developer Center]]
- 
cygnus_track_portal_web_services_reference_guide.txt · Last modified: 2015/09/16 02:00 by admin

Page Tools