User Tools

Site Tools

Trace: • map_suite_mvc_edition_labeling_samples • map_suite_gis_editor_task_plugin_samples
map_suite_gps_tracking_server_web_services_reference_guide

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
map_suite_gps_tracking_server_web_services_reference_guide [2015/09/16 05:01]
admin 		map_suite_gps_tracking_server_web_services_reference_guide [2015/09/16 06:03] (current)
admin
Line 8: Line 8:
 ==== WSOrganizationManager Web Service ==== ==== WSOrganizationManager Web Service ====
 === GetOrganizationsForAccount method === === GetOrganizationsForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- |//securityKey//| + 
- |Required, user ID| +|''​securityKey''​|Required, user ID| 
-  +|''​accountID''​|Required, Account ID| 
- |//accountID//| + 
- |Required, Account ID| +Return value: String 
-  + 
- Return value: String +Function description:​ Gets an organization from an account.
-  +
- Function description:​ Gets an organization from an account.+
  
 === GetAllOrganizationForAccount method === === GetAllOrganizationForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, Account ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets all organizations from an account.
- |//accountID//| +
- |Required, Account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets all organizations from an account.+
  
 === GetOrganization method === === GetOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, Organization ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets an organization.
- |//orgID//| +
- |Required, Organization ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets an organization.+
  
 === CreateOrganization method === === CreateOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​orgName''​|Required, organization name| 
- |//password//| +|''​Description''​|Organization description| 
- |Required, password for authentication| +|''​mapDataID''​|Required, map Data ID| 
-  +|''​timeZone''​|Required, time zone of the organization'​s location| 
- |//accountID//| +|''​metric''​|Required, selects whether the organization'​s unit system is metric or imperial| 
- |Required, account ID| +|''​status''​|Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-  +|''​externalID''​|Reserved field| 
- |//orgName//| + 
- |Required, organization name| +Return value: OrganizationID 
-  + 
- |//Description//| +Function description:​ Creates an organization.
- |Organization description| +
-  +
- |//mapDataID//| +
- |Required, map Data ID| +
-  +
- |//timeZone//| +
- |Required, time zone of the organization'​s location| +
-  +
- |//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| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
-  +
- Return value: OrganizationID +
-  +
- Function description:​ Creates an organization.+
  
 === EditOrganization method === === EditOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​orgID''​|Required, organization ID| 
- |//password//| +|''​orgName''​|Required, organization name| 
- |Required, password for authentication| +|''​description''​|Organization description| 
-  +|''​manager''​|Manager of the organization| 
- |//accountID//| +|''​imageName''​|The path of the organization image| 
- |Required, account ID| +|''​mapDataID''​|Required, map data ID| 
-  +|''​timeZone''​|Required, time zone of the organization'​s location| 
- |//orgID//| +|''​metric''​|Required, selects whether the organization'​s unit system is metric or imperial| 
- |Required, organization ID| +|''​status''​|Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-  +|''​externalID''​|Reserved field| 
- |//orgName//| + 
- |Required, organization name| +Return value: String 
-  + 
- |//description//| +Function description:​ Edits an organization.
- |Organization description| +
-  +
- |//manager//| +
- |Manager of the organization| +
-  +
- |//imageName//| +
- |The path of the organization image| +
-  +
- |//mapDataID//| +
- |Required, map data ID| +
-  +
- |//timeZone//| +
- |Required, time zone of the organization'​s location| +
-  +
- |//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| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Edits an organization.+
  
 === DeleteOrganization method === === DeleteOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  +     ​ 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Deletes an organization in the system.
- |//orgID//| +
- |Required, organization ID| +
-  +
-        +
- Return value: String +
-  +
- Function description:​ Deletes an organization in the system.+
  
 === OrganizationAddDevice method === === OrganizationAddDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​userName''​|Required, user name for authentication| 
- |Required, user name for authentication| +|''​password''​|Required, password for authentication| 
-  +|''​orgID''​|Required, organization ID| 
- |//userName//| +|''​deviceID''​|Required, device ID| 
- |Required, user name for authentication| + 
-  +Return value: String 
- |//password//| + 
- |Required, password for authentication| +Function description:​ Adds a device to an organization.
-  +
- |//orgID//| +
- |Required, organization ID| +
-  +
- |//deviceID//| +
- |Required, device ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Adds a device to an organization.+
  
 === OrganizationAddCarrier method === === OrganizationAddCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  +|''​carrierID''​|Required, carrier ID| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//orgID//| +Function description:​ Adds a carrier to an organization.
- |Required, organization ID| +
-  +
- |//carrierID//| +
- |Required, carrier ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Adds a carrier to an organization.+
  
 === OrganizationAddMonitor method === === OrganizationAddMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  +|''​monitorID''​|Required, monitor ID| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//orgID//| +Function description:​ Adds a monitor to an organization.
- |Required, organization ID| +
-  +
- |//monitorID//| +
- |Required, monitor ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Adds a monitor to an organization.+
  
 === GetCarriersForOrganization method === === GetCarriersForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets the carriers in an organization.
