User Tools

Site Tools

Trace:
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:58]
admin 		map_suite_gps_tracking_server_web_services_reference_guide [2015/09/16 06:03] (current)
admin
Line 9: Line 9:
 === 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''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​accountID''​|Required,​ Account ID| |''​accountID''​|Required,​ Account ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Gets all organizations from an account. Function description:​ Gets all organizations from an account.
  
 === GetOrganization method === === GetOrganization method ===
-Parameters:​ +Parameters: 
 + 
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ Organization ID| |''​orgID''​|Required,​ Organization ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Gets an organization. Function description:​ Gets an organization.
  
 === CreateOrganization method === === CreateOrganization method ===
-Parameters:​ +Parameters: 
 + 
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 48: Line 56:
 |''​status''​|Required,​ organization status, must be ACTIVE or INACTIVE, default is ACTIVE| |''​status''​|Required,​ organization status, must be ACTIVE or INACTIVE, default is ACTIVE|
 |''​externalID''​|Reserved field| |''​externalID''​|Reserved field|
- +
 Return value: OrganizationID Return value: OrganizationID
- +
 Function description:​ Creates an organization. Function description:​ Creates an organization.
  
 === EditOrganization method === === EditOrganization method ===
-Parameters:​ +Parameters: 
 + 
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 68: Line 78:
 |''​status''​|Required,​ organization status, must be ACTIVE or INACTIVE, default is ACTIVE| |''​status''​|Required,​ organization status, must be ACTIVE or INACTIVE, default is ACTIVE|
 |''​externalID''​|Reserved field| |''​externalID''​|Reserved field|
- +
 Return value: String Return value: String
- +
 Function description:​ Edits an organization. Function description:​ Edits an organization.
  
 === DeleteOrganization method === === DeleteOrganization method ===
 Parameters: Parameters:
 +
 +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
-       +     
 Return value: String Return value: String
- +
 Function description:​ Deletes an organization in the system. Function description:​ Deletes an organization in the system.
  
 === OrganizationAddDevice method === === OrganizationAddDevice method ===
-Parameters:​ +Parameters: 
 + 
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
Line 90: Line 104:
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
 |''​deviceID''​|Required,​ device ID| |''​deviceID''​|Required,​ device ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Adds a device to an organization. Function description:​ Adds a device to an organization.
  
 === OrganizationAddCarrier method === === OrganizationAddCarrier method ===
 Parameters: Parameters:
 +
 +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
 |''​carrierID''​|Required,​ carrier ID| |''​carrierID''​|Required,​ carrier ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Adds a carrier to an organization. Function description:​ Adds a carrier to an organization.
  
 === OrganizationAddMonitor method === === OrganizationAddMonitor method ===
-Parameters:​ +Parameters: 
 + 
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
 |''​monitorID''​|Required,​ monitor ID| |''​monitorID''​|Required,​ monitor ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Adds a monitor to an organization. Function description:​ Adds a monitor to an organization.
  
 === GetCarriersForOrganization method === === GetCarriersForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
- +
 Return value: String Return value: String
  
Line 130: Line 148:
  
 === GetDevicesForOrganization method === === GetDevicesForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Gets the devices in an organization. Function description:​ Gets the devices in an organization.
  
 === GetMonitorsForOrganization method === === GetMonitorsForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Gets the monitors in an organization. Function description:​ Gets the monitors in an organization.
  
 === DeleteOrganizationCarrier method === === DeleteOrganizationCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
 |''​carrierID''​|Required,​ carrier ID| |''​carrierID''​|Required,​ carrier ID|
- +
 Return value: String Return value: String
