User Tools

Site Tools


cygnus_track_portal_web_services_reference_guide

This is an old revision of the document!


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

<small>Available in all Cygnus Track editions</small>

WSOrganizationManager Web Service

GetOrganizationsForAccount method

Parameters:

:{| style=“width: 350px”

securityKey
accountID

Return value: String

Function description: Gets an organization from an account.

GetAllOrganizationForAccount method

Parameters:

:{| style=“width: 350px”

userName
password
accountID

Return value: String

Function description: Gets all organizations from an account.

GetOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
orgID

Return value: String

Function description: Gets an organization.

CreateOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
orgName
Description
mapDataID
timeZone
metric
status
externalID

Return value: OrganizationID

Function description: Creates an organization.

EditOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
orgID
orgName
description
manager
imageName
mapDataID
timeZone
metric
status
externalID

Return value: String

Function description: Edits an organization.

DeleteOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
orgID

Return value: String

Function description: Deletes an organization in the system.

OrganizationAddDevice method.

Parameters:

:{| style=“width: 350px”

userName
password
orgID
deviceID

Return value: String

Function description: Adds a device to an organization.

OrganizationAddCarrier method

Parameters:

:{| style=“width: 350px”

userName
password
orgID
carrierID

Return value: String

Function description: Adds a carrier to an organization.

OrganizationAddMonitor method

Parameters:

:{| style=“width: 350px”

userName
password
orgID
monitorID

Return value: String

Function description: Adds a monitor to an organization.

GetCarriersForOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
orgID

Return value: String

Function description: Gets the carriers in an organization.

GetDevicesForOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
orgID

Return value: String

Function description: Gets the devices in an organization.

GetMonitorsForOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
orgID

Return value: String

Function description: Gets the monitors in an organization.

DeleteOrganizationCarrier method

Parameters:

:{| style=“width: 350px”

userName
password
orgID
carrierID

Return value: String

Function description: Deletes a carrier from an organization.

DeleteOrganizationDevice method

Parameters:

:{| style=“width: 350px”

userName
password
orgID
deviceID

Return value: String

Function description: Deletes a device from an organization.

DeleteOrganizationMonitor method

Parameters:

:{| style=“width: 350px”

userName
password
orgID
monitorID

Return value: String

Function description: Deletes a monitor from an organization.

GetAllMapDataForAccount method

Parameters:

:{| style=“width: 350px”

userName
password
accountID

Return value: String

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

WSMonitorManager Web Service

CreateMonitor method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
accountID
name
description
userName
password
accountID
entryReference
status
externalID

Return value: MonitorID

Function description: Creates a monitor.

EditMonitor method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
accountID
monitorID
name
description
userName
password
accountID
entryReference
status
externalID

Return value: String

Function description: Edits a monitor.

DeleteMonitor method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
MonitorID

Return value: String

Function description: Deletes a monitor from the system.

GetMonitor method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
MonitorID

Return value: String

Function description: Gets a monitor.

GetMonitorsForAccount method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
accountID

Return value: String

Function description: Gets monitors from an account.

GetMonitorsForOrganization method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
orgID

Return value: String

Function description: Gets monitors from an organization.

WSUserManager Web Service

GetUsersForAccount method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
accountID

Return value: String

Function description: Gets users from an account.

GetUser method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
userID

Return value: String

Function description: Gets a user.

CreateUser method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
accountID
userName
password
status
externalID
entryReference
firstName
lastName
emailAddress
activateDate
deactiveDate
allowMultipleSessions
checkMessageInterval

Return value: UserID

Function description: Creates a user.

EditUser method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
accountID
userID
userName
password
status
externalID
entryReference
firstName
lastName
emailAddress
activateDate
deactiveDate
allowMultipleSessions
checkMessageInterval

Return value: String

Function description: Edits a user.

DeleteUser method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
userID

Return value: String

Function description: Deletes a user from the system.

ChangeUserPassword method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
userName
newPassword

Return value: String

Function description: Change a user's password.

IsUserNameInUse method

Parameters:

:{| style=“width: 350px”

username

Return value: bool

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

IsEmailInUse method

Parameters:

:{| style=“width: 350px”

emailAddress

Return value: bool

Function description: Checks whether a specified user email address is in use.

WSDeviceManager Web Service

GetDevicesForOrganization method

Parameters:

:{| style=“width: 350px”

securityKey
organizationID

Return value: String

Function description: Gets the devices from an organization.

GetDevicesForAccount method

Parameters:

:{| style=“width: 350px”

userName
password
accountid

Return value: String

Function description: Gets the devices from an account.

GetAllDevicesForOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
orgID

Return value: String

Function description: Gets all devices from an organization.

GetDeviceCategories method

Parameters:

:{| style=“width: 350px”

userName
password
accountid

Return value: String

Function description: Gets the device categories.

GetDevice method

Parameters:

:{| style=“width: 350px”

userName
password
deviceID

Return value: String

Function description: Gets a device.

CreateDevice method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
deviceName
description
topSpeed
status
externalID
imei
cannedMessage
deviceCategoryID
colorCode

Return value: DeviceID

Function description: Creates a device.

EditDevice method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
deviceID
deviceName
description
topSpeed
status
externalID
imei
cannedMessage
deviceCategoryID
colorCode

Return value: String

Function description: Edits a carrier.

DeleteDevice method

Parameters:

:{| style=“width: 350px”

userName
password
deviceID

Return value: String

Function description: Delete a device from the system.

WSCarrierManager Web Service

GetCarriersForAccount method

Parameters:

:{| style=“width: 350px”

userName
password
accountID

Return value: String

Function description: Gets the carriers from an account.

GetCarriersForOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
orgID

Return value: String

Function description: Gets the carriers from an organization.

GetCarriersDevice method

Parameters:

:{| style=“width: 350px”

userName
password
carrierID

Return value: String

Function description: Gets a carrier's device.

GetCarriers method

Parameters:

:{| style=“width: 350px”

userName
password
carrierID

Return value: String

Function description: Gets a carrier.

CreateCarrier method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
carrierName
carrierPin
status
externalID
colorCode

Return value: CarrierID

Function description: Creates a carrier.

EditCarrier method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
carrierID
carrierName
description
otherInformation
carrierPin
status
externalID
colorCode

Return value: String

Function description: Edits a carrier.

DeleteCarrier method

Parameters:

:{| style=“width: 350px”

userName
password
carrierID

Return value: String

Function description: Deletes a carrier from the system.

CarrierAddDevice method

Parameters:

:{| style=“width: 350px”

userName
password
carrierID
deviceID

Return value: String

Function description: Assigns a device to a carrier.

CarrierDeleteDevice method

Parameters:

:{| style=“width: 350px”

userName
password
carrierID
deviceID

Return value: String

Function description: Disassociates a device from a carrier.

WSAlertManager Web Service

LoadEventResponseForAccount method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
severity

Return value: String

Function description: Loads an event response for an account.

LoadEventResponseForOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
organizationID
severity

Return value: String

Function description: Loads an event response for an organization.

EditEventResponseForAccount method

Parameters:

:{| style=“width: 350px”

userName
password
accountID
severity
additionalEmailAddresses
alertPopupAction
alertThreshold
friendlyName
iconPath
noisePath
overridden
overrides
repeat
sendEmail
severityColor

Return value: String

Function description: Edits an event response for an account.

EditEventResponseForOrganization method

Parameters:

:{| style=“width: 350px”

userName
password
organizationID
severity
additionalEmailAddresses
alertPopupAction
alertThreshold
friendlyName
iconPath
noisePath
overridden
overrides
repeat
sendEmail
severityColor

Return value: String

Function description: Edits an event response for an organization.

WSLocationManager Web Service

CreateLocation method

Parameters:

:{| style=“width: 350px”

adminUserName
adminPassword
IMEI
locationID
logTime
ypoint
xpoint
altitude
speed
travelDirection
speedUncertainty
responseCode
assistanceUsed

Return value: LocationID

Function description: Create a location for device.

GetCurrentLocationByDevice method

Parameters:

:{| style=“width: 350px”

userName
password
locationID

Return value: String

Function description: Get current location for the device.

GetLocationBySession method

Parameters:

:{| style=“width: 350px”

userName
password
lsessionD

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:

:{| style=“width: 350px”

installUserName
installPassword
adminUserName
adminPassword
accountName
externalID
status
activateDate
deactivateDate
manageSecurity
manageBrand
processLocationInfo
termsOfUse
orgLimit
monitorLimit
carrierLimit
deviceLimit
targetLimit
areaLimit
securityPath

Return value: AccountID

Function description: Creates an account at the installer level.

GetAccount method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword
accountID

Return value: String

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

GetAllAccounts method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword

Return value: String

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

EditAccount method

Parameters:

:{| style=“width: 350px”

installUserName
installPassword
accountID
accountName
externalID
status
activateDate
deactivateDate
manageSecurity
manageBrand
processLocationInfo
termsOfUse
orgLimit
monitorLimit
carrierLimit
deviceLimit
targetLimit
areaLimit
securityPath

Return value: AccountID

Function description: Edits an account at the installer level.

DeleteAccount method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword
accountID

Return value: String

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

WSLanguageManager Web Service

GetLanguageList method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword

Return value: String

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

GetLanguage method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword
languageID

Return value: String

Function description: Gets a language.

GetSystemLanguageList method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword

Return value: String

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

LanguageDelete method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword
languageID

Return value: String

Function description: Deletes a language.

CreateLanguage method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword
languageName
isSystem
Status

Return value: String

Function description: Creates a new language.

EditLanguage method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword
languageID
isSystem
Status

Return value: String

Function description: Edits a language.

SetLanguageForUser method

Parameters:

:{| style=“width: 350px”

installUserName
installerPassword
languageID
accountID
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.1440040122.txt.gz · Last modified: 2015/09/16 02:00 (external edit)