- |//orgID//| +
- |Required, organization ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets the carriers in an organization.+
  
 === GetDevicesForOrganization method === === GetDevicesForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets the devices in an organization.
- |//orgID//| +
- |Required, organization ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets the devices in an organization.+
  
 === GetMonitorsForOrganization method === === GetMonitorsForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets the monitors in an organization.
- |//orgID//| +
- |Required, organization ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets the monitors in an organization.+
  
 === DeleteOrganizationCarrier method === === DeleteOrganizationCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  +|''​carrierID''​|Required, carrier ID| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//orgID//| +Function description:​ Deletes a carrier from an organization.
- |Required, organization ID| +
-  +
- |//carrierID//| +
- |Required, carrier ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes a carrier from an organization.+
  
 === DeleteOrganizationDevice method === === DeleteOrganizationDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, Organization ID| 
-  +|''​deviceID''​|Required, device ID| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//orgID//| +Function description:​ Deletes a device from an organization.
- |Required, Organization ID| +
-  +
- |//deviceID//| +
- |Required, device ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes a device from an organization.+
  
 === DeleteOrganizationMonitor method === === DeleteOrganizationMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  +|''​monitorID''​|Required, monitor ID| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//orgID//| +Function description:​ Deletes a monitor from an organization.
- |Required, organization ID| +
-  +
- |//monitorID//| +
- |Required, monitor ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes a monitor from an organization.+
  
 === GetAllMapDataForAccount method === === GetAllMapDataForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets all available map data for an account. 
- |//accountID//| + 
- |Required, account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets all available map data for an account. +
-  +
- +
 ==== WSMonitorManager Web Service ==== ==== WSMonitorManager Web Service ====
 === CreateMonitor method === === CreateMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminUserName''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​name''​|Required, Monitor name| 
- |//adminUserName//| +|''​description''​|Monitor description| 
- |Required, admin password for authentication| +|''​userName''​|Required, user name| 
-  +|''​password''​|Required, password| 
- |//accountID//| +|''​entryReference''​|Required, selects which page is the default entry page  
- |Required, account ID| + Dashboard or Map Area| 
-  +|''​status''​|Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| 
- |//name//| +|''​externalID''​|Reserved field| 
- |Required, Monitor name| + 
-  +Return value: MonitorID 
- |//description//| + 
- |Monitor description| +Function description:​ Creates a monitor.
-  +
- |//userName//| +
- |Required, user name| +
-  +
- |//password//| +
- |Required, password| +
-  +
- |//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| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
-  +
- Return value: MonitorID +
-  +
- Function description:​ Creates a monitor.+
  
 === EditMonitor method === === EditMonitor method ===
- Parameters +Parameters 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​monitorID''​|Monitor ID| 
- |//adminPassword//| +|''​name''​|Required, monitor name| 
- |Required, admin password for authentication| +|''​description''​|Monitor description| 
-  +|''​userName''​|Required, user name| 
- |//accountID//| +|''​password''​|Required, password| 
- |Required, account ID| +|''​entryReference''​|Required, selects which page is the default entry page  
-  + Dashboard or Map Area| 
- |//monitorID//| +|''​status''​|Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| 
- |Monitor ID| +|''​externalID''​|Reserved field| 
-  + 
- |//name//| +Return value: String 
- |Required, monitor name| + 
-  +Function description:​ Edits a monitor.
- |//description//| +
- |Monitor description| +
-  +
- |//userName//| +
- |Required, user name| +
-  +
- |//password//| +
- |Required, password| +
-  +
- |//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| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
- Return value: String +
-  +
- Function description:​ Edits a monitor.+
  
 === DeleteMonitor method === === DeleteMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminUserName''​|Required, admin user name for authentication| 
- |Required, admin user name for authentication| +|''​adminPassword''​|Required, admin password for authentication| 
-  +|''​MonitorID''​|Required, monitor ID| 
- |//adminUserName//| + 
- |Required, admin user name for authentication| +Return value: String 
-  + 
- |//adminPassword//| +Function description:​ Deletes a monitor from the system.
- |Required, admin password for authentication| +
-  +
- |//MonitorID//| +
- |Required, monitor ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes a monitor from the system.+
  
 === GetMonitor method === === GetMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​MonitorID''​|Required, monitor ID| 
-  + 
- |//adminPassword//| +Return value: String 
- |Required, admin password for authentication| + 
-  +Function description:​ Gets a monitor.
- |//MonitorID//| +
- |Required, monitor ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a monitor.+
  
 === GetMonitorsForAccount method === === GetMonitorsForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​accountID''​|Required, account ID| 
-  +             
- |//adminPassword//| +Return value: String 
- |Required, admin password for authentication| + 
-  +Function description:​ Gets monitors from an account.
- |//accountID//| +
- |Required, account ID| +
-  +
-             ​ +
- Return value: String +
-  +
- Function description:​ Gets monitors from an account.+
  
 === GetMonitorsForOrganization method === === GetMonitorsForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​orgID''​|Required, Organization ID| 
