User Tools

Site Tools


map_suite_gps_tracking_server_web_services_reference_guide

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:

securityKeyRequired, user ID
accountIDRequired, Account ID

Return value: String

Function description: Gets an organization from an account.

GetAllOrganizationForAccount method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, Account ID

Return value: String

Function description: Gets all organizations from an account.

GetOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, Organization ID

Return value: String

Function description: Gets an organization.

CreateOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
orgNameRequired, organization name
DescriptionOrganization description
mapDataIDRequired, map Data ID
timeZoneRequired, time zone of the organization's location
metricRequired, selects whether the organization's unit system is metric or imperial
statusRequired, organization status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field

Return value: OrganizationID

Function description: Creates an organization.

EditOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
orgIDRequired, organization ID
orgNameRequired, organization name
descriptionOrganization description
managerManager of the organization
imageNameThe path of the organization image
mapDataIDRequired, map data ID
timeZoneRequired, time zone of the organization's location
metricRequired, selects whether the organization's unit system is metric or imperial
statusRequired, organization status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field

Return value: String

Function description: Edits an organization.

DeleteOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID

Function description: Deletes an organization in the system.

OrganizationAddDevice method

Parameters:

userNameRequired, user name for authentication
userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID
deviceIDRequired, device ID

Return value: String

Function description: Adds a device to an organization.

OrganizationAddCarrier method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID
carrierIDRequired, carrier ID

Return value: String

Function description: Adds a carrier to an organization.

OrganizationAddMonitor method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID
monitorIDRequired, monitor ID

Return value: String

Function description: Adds a monitor to an organization.

GetCarriersForOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID

Return value: String

Function description: Gets the carriers in an organization.

GetDevicesForOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID

Return value: String

Function description: Gets the devices in an organization.

GetMonitorsForOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID

Return value: String

Function description: Gets the monitors in an organization.

DeleteOrganizationCarrier method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID
carrierIDRequired, carrier ID

Return value: String

Function description: Deletes a carrier from an organization.

DeleteOrganizationDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, Organization ID
deviceIDRequired, device ID

Return value: String

Function description: Deletes a device from an organization.

DeleteOrganizationMonitor method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID
monitorIDRequired, monitor ID

Return value: String

Function description: Deletes a monitor from an organization.

GetAllMapDataForAccount method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID

Return value: String

Function description: Gets all available map data for an account.

WSMonitorManager Web Service

CreateMonitor method

Parameters:

adminUserNameRequired, admin user name for authentication
adminUserNameRequired, admin password for authentication
accountIDRequired, account ID
nameRequired, Monitor name
descriptionMonitor description
userNameRequired, user name
passwordRequired, password
entryReference

Dashboard or Map Area|

statusRequired, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field

Return value: MonitorID

Function description: Creates a monitor.

EditMonitor method

Parameters

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
accountIDRequired, account ID
monitorIDMonitor ID
nameRequired, monitor name
descriptionMonitor description
userNameRequired, user name
passwordRequired, password
entryReference

Dashboard or Map Area|

statusRequired, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field

Return value: String

Function description: Edits a monitor.

DeleteMonitor method

Parameters:

adminUserNameRequired, admin user name for authentication
adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
MonitorIDRequired, monitor ID

Return value: String

Function description: Deletes a monitor from the system.

GetMonitor method

Parameters:

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
MonitorIDRequired, monitor ID

Return value: String

Function description: Gets a monitor.

GetMonitorsForAccount method

Parameters:

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
accountIDRequired, account ID

Function description: Gets monitors from an account.

GetMonitorsForOrganization method

Parameters:

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
orgIDRequired, Organization ID

Return value: String

Function description: Gets monitors from an organization.

WSUserManager Web Service

GetUsersForAccount method

Parameters:

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
accountIDRequired, account ID

Return value: String

Function description: Gets users from an account.

GetUser method

Parameters:

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
userIDRequired, user ID

Return value: String

Function description: Gets a user.

CreateUser method

Parameters:

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
accountIDRequired, account ID
userNameRequired, user name
passwordRequired, password
statusRequired, user status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field
entryReference

Dashboard or Map Area|

firstNameFirst name
lastNameLast name
emailAddressEmail address
activateDateActivation date
deactiveDateDeactivation date
allowMultipleSessionsWhether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously
checkMessageIntervalCheck message interval

Return value: UserID

Function description: Creates a user.

EditUser method

