ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
cygnus_track_portal_web_services_reference_guide
Table of Contents
Cygnus Track Portal Web Services Reference Guide
This is a complete list of the methods exposed in the Cygnus Track 6.0 web portal web services. These services allow you to manipulate your Cygnus Track web portal accounts, users, departments, devices and more.
The web service APIs are divided into two groups: Account APIs and Installation APIs. Account APIs are available to all Cygnus Track editions, while Installation APIs are available only to users of Cygnus Track Hosted, Enterprise and Integrator Editions.
The following services are available and documented; click on the name of a service below to jump directly to its part of the reference guide.
NOTE: This page and its contained pages are a work in progress. The complete Cygnus Track Developer Center content is currently available on the ThinkGeo website in the Cygnus Track Developer Center.
Account Web Service APIs
Available in all Cygnus Track editions
WSOrganizationManager Web Service
GetOrganizationsForAccount method
Parameters:
securityKey | Required,user ID | |
accountID | Required, Account ID | |
Return value: String
Function description: Gets an organization from an account.
GetAllOrganizationForAccount method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
accountID | Required, Account ID | |
Return value: String
Function description: Gets all organizations from an account.
GetOrganization method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, Organization ID | |
Return value: String
Function description: Gets an organization.
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 | Required, Reserved field | |
Return value: OrganizationID
Function description: Creates an organization.
EditOrganization method
Parameters:
userName |
|
password |
|
accountID |
|
orgID |
|
orgName |
|
description |
|
manager |
|
imageName |
|
mapDataID |
|
timeZone |
|
metric |
|
status |
|
externalID |
|
Return value: String
Function description: Edits an organization.
DeleteOrganization method
Parameters:
userName |
|
password |
|
orgID |
|
Return value: String
Function description: Deletes an organization in the system.
OrganizationAddDevice method.
Parameters:
userName |
|
password |
|
orgID |
|
deviceID |
|
Return value: String
Function description: Adds a device to an organization.
OrganizationAddCarrier method
Parameters:
userName |
|
password |
|
orgID |
|
carrierID |
|
Return value: String
Function description: Adds a carrier to an organization.
OrganizationAddMonitor method
Parameters:
userName |
|
password |
|
orgID |
|
monitorID |
|
Return value: String
Function description: Adds a monitor to an organization.
GetCarriersForOrganization method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, Organization ID | |
Return value: String
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 | |
Return value: String
Function description: Gets the devices in an organization.
GetMonitorsForOrganization method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, Organization ID | |
Return value: String
Function description: Gets the monitors in an organization.
DeleteOrganizationCarrier method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, Organization ID | |
carrierID | Required, carrier ID | |
Return value: String
Function description: Deletes a carrier from an organization.
DeleteOrganizationDevice method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, Organization ID | |
deviceID | Required, device ID | |
Return value: String
Function description: Deletes a device from an organization.
DeleteOrganizationMonitor method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, Organization ID | |
monitorID | Required, monitor ID | |
Return value: String
Function description: Deletes a monitor from an organization.
GetAllMapDataForAccount method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
accountID | Required, Account ID | |
Return value: String
Function description: Gets all available map data for an account.
WSMonitorManager Web Service
CreateMonitor method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
accountID | Required, Account ID | |
name | Required, Monitor name | |
description | Monitor description | |
userName | Required, user name | |
password | Required, password | |
accountID | Required, Account ID | |
entryReference | Required, selects which page is the default entry page - Dashboard or Map Area | |
status | Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE | |
externalID | Reserved field | |
Return value: MonitorID
Function description: Creates a monitor.
EditMonitor method
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 | |
accountID | Required, Account ID | |
entryReference | Required, selects which page is the default entry page - Dashboard or Map Area | |
status | Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE | |
externalID | Reserved field | |
Return value: String
Function description: Edits a monitor.
DeleteMonitor method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
MonitorID | Required, Monitor ID | |
Return value: String
Function description: Deletes a monitor from the system.
GetMonitor method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
MonitorID | Required, Monitor ID | |
Return value: String
Function description: Gets a monitor.
GetMonitorsForAccount method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
accountID | Required, account ID | |
Return value: String
Function description: Gets monitors from an account.
GetMonitorsForOrganization method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
orgID | Required, Organization ID | |
Return value: String
Function description: Gets monitors from an organization.
WSUserManager Web Service
GetUsersForAccount method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
accountID | Required, account ID | |
Return value: String
Function description: Gets users from an account.
GetUser method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
userID | Required, user ID | |
Return value: String
Function description: Gets a user.
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 | Required, selects which page is the default entry page - Dashboard or Map Area | |
firstName | First name | |
lastName | Last name | |
emailAddress | Email address | |
activateDate | Activation date | |
deactiveDate | Deactivation date | |
allowMultipleSessions | Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously | |
checkMessageInterval | Check message interval | |
Return value: UserID
Function description: Creates a user.
EditUser method
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 | Required, selects which page is the default entry page - Dashboard or Map Area | |
firstName | First name | |
lastName | Last name | |
emailAddress | Email address | |
activateDate | Activation date | |
deactiveDate | Deactivation date | |
allowMultipleSessions | Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously | |
checkMessageInterval | Check message interval | |
Return value: String
Function description: Edits a user.
DeleteUser method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
userID | Required, user ID | |
Return value: String
Function description: Deletes a user from the system.
ChangeUserPassword method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin password for authentication | |
userName | Required, user name | |
newPassword | Required, new password | |
Return value: String
Function description: Change a user's 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 | |
Return value: String
Function description: Gets the devices from an organization.
GetDevicesForAccount method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
accountid | Required, account ID | |
Return value: String
Function description: Gets the devices from an account.
GetAllDevicesForOrganization method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, organization ID | |
Return value: String
Function description: Gets all devices from an organization.
GetDeviceCategories method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
accountid | Required, account ID | |
Return value: String
Function description: Gets the device categories.
GetDevice method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
deviceID | Required, device ID | |
Return value: String
Function description: Gets a device.
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 | Required, specifies whether or not the device supports two-way communication | |
deviceCategoryID | Device category ID | |
colorCode | Choose a color to associate with the device, default is a random color | |
Return value: DeviceID
Function description: Creates a device.
EditDevice method
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 | Required, specifies whether or not the device supports two-way communication | |
deviceCategoryID | Device category ID | |
colorCode | Choose a color to associate with the device, default is a random color | |
Return value: String
Function description: Edits a carrier.
DeleteDevice method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
deviceID | Required, device ID | |
Return value: String
Function description: Delete a device from the system.
WSCarrierManager Web Service
GetCarriersForAccount method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
accountID | Required, account ID | |
Return value: String
Function description: Gets the carriers from an account.
GetCarriersForOrganization method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
orgID | Required, organization ID | |
Return value: String
Function description: Gets the carriers from an organization.
GetCarriersDevice method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
carrierID | Required, carrier ID | |
Return value: String
Function description: Gets a carrier's device.
GetCarriers method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
carrierID | Required, carrier ID | |
Return value: String
Function description: Gets a carrier.
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 | |
Return value: CarrierID
Function description: Creates a carrier.
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 | |
Return value: String
Function description: Edits a carrier.
DeleteCarrier method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
carrierID | Required, carrier ID | |
Return value: String
Function description: Deletes a carrier from the system.
CarrierAddDevice method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
carrierID | Required, carrier ID | |
deviceID | Required, device ID | |
Return value: String
Function description: Assigns a device to a carrier.
CarrierDeleteDevice method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
carrierID | Required, carrier ID | |
deviceID | Required, device ID | |
Return value: String
Function description: Disassociates a device from a carrier.
WSAlertManager Web Service
LoadEventResponseForAccount method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
accountID | Required, account ID | |
severity | Required, severity level | |
Return value: String
Function description: Loads an event response for an account.
LoadEventResponseForOrganization method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
organizationID | Required, organization ID | |
severity | Required, severity level | |
Return value: String
Function description: Loads an event response for an organization.
EditEventResponseForAccount method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
accountID | Required, account ID | |
severity | Required, severity level | |
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 | |
Return value: String
Function description: Edits an event response for an account.
EditEventResponseForOrganization method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
organizationID | Required, organization ID | |
severity | Required, severity level | |
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 | |
Return value: String
Function description: Edits an event response for an organization.
WSLocationManager Web Service
CreateLocation method
Parameters:
adminUserName | Required, admin user name for authentication | |
adminPassword | Required, admin 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 | |
Return value: LocationID
Function description: Create a location for device.
GetCurrentLocationByDevice method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
locationID | Required | |
Return value: String
Function description: Get current location for the device.
GetLocationBySession method
Parameters:
userName | Required, user name for authentication | |
password | Required, password for authentication | |
lsessionD | Required | |
Return value: String
Function description: Get locations for the session.
Installation Web Service APIs
<small>Available in Cygnus Track Hosted, Enterprise, and Integrator editions only</small>
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 Location Information of map or not in account level | |
termsOfUse | Can use terms of use or not | |
orgLimit | Organization limit, default is -1 (unlimited) | |
monitorLimit | Monitor limit, default is -1 (unlimited) | |
carrierLimit | Carrier limit, default is -1 (unlimited) | |
deviceLimit | Device limit, default is -1 (unlimited) | |
targetLimit | Target limit, default is -1 (unlimited) | |
areaLimit | Area limit, default is -1 (unlimited) | |
securityPath | If Two-Factor Authentication is enabled in Account General Settings, the security binary path will be used to judge whether or not this account is TwoFactorSecurity Valid when a user logs in. | |
Return value: AccountID
Function description: Creates an account at the installer level.
GetAccount method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | 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 | |
installerPassword | Required, installer password for authentication | |
Return value: String
Function description: Gets all of the accounts under this installation.
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 brand or not | |
processLocationInfo | Can process Location Information of map or not in account level | |
termsOfUse | Can use terms of use or not | |
orgLimit | Organization limit, default is -1 (unlimited) | |
monitorLimit | Monitor limit, default is -1 (unlimited) | |
carrierLimit | Carrier limit, default is -1 (unlimited) | |
deviceLimit | Device limit, default is -1 (unlimited) | |
targetLimit | Target limit, default is -1 (unlimited) | |
areaLimit | Area limit, default is -1 (unlimited) | |
securityPath | If Two-Factor Authentication is enabled in Account General Settings, the security binary path will be used to judge whether or not this account is TwoFactorSecurity Valid when a user logs in. | |
Return value: AccountID
Function description: Edits an account at the installer level.
DeleteAccount method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
accountID | Required, account ID | |
Return value: String
Function description: Deletes an account in the system at the installer level.
WSLanguageManager Web Service
GetLanguageList method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
Return value: String
Function description: Gets a list of languages available in the installation.
GetLanguage method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
languageID | Required, language ID | |
Return value: String
Function description: Gets a language.
GetSystemLanguageList method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
Return value: String
Function description: Gets a list of the available system languages.
LanguageDelete method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
languageID | Required, language ID | |
Return value: String
Function description: Deletes a language.
CreateLanguage method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
languageName | Required, language name | |
isSystem | Required | |
Status | Required, status | |
Return value: String
Function description: Creates a new language.
EditLanguage method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
languageID | Required, language ID | |
isSystem | Required | |
Status | Required, status | |
Return value: String
Function description: Edits a language.
SetLanguageForUser method
Parameters:
installUserName | Required, installer user name for authentication | |
installerPassword | Required, installer password for authentication | |
languageID | Required, language ID | |
accountID | Required, account ID | |
Status | Required, status | |
Return value: String
Function description: Sets the language for a user.
Return to the: Cygnus Track Developer Center
cygnus_track_portal_web_services_reference_guide.txt · Last modified: 2015/09/16 02:00 by admin