-  + 
- |//adminPassword//| +Return value: String 
- |Required, admin password for authentication| + 
-  +Function description:​ Gets monitors from an organization. 
- |//orgID//| + 
- |Required, Organization ID| + 
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets monitors from an organization. +
-  +
-  +
- +
 ==== WSUserManager Web Service ==== ==== WSUserManager Web Service ====
 === GetUsersForAccount method === === GetUsersForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​accountID''​|Required, account ID| 
-  + 
- |//adminPassword//| +Return value: String 
- |Required, admin password for authentication| + 
-  +Function description:​ Gets users from an account.
- |//accountID//| +
- |Required, account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets users from an account.+
  
 === GetUser method === === GetUser method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​userID''​|Required, user ID| 
-  + 
- |//adminPassword//| +Return value: String 
- |Required, admin password for authentication| + 
-  +Function description:​ Gets a user.
- |//userID//| +
- |Required, user ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a user.+
  
 === CreateUser method === === CreateUser method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​userName''​|Required, user name| 
- |//adminPassword//| +|''​password''​|Required, password| 
- |Required, admin password for authentication| +|''​status''​|Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-  +|''​externalID''​|Reserved field| 
- |//accountID//| +|''​entryReference''​|Required, selects which page is the default entry page  
- |Required, account ID| + Dashboard or Map Area| 
-  +|''​firstName''​|First name| 
- |//userName//| +|''​lastName''​|Last name| 
- |Required, user name| +|''​emailAddress''​|Email address| 
-  +|''​activateDate''​|Activation date| 
- |//password//| +|''​deactiveDate''​|Deactivation date| 
- |Required, password| +|''​allowMultipleSessions''​|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| 
-  +|''​checkMessageInterval''​|Check message interval| 
- |//status//| + 
- |Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| +Return value: UserID 
-  + 
- |//externalID//| +Function description:​ Creates a user.
- |Reserved field| +
-  +
- |//entryReference//| +
- |Required, selects which page is the default entry page - Dashboard or Map Area| +
-  +
- |//firstName//| +
- |First name| +
-  +
- |//lastName//| +
- |Last name| +
-  +
- |//emailAddress//| +
- |Email address| +
-  +
- |//activateDate//| +
- |Activation date| +
-  +
- |//deactiveDate//| +
- |Deactivation date| +
-  +
- |//allowMultipleSessions//| +
- |Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| +
-  +
- |//checkMessageInterval//| +
- |Check message interval| +
-  +
-  +
- Return value: UserID +
-  +
- Function description:​ Creates a user.+
  
 === EditUser method === === EditUser method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​userID''​|Required, user ID| 
- |//adminPassword//| +|''​userName''​|Required, user name| 
- |Required, admin password for authentication| +|''​password''​|Required, password| 
-  +|''​status''​|Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| 
- |//accountID//| +|''​externalID''​|Reserved field| 
- |Required, account ID| +|''​entryReference''​|Required, selects which page is the default entry page  
-  + Dashboard or Map Area| 
- |//userID//| +|''​firstName''​|First name| 
- |Required, user ID| +|''​lastName''​|Last name| 
-  +|''​emailAddress''​|Email address| 
- |//userName//| +|''​activateDate''​|Activation date| 
- |Required, user name| +|''​deactiveDate''​|Deactivation date| 
-  +|''​allowMultipleSessions''​|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| 
- |//password//| +|''​checkMessageInterval''​|Check message interval| 
- |Required, password| + 
-  +Return value: String 
- |//status//| + 
- |Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| +Function description:​ Edits a user.
-  +
- |//externalID//| +
- |Reserved field| +
-  +
- |//entryReference//| +
- |Required, selects which page is the default entry page - Dashboard or Map Area| +
-  +
- |//firstName//| +
- |First name| +
-  +
- |//lastName//| +
- |Last name| +
-  +
- |//emailAddress//| +
- |Email address| +
-  +
- |//activateDate//| +
- |Activation date| +
-  +
- |//deactiveDate//| +
- |Deactivation date| +
-  +
- |//allowMultipleSessions//| +
- |Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| +
-  +
- |//checkMessageInterval//| +
- |Check message interval| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Edits a user.+
  
 === DeleteUser method === === DeleteUser method ===
- Parameters +Parameters 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​userID''​|Required, user ID| 
-  + 
- |//adminPassword//| +Return value: String 
- |Required, admin password for authentication| + 
-  +Function description:​ Deletes a user from the system.
- |//userID//| +
- |Required, user ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes a user from the system.+
  
 === ChangeUserPassword method === === ChangeUserPassword method ===
- Parameters +Parameters 
-  + 
-  + 
-  +|''​adminUserName''​|Required, admin user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, admin password for authentication| 
- |Required, admin user name for authentication| +|''​userName''​|Required, user name| 
-  +|''​newPassword''​|Required, new password| 
- |//adminPassword//| + 
- |Required, admin password for authentication| +Return value: String 
-  + 
- |//userName//| +Function description:​ Change a user's password.
- |Required, user name| +
-  +
- |//newPassword//| +
- |Required, new password| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Change a user's password.+
  
 === IsUserNameInUse method === === IsUserNameInUse method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​username''​|Required, the user name to check for| 
