ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
map_suite_gps_tracking_server_web_services_reference_guide
This is an old revision of the document!
Table of Contents
Map Suite GPS Tracking Server Web Services Reference Guide
This is a complete list of the methods exposed in the Map Suite GPS Tracking Server web portal web services. These services allow you to manipulate your Map Suite GPS Tracking Server web portal accounts, users, departments, devices and more.
The web service APIs are divided into two groups: Account APIs and Installation APIs. The scope of the Account APIs is a single account within your Map Suite GPS Tracking Server system; these allow you to manipulate that account's devices, users, departments and so on. The Installation APIs, by contrast, have a scope encompassing the entire GPS Tracking Server system. These give you access to creation and deletion of accounts and frontend language packs on the server.
Account Web Service APIs
WSOrganizationManager Web Service
GetOrganizationsForAccount method
Parameters:
securityKey | Required, user ID |
accountID | Required, Account ID |
GetAllOrganizationForAccount method
Parameters:
userName | Required, user name for authentication |
password | Required, password for authentication |
accountID | Required, Account ID |
GetOrganization method
Parameters:
userName | Required, user name for authentication |
password | Required, password for authentication |
orgID | Required, Organization ID |
CreateOrganization method
Parameters:
userName | Required, user name for authentication |
password | Required, password for authentication |
accountID | Required, account ID |
orgName | Required, organization name |
Description | 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 |
EditOrganization method
Parameters:
userName | Required, user name for authentication |
password | Required, password for authentication |
accountID | Required, account ID |
orgID | Required, organization ID |
orgName | Required, organization name |
description | 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 |
DeleteOrganization method
Parameters:
userName | Required, user name for authentication |
password | Required, password for authentication |
orgID | Required, organization ID |
OrganizationAddDevice method
Parameters:
userName | Required, user name for authentication |
userName | Required, user name for authentication |
password | Required, password for authentication |
orgID | Required, organization ID |
deviceID | Required, device ID |
OrganizationAddCarrier method
Parameters:
userName | Required, user name for authentication |
password | Required, password for authentication |
orgID | Required, organization ID |
carrierID | Required, carrier ID |
OrganizationAddMonitor method
Parameters:
userName | Required, user name for authentication |
password | Required, password for authentication |
orgID | Required, organization ID |
monitorID | Required, monitor ID |
GetCarriersForOrganization method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, organization ID |
Function description: Gets the carriers in an organization.
GetDevicesForOrganization method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, organization ID |
GetMonitorsForOrganization method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, organization ID |
DeleteOrganizationCarrier method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, organization ID |
carrierID | Required, carrier ID |
DeleteOrganizationDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, Organization ID |
deviceID | Required, device ID |
DeleteOrganizationMonitor method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, organization ID |
monitorID | Required, monitor ID |
GetAllMapDataForAccount method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
CreateMonitor method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminUserName | Required, admin password for authentication |
accountID | Required, account ID |
name | Required, Monitor name |
description | Monitor description |
userName | Required, user name |
password | Required, password |
entryReference |
Dashboard or Map Area|
status | Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE |
externalID | Reserved field |
EditMonitor method
Parameters
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
accountID | Required, account ID |
monitorID | Monitor ID |
name | Required, monitor name |
description | Monitor description |
userName | Required, user name |
password | Required, password |
entryReference |
Dashboard or Map Area|
status | Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE |
externalID | Reserved field |
DeleteMonitor method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminUserName | Required, admin user name for authentication |
adminPassword | Required, admin password for authentication |
MonitorID | Required, monitor ID |
GetMonitor method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
MonitorID | Required, monitor ID |
GetMonitorsForAccount method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
accountID | Required, account ID |
GetMonitorsForOrganization method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
orgID | Required, Organization ID |
GetUsersForAccount method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
accountID | Required, account ID |
GetUser method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
userID | Required, user ID |
CreateUser method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
accountID | Required, account ID |
userName | Required, user name |
password | Required, password |
status | Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE |
externalID | Reserved field |
entryReference |
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 |
EditUser method
Parameters:
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
accountID | Required, account ID |
userID | Required, user ID |
userName | Required, user name |
password | Required, password |
status | Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE |
externalID | Reserved field |
entryReference |
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 |
DeleteUser method
Parameters
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
userID | Required, user ID |
ChangeUserPassword method
Parameters
|adminUserName|Required, admin user name for authentication|
adminPassword | Required, admin password for authentication |
userName | Required, user name |
newPassword | Required, new password |
IsUserNameInUse method
Parameters:
|username|Required, the user name to check for|
Return value: bool Function description: Checks whether a specified username is in use.
IsEmailInUse method
Parameters:
|emailAddress|Required, the email address to check for|
Return value: bool Function description: Checks whether a specified user email address is in use.
WSDeviceManager Web Service
GetDevicesForOrganization method
Parameters:
|securityKey|Required, user ID|
organizationID | Required, organization ID |
GetDevicesForAccount method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountid | Required, account ID |
GetAllDevicesForOrganization method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, organization ID |
GetDeviceCategories method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
GetDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
deviceID | Required, device ID |
CreateDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
deviceName | Required, device name |
description | Device description |
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 |
way communication|
deviceCategoryID | Device category ID |
colorCode | Choose a color to associate with the device, default is a random color |
EditDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
DeviceID | Required, device ID |
deviceName | Required, device name |
description | Device description |
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 |
way communication|
deviceCategoryID | Device category ID |
colorCode | Choose a color to associate with the device, default is a random color |
DeleteDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
deviceID | Required, device ID |
GetCarriersForAccount method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
GetCarriersForOrganization method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
orgID | Required, organization ID |
GetCarriersDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
carrierID | Required, carrier ID |
GetCarriers method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
carrierID | Required, carrier ID |
CreateCarrier method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
carrierName | Required, carrier name |
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 |
EditCarrier method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
carrierID | Required, carrier ID |
carrierName | Required, carrier name |
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 |
DeleteCarrier method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
carrierID | Required, carrier ID |
CarrierAddDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
carrierID | Required, carrier ID |
deviceID | Required, device ID |
CarrierDeleteDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
carrierID | Required, carrier ID |
deviceID | Required, device ID |
LoadEventResponseForAccount method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
serverity | Required, serverity level |
LoadEventResponseForOrganization method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
organizationID | Required, organization ID |
serverity | Required, serverity |
EditEventResponseForAccount method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
accountID | Required, account ID |
serverity | Required, serverity |
additionalEmailAddresses | Required |
alertPopupAction | Required, popup action |
alertThreshold | Required, alert threshold |
friendlyName | Required, friendly name |
iconPath | Required |
noisePath | Required |
overridden | Required |
overrides | Required |
repeat | Required |
sendEmail | Required |
severityColor | Required |
EditEventResponseFor Organization method
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 |
overridden | Required |
overrides | Required |
repeat | Required |
sendEmail | Required |
severityColor | Required |
WSLocationManager Web Service
CreateLocation method
Parameters:
|adminUserName|Required, user name for authentication|
adminPassword | Required, password for authentication |
IMEI | Required, Device IMEI |
locationID | Required, New Guid |
logTime | Required, GPS date time of message |
yPoint | 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 |
GetCurrentLocationByDevice method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
deviceID | Required |
GetLocationBySession method
Parameters:
|userName|Required, user name for authentication|
password | Required, password for authentication |
lsessionD | Required |
Installation Web Service APIs
WSAccountManager Web Service
CreateAccount method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
adminUserName | Required, admin user name for the account |
adminPassword | Required, admin password |
accountName | Required, account name |
externalID | Reserved field |
status | Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE |
activateDate | Account activation date |
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 |
1 (unlimited)|
monitorLimit |
1 (unlimited)|
carrierLimit |
1 (unlimited)|
deviceLimit |
1 (unlimited)|
targetLimit |
1 (unlimited)|
areaLimit |
1 (unlimited)|
securityPath |
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
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication | |||
accountID | Required, account ID | Return value: String Function description: Checks to see whether the account exists in the system. === GetAllAccounts method === Parameters: | installUserName | Required, installer user name for authentication |
installPassword | Required, installer password for authentication |
EditAccount method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
accountID | Required, account ID |
accountName | Required, account name |
externalID | Reserved field |
status | Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE |
activateDate | Account activation date |
deactivateDate | Account deactivation date |
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 |
1 (unlimited)|
monitorLimit |
1 (unlimited)|
carrierLimit |
1 (unlimited)|
deviceLimit |
1 (unlimited)|
targetLimit |
1 (unlimited)|
areaLimit |
1 (unlimited)|
securityPath |
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
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
accountID | Required, Account ID |
WSLanguageManager Web Service
GetLanguageList method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
GetLanguage method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
languageID | Required, language ID |
GetSystemLanguageList method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
LanguageDelete method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
languageID | Required, language ID |
CreateLanguage method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
languageName | Required, language name |
isSystem | Required |
Status | Required, status |
EditLanguage method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
languageID | Required, language ID |
languageName | Required, language name |
isSystem | Required |
Status | Required, status |
SetLanguageForUser method
Parameters:
|installUserName|Required, installer user name for authentication|
installPassword | Required, installer password for authentication |
languageID | Required, language ID |
accountID | Required, account ID |
map_suite_gps_tracking_server_web_services_reference_guide.1442383136.txt.gz · Last modified: 2015/09/16 05:58 by admin