- +
 Function description:​ Deletes a carrier from an organization. Function description:​ Deletes a carrier from an organization.
  
 === DeleteOrganizationDevice method === === DeleteOrganizationDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ Organization ID| |''​orgID''​|Required,​ Organization ID|
 |''​deviceID''​|Required,​ device ID| |''​deviceID''​|Required,​ device ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Deletes a device from an organization.+Function description:​ Deletes a device from an organization.
  
 === DeleteOrganizationMonitor method === === DeleteOrganizationMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
 |''​monitorID''​|Required,​ monitor ID| |''​monitorID''​|Required,​ monitor ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Deletes a monitor from an organization.+Function description:​ Deletes a monitor from an organization.
  
 === GetAllMapDataForAccount method === === GetAllMapDataForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets all available map data for an account. +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''​|Required,​ admin user name for authentication|
 |''​adminUserName''​|Required,​ admin password for authentication| |''​adminUserName''​|Required,​ admin password for authentication|
Line 221: Line 239:
 |''​status''​|Required,​ monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| |''​status''​|Required,​ monitor status, must be ACTIVE or INACTIVE, default is ACTIVE|
 |''​externalID''​|Reserved field| |''​externalID''​|Reserved field|
-  + 
- Return value: MonitorID +Return value: MonitorID 
-  + 
- Function description:​ Creates a monitor.+Function description:​ Creates a monitor.
  
 === EditMonitor method === === EditMonitor method ===
- Parameters +Parameters 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
Line 242: Line 260:
 |''​status''​|Required,​ monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| |''​status''​|Required,​ monitor status, must be ACTIVE or INACTIVE, default is ACTIVE|
 |''​externalID''​|Reserved field| |''​externalID''​|Reserved field|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Edits a monitor.+Function description:​ Edits a monitor.
  
 === DeleteMonitor method === === DeleteMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​MonitorID''​|Required,​ monitor ID| |''​MonitorID''​|Required,​ monitor ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Deletes a monitor from the system.+Function description:​ Deletes a monitor from the system.
  
 === GetMonitor method === === GetMonitor method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​MonitorID''​|Required,​ monitor ID| |''​MonitorID''​|Required,​ monitor ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a monitor.+Function description:​ Gets a monitor.
  
 === GetMonitorsForAccount method === === GetMonitorsForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
-             ​ +            ​ 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets monitors from an account.+Function description:​ Gets monitors from an account.
  
 === GetMonitorsForOrganization method === === GetMonitorsForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​orgID''​|Required,​ Organization ID| |''​orgID''​|Required,​ Organization ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets monitors from an organization. +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''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets users from an account.+Function description:​ Gets users from an account.
  
 === GetUser method === === GetUser method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​userID''​|Required,​ user ID| |''​userID''​|Required,​ user ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a user.+Function description:​ Gets a user.
  
 === CreateUser method === === CreateUser method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
Line 343: Line 361:
 |''​allowMultipleSessions''​|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| |''​allowMultipleSessions''​|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously|
 |''​checkMessageInterval''​|Check message interval| |''​checkMessageInterval''​|Check message interval|
-  + 
- Return value: UserID +Return value: UserID 
-  + 
- Function description:​ Creates a user.+Function description:​ Creates a user.
  
 === EditUser method === === EditUser method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
Line 369: Line 387:
 |''​allowMultipleSessions''​|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| |''​allowMultipleSessions''​|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously|
 |''​checkMessageInterval''​|Check message interval| |''​checkMessageInterval''​|Check message interval|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Edits a user.+Function description:​ Edits a user.
  
 === DeleteUser method === === DeleteUser method ===
- Parameters +Parameters 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​userID''​|Required,​ user ID| |''​userID''​|Required,​ user ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Deletes a user from the system.+Function description:​ Deletes a user from the system.
  
 === ChangeUserPassword method === === ChangeUserPassword method ===
- Parameters +Parameters 
-  + 
- +
 |''​adminUserName''​|Required,​ admin user name for authentication| |''​adminUserName''​|Required,​ admin user name for authentication|
 |''​adminPassword''​|Required,​ admin password for authentication| |''​adminPassword''​|Required,​ admin password for authentication|
 |''​userName''​|Required,​ user name| |''​userName''​|Required,​ user name|
 |''​newPassword''​|Required,​ new password| |''​newPassword''​|Required,​ new password|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Change a user's password.+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 +Return value: bool 