- |//username//| +                   ​ 
- |Required, the user name to check for| +Return value: bool 
-  + 
-                     +Function description:​ Checks whether a specified username is in use.
- Return value: bool +
-  +
- Function description:​ Checks whether a specified username is in use.+
  
 === IsEmailInUse method === === IsEmailInUse method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​emailAddress''​|Required, the email address to check for| 
- |//emailAddress//| + 
- |Required, the email address to check for| +Return value: bool 
-  + 
-  +Function description:​ Checks whether a specified user email address is in use. 
- Return value: bool + 
-  +
- Function description:​ Checks whether a specified user email address is in use. +
-  +
- +
 ==== WSDeviceManager Web Service ==== ==== WSDeviceManager Web Service ====
 === GetDevicesForOrganization method === === GetDevicesForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​securityKey''​|Required, user ID| 
- |//securityKey//| +|''​organizationID''​|Required, organization ID| 
- |Required, user ID| + 
-  +Return value: String 
- |//organizationID//| + 
- |Required, organization ID| +Function description:​ Gets the devices from an organization.
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets the devices from an organization.+
  
 === GetDevicesForAccount method === === GetDevicesForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountid''​|Required, account ID| 
-  +   
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets the devices from an account.
- |//accountid//| +
- |Required, account ID| +
-  +
-   ​ +
- Return value: String +
-  +
- Function description:​ Gets the devices from an account.+
  
 === GetAllDevicesForOrganization method === === GetAllDevicesForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets all devices from an organization.
- |//orgID//| +
- |Required, organization ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets all devices from an organization.+
  
 === GetDeviceCategories method === === GetDeviceCategories method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets the device categories.
- |//accountID//| +
- |Required, account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets the device categories.+
  
 === GetDevice method === === GetDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​deviceID''​|Required, device ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets a device.
- |//deviceID//| +
- |Required, device ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a device.+
  
 === CreateDevice method === === CreateDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​deviceName''​|Required, device name| 
- |//password//| +|''​description''​|Device description| 
- |Required, password for authentication| +|''​topSpeed''​|Required, top speed| 
-  +|''​status''​|Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| 
- |//accountID//| +|''​externalID''​|Reserved field| 
- |Required, account ID| +|''​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 
- |//deviceName//| +way communication| 
- |Required, device name| +|''​deviceCategoryID''​|Device category ID| 
-  +|''​colorCode''​|Choose a color to associate with the device, default is a random color| 
- |//description//| + 
- |Device description| +Return value: DeviceID 
-  + 
- |//topSpeed//| +Function description:​ Creates a device.
- |Required, top speed| +
-  +
- |//status//| +
- |Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
- |//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| +
-  +
- |//deviceCategoryID//| +
- |Device category ID| +
-  +
- |//colorCode//| +
- |Choose a color to associate with the device, default is a random color| +
-  +
-  +
- Return value: DeviceID +
-  +
- Function description:​ Creates a device.+
  
 === EditDevice method === === EditDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​DeviceID''​|Required, device ID| 
- |//password//| +|''​deviceName''​|Required, device name| 
- |Required, password for authentication| +|''​description''​|Device description| 
-  +|''​topSpeed''​|Required, top speed| 
- |//accountID//| +|''​status''​|Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| 
- |Required, account ID| +|''​externalID''​|Reserved field| 
-  +|''​imei''​|Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem| 
- |//DeviceID//| +|''​cannedMessage''​|Required, specifies whether or not the device supports two 
- |Required, device ID| +way communication| 
-  +|''​deviceCategoryID''​|Device category ID| 
- |//deviceName//| +|''​colorCode''​|Choose a color to associate with the device, default is a random color| 
- |Required, device name| + 
-  +Return value: String 
- |//description//| + 
- |Device description| +Function description:​ Edits a carrier.
-  +
- |//topSpeed//| +
- |Required, top speed| +
-  +
- |//status//| +
- |Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
- |//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| +
-  +
- |//deviceCategoryID//| +
- |Device category ID| +
-  +
- |//colorCode//| +
- |Choose a color to associate with the device, default is a random color| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Edits a carrier.+
  
 === DeleteDevice method === === DeleteDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​deviceID''​|Required, device ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Delete a device from the system. 
- |//deviceID//| + 
- |Required, device ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Delete a device from the system. +
-  +
- +
 ==== WSCarrierManager Web Service ==== ==== WSCarrierManager Web Service ====
 === GetCarriersForAccount method === === GetCarriersForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets the carriers from an account.
- |//accountID//| +
- |Required, account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets the carriers from an account.+
  
 === GetCarriersForOrganization method === === GetCarriersForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​orgID''​|Required, organization ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets the carriers from an organization.