Parameters:

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
accountIDRequired, account ID
userIDRequired, user ID
userNameRequired, user name
passwordRequired, password
statusRequired, user status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field
entryReference

Dashboard or Map Area|

firstNameFirst name
lastNameLast name
emailAddressEmail address
activateDateActivation date
deactiveDateDeactivation date
allowMultipleSessionsWhether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously
checkMessageIntervalCheck message interval

Return value: String

Function description: Edits a user.

DeleteUser method

Parameters

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
userIDRequired, user ID

Return value: String

Function description: Deletes a user from the system.

ChangeUserPassword method

Parameters

adminUserNameRequired, admin user name for authentication
adminPasswordRequired, admin password for authentication
userNameRequired, user name
newPasswordRequired, new password

Return value: String

Function description: Change a user's password.

IsUserNameInUse method

Parameters:

usernameRequired, the user name to check for

Function description: Checks whether a specified username is in use.

IsEmailInUse method

Parameters:

emailAddressRequired, 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:

securityKeyRequired, user ID
organizationIDRequired, organization ID

Return value: String

Function description: Gets the devices from an organization.

GetDevicesForAccount method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountidRequired, account ID

Function description: Gets the devices from an account.

GetAllDevicesForOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID

Return value: String

Function description: Gets all devices from an organization.

GetDeviceCategories method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID

Return value: String

Function description: Gets the device categories.

GetDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
deviceIDRequired, device ID

Return value: String

Function description: Gets a device.

CreateDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
deviceNameRequired, device name
descriptionDevice description
topSpeedRequired, top speed
statusRequired, device status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field
imeiRequired, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem
cannedMessage

way communication|

deviceCategoryIDDevice category ID
colorCodeChoose a color to associate with the device, default is a random color

Return value: DeviceID

Function description: Creates a device.

EditDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
DeviceIDRequired, device ID
deviceNameRequired, device name
descriptionDevice description
topSpeedRequired, top speed
statusRequired, device status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field
imeiRequired, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem
cannedMessage

way communication|

deviceCategoryIDDevice category ID
colorCodeChoose a color to associate with the device, default is a random color

Return value: String

Function description: Edits a carrier.

DeleteDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
deviceIDRequired, device ID

Return value: String

Function description: Delete a device from the system.

WSCarrierManager Web Service

GetCarriersForAccount method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID

Return value: String

Function description: Gets the carriers from an account.

GetCarriersForOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
orgIDRequired, organization ID

Return value: String

Function description: Gets the carriers from an organization.

GetCarriersDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
carrierIDRequired, carrier ID

Return value: String

Function description: Gets a carrier's device.

GetCarriers method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
carrierIDRequired, carrier ID

Return value: String

Function description: Gets a carrier.

CreateCarrier method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
carrierNameRequired, carrier name
carrierPinCarrier's personal identification number, the default value is 0000
statusRequired, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field
colorCodeChoose a color to associate with the device, default is a random color

Return value: CarrierID

Function description: Creates a carrier.

EditCarrier method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
carrierIDRequired, carrier ID
carrierNameRequired, carrier name
descriptionRequired, description of the carrier
otherInformationOther information about the carrier, HTML supported. Will be displayed in a popup bubble on the tracking screen.
carrierPinCarrier's personal identification number, the default value is 0000
statusRequired, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE
externalIDReserved field
colorCodeChoose a color to associate with the device, default is a random color

Return value: String

Function description: Edits a carrier.

DeleteCarrier method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
carrierIDRequired, carrier ID

Return value: String

Function description: Deletes a carrier from the system.

CarrierAddDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
carrierIDRequired, carrier ID
deviceIDRequired, device ID

Return value: String

Function description: Assigns a device to a carrier.

CarrierDeleteDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
carrierIDRequired, carrier ID
deviceIDRequired, device ID

Return value: String

Function description: Disassociates a device from a carrier.

WSAlertManager Web Service

LoadEventResponseForAccount method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
serverityRequired, serverity level

Return value: String

Function description: Loads an event response for an account.

LoadEventResponseForOrganization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
organizationIDRequired, organization ID
serverityRequired, serverity

Return value: String

Function description: Loads an event response for an organization.

EditEventResponseForAccount method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
accountIDRequired, account ID
serverityRequired, serverity
additionalEmailAddressesRequired
alertPopupActionRequired, popup action
alertThresholdRequired, alert threshold
friendlyNameRequired, friendly name
iconPathRequired
noisePathRequired
overriddenRequired
overridesRequired
repeatRequired
sendEmailRequired
severityColorRequired