-  + 
- Function description:​ Checks whether a specified username is in use.+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 +Return value: bool 
-  + 
- Function description:​ Checks whether a specified user email address is in use. +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''​|Required,​ user ID|
 |''​organizationID''​|Required,​ organization ID| |''​organizationID''​|Required,​ organization ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets the devices from an organization.+Function description:​ Gets the devices from an organization.
  
 === GetDevicesForAccount method === === GetDevicesForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​accountid''​|Required,​ account ID| |''​accountid''​|Required,​ account ID|
-   ​ +  ​ 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets the devices from an account.+Function description:​ Gets the devices from an account.
  
 === GetAllDevicesForOrganization method === === GetAllDevicesForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets all devices from an organization.+Function description:​ Gets all devices from an organization.
  
 === GetDeviceCategories method === === GetDeviceCategories method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets the device categories.+Function description:​ Gets the device categories.
  
 === GetDevice method === === GetDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​deviceID''​|Required,​ device ID| |''​deviceID''​|Required,​ device ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a device.+Function description:​ Gets a device.
  
 === CreateDevice method === === CreateDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 497: Line 515:
 |''​deviceCategoryID''​|Device category ID| |''​deviceCategoryID''​|Device category ID|
 |''​colorCode''​|Choose a color to associate with the device, default is a random color| |''​colorCode''​|Choose a color to associate with the device, default is a random color|
-  + 
- Return value: DeviceID +Return value: DeviceID 
-  + 
- Function description:​ Creates a device.+Function description:​ Creates a device.
  
 === EditDevice method === === EditDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 520: Line 538:
 |''​deviceCategoryID''​|Device category ID| |''​deviceCategoryID''​|Device category ID|
 |''​colorCode''​|Choose a color to associate with the device, default is a random color| |''​colorCode''​|Choose a color to associate with the device, default is a random color|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Edits a carrier.+Function description:​ Edits a carrier.
  
 === DeleteDevice method === === DeleteDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​deviceID''​|Required,​ device ID| |''​deviceID''​|Required,​ device ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Delete a device from the system. +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''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets the carriers from an account.+Function description:​ Gets the carriers from an account.
  
 === GetCarriersForOrganization method === === GetCarriersForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​orgID''​|Required,​ organization ID| |''​orgID''​|Required,​ organization ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets the carriers from an organization.+Function description:​ Gets the carriers from an organization.
  
 === GetCarriersDevice method === === GetCarriersDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​carrierID''​|Required,​ carrier ID| |''​carrierID''​|Required,​ carrier ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a carrier'​s device.+Function description:​ Gets a carrier'​s device.
  
 === GetCarriers method === === GetCarriers method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​carrierID''​|Required,​ carrier ID| |''​carrierID''​|Required,​ carrier ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a carrier.+Function description:​ Gets a carrier.
  
 === CreateCarrier method === === CreateCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 599: Line 617:
 |''​externalID''​|Reserved field| |''​externalID''​|Reserved field|
 |''​colorCode''​|Choose a color to associate with the device, default is a random color| |''​colorCode''​|Choose a color to associate with the device, default is a random color|