- |//orgID//| +
- |Required, organization ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets the carriers from an organization.+
  
 === GetCarriersDevice method === === GetCarriersDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​carrierID''​|Required, carrier ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets a carrier'​s device.
- |//carrierID//| +
- |Required, carrier ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a carrier'​s device.+
  
 === GetCarriers method === === GetCarriers method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​carrierID''​|Required, carrier ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Gets a carrier.
- |//carrierID//| +
- |Required, carrier ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a carrier.+
  
 === CreateCarrier method === === CreateCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​carrierName''​|Required, carrier name| 
- |//password//| +|''​carrierPin''​|Carrier'​s personal identification number, the default value is 0000| 
- |Required, password for authentication| +|''​status''​|Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-  +|''​externalID''​|Reserved field| 
- |//accountID//| +|''​colorCode''​|Choose a color to associate with the device, default is a random color| 
- |Required, account ID| + 
-  +Return value: CarrierID 
- |//carrierName//| + 
- |Required, carrier name| +Function description:​ Creates a carrier.
-  +
- |//carrierPin//| +
- |Carrier'​s personal identification number, the default value is 0000| +
-  +
- |//status//| +
- |Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
- |//colorCode//| +
- |Choose a color to associate with the device, default is a random color| +
-  +
-  +
- Return value: CarrierID +
-  +
- Function description:​ Creates a carrier.+
  
 === EditCarrier method === === EditCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​carrierID''​|Required, carrier ID| 
- |//password//| +|''​carrierName''​|Required, carrier name| 
- |Required, password for authentication| +|''​description''​|Required, description of the carrier| 
-  +|''​otherInformation''​|Other information about the carrier, HTML supported. ​ Will be displayed in a popup bubble on the tracking screen.| 
- |//accountID//| +|''​carrierPin''​|Carrier'​s personal identification number, the default value is 0000| 
- |Required, account ID| +|''​status''​|Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-  +|''​externalID''​|Reserved field| 
- |//carrierID//| +|''​colorCode''​|Choose a color to associate with the device, default is a random color| 
- |Required, carrier ID| + 
-  +Return value: String 
- |//carrierName//| + 
- |Required, carrier name| +Function description:​ Edits a carrier.
-  +
- |//description//| +
- |Required, description of the carrier| +
-  +
- |//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| +
-  +
- |//status//| +
- |Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| +
-  +
- |//externalID//| +
- |Reserved field| +
-  +
- |//colorCode//| +
- |Choose a color to associate with the device, default is a random color| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Edits a carrier.+
  
 === DeleteCarrier method === === DeleteCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​carrierID''​|Required, carrier ID| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Deletes a carrier from the system.
- |//carrierID//| +
- |Required, carrier ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes a carrier from the system.+
  
 === CarrierAddDevice method === === CarrierAddDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​carrierID''​|Required, carrier ID| 
-  +|''​deviceID''​|Required, device ID| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//carrierID//| +Function description:​ Assigns a device to a carrier.
- |Required, carrier ID| +
-  +
- |//deviceID//| +
- |Required, device ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Assigns a device to a carrier.+
  
 === CarrierDeleteDevice method === === CarrierDeleteDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​carrierID''​|Required, carrier ID| 
-  +|''​deviceID''​|Required, device ID| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//carrierID//| +Function description:​ Disassociates a device from a carrier. 
- |Required, carrier ID| + 
-  +
- |//deviceID//| +
- |Required, device ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Disassociates a device from a carrier. +
-  +
- +
 ==== WSAlertManager Web Service ==== ==== WSAlertManager Web Service ====
 === LoadEventResponseForAccount method === === LoadEventResponseForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​serverity''​|Required, serverity level| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//accountID//| +Function description:​ Loads an event response for an account.
- |Required, account ID| +
-  +
- |//serverity//| +
- |Required, serverity level| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Loads an event response for an account.+
  
 === LoadEventResponseForOrganization method === === LoadEventResponseForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​organizationID''​|Required, organization ID| 
-  +|''​serverity''​|Required, serverity| 
- |//password//| + 
- |Required, password for authentication| +Return value: String 
-  + 
- |//organizationID//| +Function description:​ Loads an event response for an organization.
- |Required, organization ID| +
-  +
- |//serverity//| +
- |Required, serverity| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Loads an event response for an organization.+
  
 === EditEventResponseForAccount method === === EditEventResponseForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​serverity''​|Required, serverity| 