Return value: String

Function description: Edits an event response for an account.

EditEventResponseFor Organization method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
organizationIDRequired, organization ID
serverityRequired, serverity
additionalEmailAddressesRequired
alertPopupActionRequired, popup action
alertThresholdRequired, alert threshold
friendlyNameRequired, friendly name
iconPathRequired
noisePathRequired
overriddenRequired
overridesRequired
repeatRequired
sendEmailRequired
severityColorRequired

Return value: String

Function description: Edits an event response for an organization.

WSLocationManager Web Service

CreateLocation method

Parameters:

adminUserNameRequired, user name for authentication
adminPasswordRequired, password for authentication
IMEIRequired, Device IMEI
locationIDRequired, New Guid
logTimeRequired, GPS date time of message
yPointRequired, Latitude
xPointRequired, Longitude
altitudeRequired, altitude
speedRequired, device speed
travelDirectionRequired, Travel Direction
speedUncertaintyRequired, Speed Uncertainty or not
responseCodeRequired
assistanceUsedRequired

Return value: LocationID

Function description: Create a location for device.

GetCurrentLocationByDevice method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
deviceIDRequired

Return value: String

Function description: Get current location for the device.

GetLocationBySession method

Parameters:

userNameRequired, user name for authentication
passwordRequired, password for authentication
lsessionDRequired

Return value: String

Function description: Get locations for the session.

Installation Web Service APIs

WSAccountManager Web Service

CreateAccount method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
adminUserNameRequired, admin user name for the account
adminPasswordRequired, admin password
accountNameRequired, account name
externalIDReserved field
statusRequired, account status, must be ACTIVE or INACTIVE, default is ACTIVE
activateDateAccount activation date
deactivateDateAccount deactivation date
manageSecurityCan manage security or not
manageBrandCan manage brand or not
processLocationInfoCan process LocationInformation of map or not in account level
termsOfUseCan use terms of use or not
orgLimitOrganization limit, default is -1 (unlimited)
monitorLimitMonitor limit, default is -1 (unlimited)
carrierLimitCarrier limit, default is -1 (unlimited)
deviceLimitDevice limit, default is -1 (unlimited)
targetLimitTarget limit, default is -1 (unlimited)
areaLimitArea limit, default is -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:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
accountIDRequired, account ID

Return value: String

Function description: Checks to see whether the account exists in the system.

GetAllAccounts method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication

Function description: Gets all of the accounts under this installation.

EditAccount method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
accountIDRequired, account ID
accountNameRequired, account name
externalIDReserved field
statusRequired, account status, must be ACTIVE or INACTIVE, default is ACTIVE
activateDateAccount activation date
deactivateDateAccount deactivation date
manageSecurityCan manage security or not
manageBrandCan manage branding or not
processLocationInfoCan process LocationInformation of the map at the account level or not
termsOfUseCan apply Terms of Use or not
orgLimitOrganization limit, default is -1 (unlimited)
monitorLimitMonitor limit, default is -1 (unlimited)
carrierLimitCarrier limit, default is -1 (unlimited)
deviceLimitDevice limit, default is -1 (unlimited)
targetLimitTarget limit, default is -1 (unlimited)
areaLimitArea limit, default is -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:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
accountIDRequired, Account ID

Return value: String

Function description: Deletes an account in the system at the installer level.

WSLanguageManager Web Service

GetLanguageList method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication

Return value: String

Function description: Gets a list of languages available in the installation.

GetLanguage method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
languageIDRequired, language ID

Return value: String

Function description: Gets a language.

GetSystemLanguageList method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication

Return value: String

Function description: Gets a list of the available system languages.

LanguageDelete method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
languageIDRequired, language ID

Return value: String

Function description: Deletes a language.

CreateLanguage method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
languageNameRequired, language name
isSystemRequired
StatusRequired, status

Return value: String

Function description: Creates a new language.

EditLanguage method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
languageIDRequired, language ID
languageNameRequired, language name
isSystemRequired
StatusRequired, status

Return value: String

Function description: Edits a language.

SetLanguageForUser method

Parameters:

installUserNameRequired, installer user name for authentication
installPasswordRequired, installer password for authentication
languageIDRequired, language ID
accountIDRequired, account ID

Return value: String

Function description: Sets the language for a user.

map_suite_gps_tracking_server_web_services_reference_guide.txt · Last modified: 2015/09/16 06:03 by admin