-  + 
- Return value: CarrierID +Return value: CarrierID 
-  + 
- Function description:​ Creates a carrier.+Function description:​ Creates a carrier.
  
 === EditCarrier method === === EditCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 619: Line 637:
 |''​externalID''​|Reserved field| |''​externalID''​|Reserved field|
 |''​colorCode''​|Choose a color to associate with the device, default is a random color| |''​colorCode''​|Choose a color to associate with the device, default is a random color|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Edits a carrier.+Function description:​ Edits a carrier.
  
 === DeleteCarrier method === === DeleteCarrier method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​carrierID''​|Required,​ carrier ID| |''​carrierID''​|Required,​ carrier ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Deletes a carrier from the system.+Function description:​ Deletes a carrier from the system.
  
 === CarrierAddDevice method === === CarrierAddDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​carrierID''​|Required,​ carrier ID| |''​carrierID''​|Required,​ carrier ID|
 |''​deviceID''​|Required,​ device ID| |''​deviceID''​|Required,​ device ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Assigns a device to a carrier.+Function description:​ Assigns a device to a carrier.
  
 === CarrierDeleteDevice method === === CarrierDeleteDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​carrierID''​|Required,​ carrier ID| |''​carrierID''​|Required,​ carrier ID|
 |''​deviceID''​|Required,​ device ID| |''​deviceID''​|Required,​ device ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Disassociates a device from a carrier. +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''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
 |''​serverity''​|Required,​ serverity level| |''​serverity''​|Required,​ serverity level|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Loads an event response for an account.+Function description:​ Loads an event response for an account.
  
 === LoadEventResponseForOrganization method === === LoadEventResponseForOrganization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​organizationID''​|Required,​ organization ID| |''​organizationID''​|Required,​ organization ID|
 |''​serverity''​|Required,​ serverity| |''​serverity''​|Required,​ serverity|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Loads an event response for an organization.+Function description:​ Loads an event response for an organization.
  
 === EditEventResponseForAccount method === === EditEventResponseForAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 709: Line 727:
 |''​sendEmail''​|Required| |''​sendEmail''​|Required|
 |''​severityColor''​|Required| |''​severityColor''​|Required|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Edits an event response for an account.+Function description:​ Edits an event response for an account.
  
 === EditEventResponseFor Organization method === === EditEventResponseFor Organization method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
Line 733: Line 751:
 |''​sendEmail''​|Required| |''​sendEmail''​|Required|
 |''​severityColor''​|Required| |''​severityColor''​|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''​|Required,​ user name for authentication|
 |''​adminPassword''​|Required,​ password for authentication| |''​adminPassword''​|Required,​ password for authentication|
Line 757: Line 775:
 |''​responseCode''​|Required| |''​responseCode''​|Required|
 |''​assistanceUsed''​|Required| |''​assistanceUsed''​|Required|
-  + 
- Return value: LocationID +Return value: LocationID 
-  + 
- Function description:​ Create a location for device.+Function description:​ Create a location for device.
  
 === GetCurrentLocationByDevice method === === GetCurrentLocationByDevice method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​deviceID''​|Required| |''​deviceID''​|Required|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Get current location for the device.+Function description:​ Get current location for the device.
  
 === GetLocationBySession method === === GetLocationBySession method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​userName''​|Required,​ user name for authentication| |''​userName''​|Required,​ user name for authentication|
 |''​password''​|Required,​ password for authentication| |''​password''​|Required,​ password for authentication|
 |''​lsessionD''​|Required| |''​lsessionD''​|Required|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Get locations for the session.+Function description:​ Get locations for the session.
  
  
Line 791: Line 809:
 ==== WSAccountManager Web Service ==== ==== WSAccountManager Web Service ====
 === CreateAccount method === === CreateAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
Line 807: Line 825:
 |''​processLocationInfo''​|Can process LocationInformation of map or not in account level| |''​processLocationInfo''​|Can process LocationInformation of map or not in account level|
 |''​termsOfUse''​|Can use terms of use or not| |''​termsOfUse''​|Can use terms of use or not|
-|''​orgLimit''​|Organization limit, default is  +|''​orgLimit''​|Organization limit, default is -1 (unlimited)| 
-1 (unlimited)| +|''​monitorLimit''​|Monitor limit, default is -1 (unlimited)| 
-|''​monitorLimit''​|Monitor limit, default is  +|''​carrierLimit''​|Carrier limit, default is -1 (unlimited)| 
-1 (unlimited)| +|''​deviceLimit''​|Device limit, default is -1 (unlimited)| 
-|''​carrierLimit''​|Carrier limit, default is  +|''​targetLimit''​|Target limit, default is -1 (unlimited)| 
-1 (unlimited)| +|''​areaLimit''​|Area 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 |''​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.| 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 
-  + 
- Function description:​ Creates an account at the installer level.+Function description:​ Creates an account at the installer level.
  
 === GetAccount method === === GetAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Checks to see whether the account exists in the system. +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''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