- |//password//| +|''​additionalEmailAddresses''​|Required| 
- |Required, password for authentication| +|''​alertPopupAction''​|Required, popup action| 
-  +|''​alertThreshold''​|Required, alert threshold| 
- |//accountID//| +|''​friendlyName''​|Required, friendly name| 
- |Required, account ID| +|''​iconPath''​|Required| 
-  +|''​noisePath''​|Required| 
- |//serverity//| +|''​overridden''​|Required| 
- |Required, serverity| +|''​overrides''​|Required| 
-  +|''​repeat''​|Required| 
- |//additionalEmailAddresses//| +|''​sendEmail''​|Required| 
- |Required| +|''​severityColor''​|Required| 
-  + 
- |//alertPopupAction//| +Return value: String 
- |Required, popup action| + 
-  +Function description:​ Edits an event response for an account.
- |//alertThreshold//| +
- |Required, alert threshold| +
-  +
- |//friendlyName//| +
- |Required, friendly name| +
-  +
- |//iconPath//| +
- |Required| +
-  +
- |//noisePath//| +
- |Required| +
-  +
- |//overridden//| +
- |Required| +
-  +
- |//overrides//| +
- |Required| +
-  +
- |//repeat//| +
- |Required| +
-  +
- |//sendEmail//| +
- |Required| +
-  +
- |//severityColor//| +
- |Required| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Edits an event response for an account.+
  
 === EditEventResponseFor Organization method === === EditEventResponseFor Organization method ===
- Parameters: +Parameters:
-  +
-  +
-  +
- |//​userName//​| +
- |Required,​ user name for authentication| +
-  +
- |//​password//​| +
- |Required,​ password for authentication| +
-  +
- |//​organizationID//​| +
- |Required,​ organization ID| +
-  +
- |//​serverity//​| +
- |Required,​ serverity| +
-  +
- |//​additionalEmailAddresses//​| +
- |Required| +
-  +
- |//​alertPopupAction//​| +
- |Required,​ popup action| +
-  +
- |//​alertThreshold//​| +
- |Required,​ alert threshold| +
-  +
- |//​friendlyName//​| +
- |Required,​ friendly name| +
-  +
- |//​iconPath//​| +
- |Required|+
  
- |//​noisePath//​| + 
- |Required| +|''​userName''​|Required,​ user name for authentication| 
-  +|''​password''​|Required, password for authentication| 
- |//​overridden//​| +|''​organizationID''​|Required,​ organization ID| 
- |Required| +|''​serverity''​|Required,​ serverity| 
-  +|''​additionalEmailAddresses''​|Required| 
- |//​overrides//​| +|''​alertPopupAction''​|Required,​ popup action| 
- |Required| +|''​alertThreshold''​|Required,​ alert threshold| 
-  +|''​friendlyName''​|Required, friendly name| 
- |//repeat//| +|''​iconPath''​|Required| 
- |Required| +|''​noisePath''​|Required| 
-  +|''​overridden''​|Required| 
- |//​sendEmail//​| +|''​overrides''​|Required| 
- |Required| +|''​repeat''​|Required| 
-  +|''​sendEmail''​|Required| 
- |//​severityColor//​| +|''​severityColor''​|Required| 
- |Required| + 
-  +Return value: String 
-  + 
- Return value: String +Function description:​ Edits an event response for an organization.
-  +
- Function description:​ Edits an event response for an organization.+
  
  
 ==== WSLocationManager Web Service ==== ==== WSLocationManager Web Service ====
 === CreateLocation method === === CreateLocation method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​adminUserName''​|Required, user name for authentication| 
- |//adminUserName//| +|''​adminPassword''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​IMEI''​|Required, Device IMEI| 
-  +|''​locationID''​|Required, New Guid| 
- |//adminPassword//| +|''​logTime''​|Required, GPS date time of message| 
- |Required, password for authentication| +|''​yPoint''​|Required, Latitude| 
-  +|''​xPoint''​|Required, Longitude| 
- |//IMEI//| +|''​altitude''​|Required, altitude| 
- |Required, Device IMEI| +|''​speed''​|Required, device speed| 
-  +|''​travelDirection''​|Required, Travel Direction| 
- |//locationID//| +|''​speedUncertainty''​|Required, Speed Uncertainty or not| 
- |Required, New Guid| +|''​responseCode''​|Required| 
-  +|''​assistanceUsed''​|Required| 
- |//logTime//| + 
- |Required, GPS date time of message| +Return value: LocationID 
-  + 
- |//yPoint//| +Function description:​ Create a location for device.
- |Required, Latitude| +
-  +
- |//xPoint//| +
- |Required, Longitude| +
-  +
- |//altitude//| +
- |Required, altitude| +
-  +
- |//speed//| +
- |Required, device speed| +
-  +
- |//travelDirection//| +
- |Required, Travel Direction| +
- |//speedUncertainty//| +
- |Required, Speed Uncertainty or not| +
-  +
- |//responseCode//| +
- |Required| +
-  +
- |//assistanceUsed//| +
- |Required| +
-  +
-  +
- Return value: LocationID +
-  +
- Function description:​ Create a location for device.+
  
 === GetCurrentLocationByDevice method === === GetCurrentLocationByDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​deviceID''​|Required| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Get current location for the device.
- |//deviceID//| +
- |Required| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Get current location for the device.+
  
 === GetLocationBySession method === === GetLocationBySession method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​userName''​|Required, user name for authentication| 
- |//userName//| +|''​password''​|Required, password for authentication| 
- |Required, user name for authentication| +|''​lsessionD''​|Required| 
-  + 
- |//password//| +Return value: String 
- |Required, password for authentication| + 
-  +Function description:​ Get locations for the session.
- |//lsessionD//| +
- |Required| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Get locations for the session.+
  
  
Line 1436: Line 809:
 ==== WSAccountManager Web Service ==== ==== WSAccountManager Web Service ====
 === CreateAccount method === === CreateAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​adminUserName''​|Required, admin user name for the account| 
-  +|''​adminPassword''​|Required, admin password| 
- |//installPassword//| +|''​accountName''​|Required, account name| 
- |Required, installer password for authentication| +|''​externalID''​|Reserved field| 
-  +|''​status''​|Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| 
- |//adminUserName//| +|''​activateDate''​|Account activation date| 
- |Required, admin user name for the account| +|''​deactivateDate''​|Account deactivation date| 
-  +|''​manageSecurity''​|Can manage security or not| 
- |//adminPassword//| +|''​manageBrand''​|Can manage brand or not| 
- |Required, admin password| +|''​processLocationInfo''​|Can process LocationInformation of map or not in account level| 
-  +|''​termsOfUse''​|Can use terms of use or not| 
- |//accountName//| +|''​orgLimit''​|Organization limit, default is -1 (unlimited)| 
- |Required, account name| +|''​monitorLimit''​|Monitor limit, default is -1 (unlimited)| 
-  +|''​carrierLimit''​|Carrier limit, default is -1 (unlimited)| 
- |//externalID//| +|''​deviceLimit''​|Device limit, default is -1 (unlimited)| 
- |Reserved field| +|''​targetLimit''​|Target limit, default is -1 (unlimited)| 
-  +|''​areaLimit''​|Area limit, default is -1 (unlimited)| 
- |//status//| +|''​securityPath''​|If Two 
- |Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| +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.| 
-  + 
- |//activateDate//| +Return value: AccountID 
- |Account activation date| + 
-  +Function description:​ Creates an account at the installer level.
- |//deactivateDate//| +
- |Account deactivation date| +
-  +
- |//manageSecurity//| +
- |Can manage security or not| +
-  +
- |//manageBrand//| +
- |Can manage brand or not| +
-  +
- |//processLocationInfo//| +
- |Can process LocationInformation of map or not in account level| +
-  +
- |//termsOfUse//| +
- |Can use terms of use or not| +
-  +
- |//orgLimit//| +
- |Organization limit, default is -1 (unlimited)| +
-  +
- |//monitorLimit//| +
- |Monitor limit, default is -1 (unlimited)| +
-  +
- |//carrierLimit//| +
- |Carrier limit, default is -1 (unlimited)| +
-  +
- |//deviceLimit//| +
- |Device limit, default is -1 (unlimited)| +
-  +
- |//targetLimit//| +
- |Target limit, default is -1 (unlimited)| +
-  +
- |//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.| +
-  +
-  +
- Return value: AccountID +
-  +
- Function description:​ Creates an account at the installer level.+
  
 === GetAccount method === === GetAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​accountID''​|Required, account ID| 
-  + 
- |//installPassword//| +Return value: String 
- |Required, installer password for authentication| + 
-  +Function description:​ Checks to see whether the account exists in the system. 
- |//accountID//| + 
- |Required, account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Checks to see whether the account exists in the system. +
-  +
- +
 === GetAllAccounts method === === GetAllAccounts method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +           
-  +Return value: String 
- |//installPassword//| + 
- |Required, installer password for authentication| +Function description:​ Gets all of the accounts under this installation.
-  +
-           ​ +
- Return value: String +
-  +
- Function description:​ Gets all of the accounts under this installation.+
  
 === EditAccount method === === EditAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​accountID''​|Required, account ID| 
-  +|''​accountName''​|Required, account name| 
- |//installPassword//| +|''​externalID''​|Reserved field| 
- |Required, installer password for authentication| +|''​status''​|Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| 
-  +|''​activateDate''​|Account activation date| 
- |//accountID//| +|''​deactivateDate''​|Account deactivation date| 
- |Required, account ID| +|''​manageSecurity''​|Can manage security or not| 
-  +|''​manageBrand''​|Can manage branding or not| 
- |//accountName//| +|''​processLocationInfo''​|Can process LocationInformation of the map at the account level or not| 
- |Required, account name| +|''​termsOfUse''​|Can apply Terms of Use or not| 
-  +|''​orgLimit''​|Organization limit, default is -1 (unlimited)| 
- |//externalID//| +|''​monitorLimit''​|Monitor limit, default is -1 (unlimited)| 
- |Reserved field| +|''​carrierLimit''​|Carrier limit, default is -1 (unlimited)| 
-  +|''​deviceLimit''​|Device limit, default is -1 (unlimited)| 
- |//status//| +|''​targetLimit''​|Target limit, default is -1 (unlimited)| 
- |Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| +|''​areaLimit''​|Area limit, default is -1 (unlimited)| 
-  +|''​securityPath''​|If Two 
- |//activateDate//| +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.| 
- |Account activation date| + 
-  +Return value: AccountID 
- |//deactivateDate//| + 
- |Account deactivation date| +Function description:​ Edits an account at the installer level.
-  +
- |//manageSecurity//| +
- |Can manage security or not| +
-  +
- |//manageBrand//| +
- |Can manage branding or not| +
-  +
- |//processLocationInfo//| +
- |Can process LocationInformation of the map at the account level or not| +
-  +
- |//termsOfUse//| +
- |Can apply Terms of Use or not| +
-  +
- |//orgLimit//| +
- |Organization limit, default is -1 (unlimited)| +
-  +
- |//monitorLimit//| +
- |Monitor limit, default is -1 (unlimited)| +
-  +
- |//carrierLimit//| +
- |Carrier limit, default is -1 (unlimited)| +
-  +
- |//deviceLimit//| +
- |Device limit, default is -1 (unlimited)| +
-  +
- |//targetLimit//| +
- |Target limit, default is -1 (unlimited)| +
-  +
- |//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.| +
-  +
-  +
- Return value: AccountID +
-  +
- Function description:​ Edits an account at the installer level.+
  
 === DeleteAccount method === === DeleteAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​accountID''​|Required, Account ID| 