-           ​ +          ​ 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets all of the accounts under this installation.+Function description:​ Gets all of the accounts under this installation.
  
 === EditAccount method === === EditAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
Line 866: Line 878:
 |''​processLocationInfo''​|Can process LocationInformation of the map at the account level or not| |''​processLocationInfo''​|Can process LocationInformation of the map at the account level or not|
 |''​termsOfUse''​|Can apply Terms of Use or not| |''​termsOfUse''​|Can apply Terms of Use or not|
-|''​orgLimit''​|Organization limit, default is  +|''​orgLimit''​|Organization limit, default is -1 (unlimited)| 
-1 (unlimited)| +|''​monitorLimit''​|Monitor limit, default is -1 (unlimited)| 
-|''​monitorLimit''​|Monitor limit, default is  +|''​carrierLimit''​|Carrier limit, default is -1 (unlimited)| 
-1 (unlimited)| +|''​deviceLimit''​|Device limit, default is -1 (unlimited)| 
-|''​carrierLimit''​|Carrier limit, default is  +|''​targetLimit''​|Target limit, default is -1 (unlimited)| 
-1 (unlimited)| +|''​areaLimit''​|Area 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 |''​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.| 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 
-  + 
- Function description:​ Edits an account at the installer level.+Function description:​ Edits an account at the installer level.
  
 === DeleteAccount method === === DeleteAccount method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
 |''​accountID''​|Required,​ Account ID| |''​accountID''​|Required,​ Account ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Deletes an account in the system at the installer level.+Function description:​ Deletes an account in the system at the installer level.
  
  
Line 901: Line 907:
 ==== WSLanguageManager Web Service ==== ==== WSLanguageManager Web Service ====
 === GetLanguageList method === === GetLanguageList method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a list of languages available in the installation.+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''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
 |''​languageID''​|Required,​ language ID| |''​languageID''​|Required,​ language ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a language.+Function description:​ Gets a language.
  
 === GetSystemLanguageList method === === GetSystemLanguageList method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Gets a list of the available system languages.+Function description:​ Gets a list of the available system languages.
  
 === LanguageDelete method === === LanguageDelete method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
 |''​languageID''​|Required,​ language ID| |''​languageID''​|Required,​ language ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Deletes a language.+Function description:​ Deletes a language.
  
 === CreateLanguage method === === CreateLanguage method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
Line 955: Line 961:
 |''​isSystem''​|Required| |''​isSystem''​|Required|
 |''​Status''​|Required,​ status| |''​Status''​|Required,​ status|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Creates a new language.+Function description:​ Creates a new language.
  
 === EditLanguage method === === EditLanguage method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
Line 970: Line 976:
 |''​isSystem''​|Required| |''​isSystem''​|Required|
 |''​Status''​|Required,​ status| |''​Status''​|Required,​ status|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Edits a language.+Function description:​ Edits a language.
  
 === SetLanguageForUser method === === SetLanguageForUser method ===
- Parameters:​ +Parameters:​ 
-  + 
- +
 |''​installUserName''​|Required,​ installer user name for authentication| |''​installUserName''​|Required,​ installer user name for authentication|
 |''​installPassword''​|Required,​ installer password for authentication| |''​installPassword''​|Required,​ installer password for authentication|
 |''​languageID''​|Required,​ language ID| |''​languageID''​|Required,​ language ID|
 |''​accountID''​|Required,​ account ID| |''​accountID''​|Required,​ account ID|
-  + 
- Return value: String +Return value: String 
-  + 
- Function description:​ Sets the language for a user.+Function description:​ Sets the language for a user.
map_suite_gps_tracking_server_web_services_reference_guide.1442383126.txt.gz · Last modified: 2015/09/16 05:58 by admin

Page Tools