-  + 
- |//installPassword//| +Return value: String 
- |Required, installer password for authentication| + 
-  +Function description:​ Deletes an account in the system at the installer level.
- |//accountID//| +
- |Required, Account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes an account in the system at the installer level.+
  
  
Line 1631: Line 907:
 ==== WSLanguageManager Web Service ==== ==== WSLanguageManager Web Service ====
 === GetLanguageList method === === GetLanguageList method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| + 
-  +Return value: String 
- |//installPassword//| + 
- |Required, installer password for authentication| +Function description:​ Gets a list of languages available in the installation.
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a list of languages available in the installation.+
  
 === GetLanguage method === === GetLanguage method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​languageID''​|Required, language ID| 
-  + 
- |//installPassword//| +Return value: String 
- |Required, installer password for authentication| + 
-  +Function description:​ Gets a language.
- |//languageID//| +
- |Required, language ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a language.+
  
 === GetSystemLanguageList method === === GetSystemLanguageList method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| + 
-  +Return value: String 
- |//installPassword//| + 
- |Required, installer password for authentication| +Function description:​ Gets a list of the available system languages.
-  +
-  +
- Return value: String +
-  +
- Function description:​ Gets a list of the available system languages.+
  
 === LanguageDelete method === === LanguageDelete method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​languageID''​|Required, language ID| 
-  + 
- |//installPassword//| +Return value: String 
- |Required, installer password for authentication| + 
-  +Function description:​ Deletes a language.
- |//languageID//| +
- |Required, language ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Deletes a language.+
  
 === CreateLanguage method === === CreateLanguage method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​languageName''​|Required, language name| 
-  +|''​isSystem''​|Required| 
- |//installPassword//| +|''​Status''​|Required, status| 
- |Required, installer password for authentication| + 
-  +Return value: String 
- |//languageName//| + 
- |Required, language name| +Function description:​ Creates a new language.
-  +
- |//isSystem//| +
- |Required| +
-  +
- |//Status//| +
- |Required, status| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Creates a new language.+
  
 === EditLanguage method === === EditLanguage method ===
- Parameters:​ +Parameters:​ 
-  + 
-  + 
-  +|''​installUserName''​|Required, installer user name for authentication| 
- |//installUserName//| +|''​installPassword''​|Required, installer password for authentication| 
- |Required, installer user name for authentication| +|''​languageID''​|Required, language ID| 
-  +|''​languageName''​|Required, language name| 
- |//installPassword//| +|''​isSystem''​|Required| 
- |Required, installer password for authentication| +|''​Status''​|Required, status| 
-  + 
- |//languageID//| +Return value: String 
- |Required, language ID| + 
-  +Function description:​ Edits a language.
- |//languageName//| +
- |Required, language name| +
-  +
- |//isSystem//| +
- |Required| +
-  +
- |//Status//| +
- |Required, status| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Edits a language.+
  
 === SetLanguageForUser method === === SetLanguageForUser method ===
- Parameters: +Parameters:
-  +
-  +
-  +
- |//​installUserName//​| +
- |Required,​ installer user name for authentication| +
-  +
- |//​installPassword//​| +
- |Required,​ installer password for authentication| +
-  +
- |//​languageID//​| +
- |Required,​ language ID| +
-  +
- |//​accountID//​| +
- |Required,​ account ID| +
-  +
-  +
- Return value: String +
-  +
- Function description:​ Sets the language for a user.+
  
  
 +|''​installUserName''​|Required,​ installer user name for authentication|
 +|''​installPassword''​|Required,​ installer password for authentication|
 +|''​languageID''​|Required,​ language ID|
 +|''​accountID''​|Required,​ account ID|
  
 +Return value: String
  
 +Function description:​ Sets the language for a user.
map_suite_gps_tracking_server_web_services_reference_guide.1442379710.txt.gz · Last modified: 2015/09/16 05:01 by admin

Page Tools