This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Last revision Both sides next revision | ||
map_suite_gps_tracking_server_web_services_reference_guide [2015/09/16 05:59] admin created |
map_suite_gps_tracking_server_web_services_reference_guide [2015/09/16 05:59] admin |
||
---|---|---|---|
Line 8: | Line 8: | ||
==== WSOrganizationManager Web Service ==== | ==== WSOrganizationManager Web Service ==== | ||
=== GetOrganizationsForAccount method === | === GetOrganizationsForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''securityKey''|Required, user ID| |
- | |<tt>securityKey</tt> | + | |''accountID''|Required, Account ID| |
- | |Required, user ID | + | |
- | |- | + | Return value: String |
- | |<tt>accountID</tt> | + | |
- | |Required, Account ID | + | Function description: Gets an organization from an account. |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets an organization from an account. | + | |
=== GetAllOrganizationForAccount method === | === GetAllOrganizationForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, Account ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets all organizations from an account. |
- | |<tt>accountID</tt> | + | |
- | |Required, Account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets all organizations from an account. | + | |
=== GetOrganization method === | === GetOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, Organization ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets an organization. |
- | |<tt>orgID</tt> | + | |
- | |Required, Organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets an organization. | + | |
=== CreateOrganization method === | === CreateOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''orgName''|Required, organization name| |
- | |<tt>password</tt> | + | |''Description''|Organization description| |
- | |Required, password for authentication | + | |''mapDataID''|Required, map Data ID| |
- | |- | + | |''timeZone''|Required, time zone of the organization's location| |
- | |<tt>accountID</tt> | + | |''metric''|Required, selects whether the organization's unit system is metric or imperial| |
- | |Required, account ID | + | |''status''|Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |- | + | |''externalID''|Reserved field| |
- | |<tt>orgName</tt> | + | |
- | |Required, organization name | + | Return value: OrganizationID |
- | |- | + | |
- | |<tt>Description</tt> | + | Function description: Creates an organization. |
- | |Organization description | + | |
- | |- | + | |
- | |<tt>mapDataID</tt> | + | |
- | |Required, map Data ID | + | |
- | |- | + | |
- | |<tt>timeZone</tt> | + | |
- | |Required, time zone of the organization's location | + | |
- | |- | + | |
- | |<tt>metric</tt> | + | |
- | |Required, selects whether the organization's unit system is metric or imperial | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |} | + | |
- | + | ||
- | Return value: OrganizationID | + | |
- | + | ||
- | Function description: Creates an organization. | + | |
=== EditOrganization method === | === EditOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''orgID''|Required, organization ID| |
- | |<tt>password</tt> | + | |''orgName''|Required, organization name| |
- | |Required, password for authentication | + | |''description''|Organization description| |
- | |- | + | |''manager''|Manager of the organization| |
- | |<tt>accountID</tt> | + | |''imageName''|The path of the organization image| |
- | |Required, account ID | + | |''mapDataID''|Required, map data ID| |
- | |- | + | |''timeZone''|Required, time zone of the organization's location| |
- | |<tt>orgID</tt> | + | |''metric''|Required, selects whether the organization's unit system is metric or imperial| |
- | |Required, organization ID | + | |''status''|Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |- | + | |''externalID''|Reserved field| |
- | |<tt>orgName</tt> | + | |
- | |Required, organization name | + | Return value: String |
- | |- | + | |
- | |<tt>description</tt> | + | Function description: Edits an organization. |
- | |Organization description | + | |
- | |- | + | |
- | |<tt>manager</tt> | + | |
- | |Manager of the organization | + | |
- | |- | + | |
- | |<tt>imageName</tt> | + | |
- | |The path of the organization image | + | |
- | |- | + | |
- | |<tt>mapDataID</tt> | + | |
- | |Required, map data ID | + | |
- | |- | + | |
- | |<tt>timeZone</tt> | + | |
- | |Required, time zone of the organization's location | + | |
- | |- | + | |
- | |<tt>metric</tt> | + | |
- | |Required, selects whether the organization's unit system is metric or imperial | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, organization status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits an organization. | + | |
=== DeleteOrganization method === | === DeleteOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Deletes an organization in the system. |
- | |<tt>orgID</tt> | + | |
- | |Required, organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes an organization in the system. | + | |
=== OrganizationAddDevice method === | === OrganizationAddDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''userName''|Required, user name for authentication| |
- | |Required, user name for authentication | + | |''password''|Required, password for authentication| |
- | |- | + | |''orgID''|Required, organization ID| |
- | |<tt>userName</tt> | + | |''deviceID''|Required, device ID| |
- | |Required, user name for authentication | + | |
- | |- | + | Return value: String |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Function description: Adds a device to an organization. |
- | |- | + | |
- | |<tt>orgID</tt> | + | |
- | |Required, organization ID | + | |
- | |- | + | |
- | |<tt>deviceID</tt> | + | |
- | |Required, device ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Adds a device to an organization. | + | |
=== OrganizationAddCarrier method === | === OrganizationAddCarrier method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |''carrierID''|Required, carrier ID| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>orgID</tt> | + | Function description: Adds a carrier to an organization. |
- | |Required, organization ID | + | |
- | |- | + | |
- | |<tt>carrierID</tt> | + | |
- | |Required, carrier ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Adds a carrier to an organization. | + | |
=== OrganizationAddMonitor method === | === OrganizationAddMonitor method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |''monitorID''|Required, monitor ID| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>orgID</tt> | + | Function description: Adds a monitor to an organization. |
- | |Required, organization ID | + | |
- | |- | + | |
- | |<tt>monitorID</tt> | + | |
- | |Required, monitor ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Adds a monitor to an organization. | + | |
=== GetCarriersForOrganization method === | === GetCarriersForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets the carriers in an organization. |
- | |<tt>orgID</tt> | + | |
- | |Required, organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the carriers in an organization. | + | |
=== GetDevicesForOrganization method === | === GetDevicesForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets the devices in an organization. |
- | |<tt>orgID</tt> | + | |
- | |Required, organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the devices in an organization. | + | |
=== GetMonitorsForOrganization method === | === GetMonitorsForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets the monitors in an organization. |
- | |<tt>orgID</tt> | + | |
- | |Required, organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the monitors in an organization. | + | |
=== DeleteOrganizationCarrier method === | === DeleteOrganizationCarrier method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |''carrierID''|Required, carrier ID| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>orgID</tt> | + | Function description: Deletes a carrier from an organization. |
- | |Required, organization ID | + | |
- | |- | + | |
- | |<tt>carrierID</tt> | + | |
- | |Required, carrier ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes a carrier from an organization. | + | |
=== DeleteOrganizationDevice method === | === DeleteOrganizationDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, Organization ID| |
- | |- | + | |''deviceID''|Required, device ID| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>orgID</tt> | + | Function description: Deletes a device from an organization. |
- | |Required, Organization ID | + | |
- | |- | + | |
- | |<tt>deviceID</tt> | + | |
- | |Required, device ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes a device from an organization. | + | |
=== DeleteOrganizationMonitor method === | === DeleteOrganizationMonitor method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |''monitorID''|Required, monitor ID| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>orgID</tt> | + | Function description: Deletes a monitor from an organization. |
- | |Required, organization ID | + | |
- | |- | + | |
- | |<tt>monitorID</tt> | + | |
- | |Required, monitor ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes a monitor from an organization. | + | |
=== GetAllMapDataForAccount method === | === GetAllMapDataForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets all available map data for an account. |
- | |<tt>accountID</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets all available map data for an account. | + | |
- | + | ||
- | + | ||
==== WSMonitorManager Web Service ==== | ==== WSMonitorManager Web Service ==== | ||
=== CreateMonitor method === | === CreateMonitor method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminUserName''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''name''|Required, Monitor name| |
- | |<tt>adminUserName</tt> | + | |''description''|Monitor description| |
- | |Required, admin password for authentication | + | |''userName''|Required, user name| |
- | |- | + | |''password''|Required, password| |
- | |<tt>accountID</tt> | + | |''entryReference''|Required, selects which page is the default entry page |
- | |Required, account ID | + | Dashboard or Map Area| |
- | |- | + | |''status''|Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |<tt>name</tt> | + | |''externalID''|Reserved field| |
- | |Required, Monitor name | + | |
- | |- | + | Return value: MonitorID |
- | |<tt>description</tt> | + | |
- | |Monitor description | + | Function description: Creates a monitor. |
- | |- | + | |
- | |<tt>userName</tt> | + | |
- | |Required, user name | + | |
- | |- | + | |
- | |<tt>password</tt> | + | |
- | |Required, password | + | |
- | |- | + | |
- | |<tt>entryReference</tt> | + | |
- | |Required, selects which page is the default entry page - Dashboard or Map Area | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |} | + | |
- | + | ||
- | Return value: MonitorID | + | |
- | + | ||
- | Function description: Creates a monitor. | + | |
=== EditMonitor method === | === EditMonitor method === | ||
- | Parameters | + | Parameters |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''monitorID''|Monitor ID| |
- | |<tt>adminPassword</tt> | + | |''name''|Required, monitor name| |
- | |Required, admin password for authentication | + | |''description''|Monitor description| |
- | |- | + | |''userName''|Required, user name| |
- | |<tt>accountID</tt> | + | |''password''|Required, password| |
- | |Required, account ID | + | |''entryReference''|Required, selects which page is the default entry page |
- | |- | + | Dashboard or Map Area| |
- | |<tt>monitorID</tt> | + | |''status''|Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |Monitor ID | + | |''externalID''|Reserved field| |
- | |- | + | |
- | |<tt>name</tt> | + | Return value: String |
- | |Required, monitor name | + | |
- | |- | + | Function description: Edits a monitor. |
- | |<tt>description</tt> | + | |
- | |Monitor description | + | |
- | |- | + | |
- | |<tt>userName</tt> | + | |
- | |Required, user name | + | |
- | |- | + | |
- | |<tt>password</tt> | + | |
- | |Required, password | + | |
- | |- | + | |
- | |<tt>entryReference</tt> | + | |
- | |Required, selects which page is the default entry page - Dashboard or Map Area | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, monitor status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits a monitor. | + | |
=== DeleteMonitor method === | === DeleteMonitor method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminUserName''|Required, admin user name for authentication| |
- | |Required, admin user name for authentication | + | |''adminPassword''|Required, admin password for authentication| |
- | |- | + | |''MonitorID''|Required, monitor ID| |
- | |<tt>adminUserName</tt> | + | |
- | |Required, admin user name for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>adminPassword</tt> | + | Function description: Deletes a monitor from the system. |
- | |Required, admin password for authentication | + | |
- | |- | + | |
- | |<tt>MonitorID</tt> | + | |
- | |Required, monitor ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes a monitor from the system. | + | |
=== GetMonitor method === | === GetMonitor method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''MonitorID''|Required, monitor ID| |
- | |- | + | |
- | |<tt>adminPassword</tt> | + | Return value: String |
- | |Required, admin password for authentication | + | |
- | |- | + | Function description: Gets a monitor. |
- | |<tt>MonitorID</tt> | + | |
- | |Required, monitor ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a monitor. | + | |
=== GetMonitorsForAccount method === | === GetMonitorsForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |
- | |<tt>adminPassword</tt> | + | Return value: String |
- | |Required, admin password for authentication | + | |
- | |- | + | Function description: Gets monitors from an account. |
- | |<tt>accountID</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | | + | |
- | Return value: String | + | |
- | + | ||
- | Function description: Gets monitors from an account. | + | |
=== GetMonitorsForOrganization method === | === GetMonitorsForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''orgID''|Required, Organization ID| |
- | |- | + | |
- | |<tt>adminPassword</tt> | + | Return value: String |
- | |Required, admin password for authentication | + | |
- | |- | + | Function description: Gets monitors from an organization. |
- | |<tt>orgID</tt> | + | |
- | |Required, Organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets monitors from an organization. | + | |
- | + | ||
- | + | ||
- | + | ||
==== WSUserManager Web Service ==== | ==== WSUserManager Web Service ==== | ||
=== GetUsersForAccount method === | === GetUsersForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |
- | |<tt>adminPassword</tt> | + | Return value: String |
- | |Required, admin password for authentication | + | |
- | |- | + | Function description: Gets users from an account. |
- | |<tt>accountID</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets users from an account. | + | |
=== GetUser method === | === GetUser method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''userID''|Required, user ID| |
- | |- | + | |
- | |<tt>adminPassword</tt> | + | Return value: String |
- | |Required, admin password for authentication | + | |
- | |- | + | Function description: Gets a user. |
- | |<tt>userID</tt> | + | |
- | |Required, user ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a user. | + | |
=== CreateUser method === | === CreateUser method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''userName''|Required, user name| |
- | |<tt>adminPassword</tt> | + | |''password''|Required, password| |
- | |Required, admin password for authentication | + | |''status''|Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |- | + | |''externalID''|Reserved field| |
- | |<tt>accountID</tt> | + | |''entryReference''|Required, selects which page is the default entry page |
- | |Required, account ID | + | Dashboard or Map Area| |
- | |- | + | |''firstName''|First name| |
- | |<tt>userName</tt> | + | |''lastName''|Last name| |
- | |Required, user name | + | |''emailAddress''|Email address| |
- | |- | + | |''activateDate''|Activation date| |
- | |<tt>password</tt> | + | |''deactiveDate''|Deactivation date| |
- | |Required, password | + | |''allowMultipleSessions''|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| |
- | |- | + | |''checkMessageInterval''|Check message interval| |
- | |<tt>status</tt> | + | |
- | |Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE | + | Return value: UserID |
- | |- | + | |
- | |<tt>externalID</tt> | + | Function description: Creates a user. |
- | |Reserved field | + | |
- | |- | + | |
- | |<tt>entryReference</tt> | + | |
- | |Required, selects which page is the default entry page - Dashboard or Map Area | + | |
- | |- | + | |
- | |<tt>firstName</tt> | + | |
- | |First name | + | |
- | |- | + | |
- | |<tt>lastName</tt> | + | |
- | |Last name | + | |
- | |- | + | |
- | |<tt>emailAddress</tt> | + | |
- | |Email address | + | |
- | |- | + | |
- | |<tt>activateDate</tt> | + | |
- | |Activation date | + | |
- | |- | + | |
- | |<tt>deactiveDate</tt> | + | |
- | |Deactivation date | + | |
- | |- | + | |
- | |<tt>allowMultipleSessions</tt> | + | |
- | |Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously | + | |
- | |- | + | |
- | |<tt>checkMessageInterval</tt> | + | |
- | |Check message interval | + | |
- | |} | + | |
- | + | ||
- | Return value: UserID | + | |
- | + | ||
- | Function description: Creates a user. | + | |
=== EditUser method === | === EditUser method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''userID''|Required, user ID| |
- | |<tt>adminPassword</tt> | + | |''userName''|Required, user name| |
- | |Required, admin password for authentication | + | |''password''|Required, password| |
- | |- | + | |''status''|Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |<tt>accountID</tt> | + | |''externalID''|Reserved field| |
- | |Required, account ID | + | |''entryReference''|Required, selects which page is the default entry page |
- | |- | + | Dashboard or Map Area| |
- | |<tt>userID</tt> | + | |''firstName''|First name| |
- | |Required, user ID | + | |''lastName''|Last name| |
- | |- | + | |''emailAddress''|Email address| |
- | |<tt>userName</tt> | + | |''activateDate''|Activation date| |
- | |Required, user name | + | |''deactiveDate''|Deactivation date| |
- | |- | + | |''allowMultipleSessions''|Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously| |
- | |<tt>password</tt> | + | |''checkMessageInterval''|Check message interval| |
- | |Required, password | + | |
- | |- | + | Return value: String |
- | |<tt>status</tt> | + | |
- | |Required, user status, must be ACTIVE or INACTIVE, default is ACTIVE | + | Function description: Edits a user. |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |- | + | |
- | |<tt>entryReference</tt> | + | |
- | |Required, selects which page is the default entry page - Dashboard or Map Area | + | |
- | |- | + | |
- | |<tt>firstName</tt> | + | |
- | |First name | + | |
- | |- | + | |
- | |<tt>lastName</tt> | + | |
- | |Last name | + | |
- | |- | + | |
- | |<tt>emailAddress</tt> | + | |
- | |Email address | + | |
- | |- | + | |
- | |<tt>activateDate</tt> | + | |
- | |Activation date | + | |
- | |- | + | |
- | |<tt>deactiveDate</tt> | + | |
- | |Deactivation date | + | |
- | |- | + | |
- | |<tt>allowMultipleSessions</tt> | + | |
- | |Whether to enable multiple sessions, which allow the same user to be logged in more than once simultaneously | + | |
- | |- | + | |
- | |<tt>checkMessageInterval</tt> | + | |
- | |Check message interval | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits a user. | + | |
=== DeleteUser method === | === DeleteUser method === | ||
- | Parameters | + | Parameters |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''userID''|Required, user ID| |
- | |- | + | |
- | |<tt>adminPassword</tt> | + | Return value: String |
- | |Required, admin password for authentication | + | |
- | |- | + | Function description: Deletes a user from the system. |
- | |<tt>userID</tt> | + | |
- | |Required, user ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes a user from the system. | + | |
=== ChangeUserPassword method === | === ChangeUserPassword method === | ||
- | Parameters | + | Parameters |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, admin user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, admin password for authentication| |
- | |Required, admin user name for authentication | + | |''userName''|Required, user name| |
- | |- | + | |''newPassword''|Required, new password| |
- | |<tt>adminPassword</tt> | + | |
- | |Required, admin password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>userName</tt> | + | Function description: Change a user's password. |
- | |Required, user name | + | |
- | |- | + | |
- | |<tt>newPassword</tt> | + | |
- | |Required, new password | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Change a user's password. | + | |
=== IsUserNameInUse method === | === IsUserNameInUse method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''username''|Required, the user name to check for| |
- | |<tt>username</tt> | + | |
- | |Required, the user name to check for | + | Return value: bool |
- | |} | + | |
- | + | Function description: Checks whether a specified username is in use. | |
- | Return value: bool | + | |
- | + | ||
- | Function description: Checks whether a specified username is in use. | + | |
=== IsEmailInUse method === | === IsEmailInUse method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''emailAddress''|Required, the email address to check for| |
- | |<tt>emailAddress</tt> | + | |
- | |Required, the email address to check for | + | Return value: bool |
- | |} | + | |
- | + | Function description: Checks whether a specified user email address is in use. | |
- | Return value: bool | + | |
- | + | ||
- | Function description: Checks whether a specified user email address is in use. | + | |
- | + | ||
- | + | ||
==== WSDeviceManager Web Service ==== | ==== WSDeviceManager Web Service ==== | ||
=== GetDevicesForOrganization method === | === GetDevicesForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''securityKey''|Required, user ID| |
- | |<tt>securityKey</tt> | + | |''organizationID''|Required, organization ID| |
- | |Required, user ID | + | |
- | |- | + | Return value: String |
- | |<tt>organizationID</tt> | + | |
- | |Required, organization ID | + | Function description: Gets the devices from an organization. |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the devices from an organization. | + | |
=== GetDevicesForAccount method === | === GetDevicesForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountid''|Required, account ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets the devices from an account. |
- | |<tt>accountid</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | | + | |
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the devices from an account. | + | |
=== GetAllDevicesForOrganization method === | === GetAllDevicesForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets all devices from an organization. |
- | |<tt>orgID</tt> | + | |
- | |Required, organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets all devices from an organization. | + | |
=== GetDeviceCategories method === | === GetDeviceCategories method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets the device categories. |
- | |<tt>accountID</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the device categories. | + | |
=== GetDevice method === | === GetDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''deviceID''|Required, device ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets a device. |
- | |<tt>deviceID</tt> | + | |
- | |Required, device ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a device. | + | |
=== CreateDevice method === | === CreateDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''deviceName''|Required, device name| |
- | |<tt>password</tt> | + | |''description''|Device description| |
- | |Required, password for authentication | + | |''topSpeed''|Required, top speed| |
- | |- | + | |''status''|Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |<tt>accountID</tt> | + | |''externalID''|Reserved field| |
- | |Required, account ID | + | |''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 |
- | |<tt>deviceName</tt> | + | way communication| |
- | |Required, device name | + | |''deviceCategoryID''|Device category ID| |
- | |- | + | |''colorCode''|Choose a color to associate with the device, default is a random color| |
- | |<tt>description</tt> | + | |
- | |Device description | + | Return value: DeviceID |
- | |- | + | |
- | |<tt>topSpeed</tt> | + | Function description: Creates a device. |
- | |Required, top speed | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |- | + | |
- | |<tt>imei</tt> | + | |
- | |Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem | + | |
- | |- | + | |
- | |<tt>cannedMessage</tt> | + | |
- | |Required, specifies whether or not the device supports two-way communication | + | |
- | |- | + | |
- | |<tt>deviceCategoryID</tt> | + | |
- | |Device category ID | + | |
- | |- | + | |
- | |<tt>colorCode</tt> | + | |
- | |Choose a color to associate with the device, default is a random color | + | |
- | |} | + | |
- | + | ||
- | Return value: DeviceID | + | |
- | + | ||
- | Function description: Creates a device. | + | |
=== EditDevice method === | === EditDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''DeviceID''|Required, device ID| |
- | |<tt>password</tt> | + | |''deviceName''|Required, device name| |
- | |Required, password for authentication | + | |''description''|Device description| |
- | |- | + | |''topSpeed''|Required, top speed| |
- | |<tt>accountID</tt> | + | |''status''|Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |Required, account ID | + | |''externalID''|Reserved field| |
- | |- | + | |''imei''|Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem| |
- | |<tt>DeviceID</tt> | + | |''cannedMessage''|Required, specifies whether or not the device supports two |
- | |Required, device ID | + | way communication| |
- | |- | + | |''deviceCategoryID''|Device category ID| |
- | |<tt>deviceName</tt> | + | |''colorCode''|Choose a color to associate with the device, default is a random color| |
- | |Required, device name | + | |
- | |- | + | Return value: String |
- | |<tt>description</tt> | + | |
- | |Device description | + | Function description: Edits a carrier. |
- | |- | + | |
- | |<tt>topSpeed</tt> | + | |
- | |Required, top speed | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, device status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |- | + | |
- | |<tt>imei</tt> | + | |
- | |Required, International Mobile Equipment Identifier (IMEI) or Electronic Identifier (EID) of the wireless modem | + | |
- | |- | + | |
- | |<tt>cannedMessage</tt> | + | |
- | |Required, specifies whether or not the device supports two-way communication | + | |
- | |- | + | |
- | |<tt>deviceCategoryID</tt> | + | |
- | |Device category ID | + | |
- | |- | + | |
- | |<tt>colorCode</tt> | + | |
- | |Choose a color to associate with the device, default is a random color | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits a carrier. | + | |
=== DeleteDevice method === | === DeleteDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''deviceID''|Required, device ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Delete a device from the system. |
- | |<tt>deviceID</tt> | + | |
- | |Required, device ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Delete a device from the system. | + | |
- | + | ||
- | + | ||
==== WSCarrierManager Web Service ==== | ==== WSCarrierManager Web Service ==== | ||
=== GetCarriersForAccount method === | === GetCarriersForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets the carriers from an account. |
- | |<tt>accountID</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the carriers from an account. | + | |
=== GetCarriersForOrganization method === | === GetCarriersForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''orgID''|Required, organization ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets the carriers from an organization. |
- | |<tt>orgID</tt> | + | |
- | |Required, organization ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets the carriers from an organization. | + | |
=== GetCarriersDevice method === | === GetCarriersDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''carrierID''|Required, carrier ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets a carrier's device. |
- | |<tt>carrierID</tt> | + | |
- | |Required, carrier ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a carrier's device. | + | |
=== GetCarriers method === | === GetCarriers method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''carrierID''|Required, carrier ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Gets a carrier. |
- | |<tt>carrierID</tt> | + | |
- | |Required, carrier ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a carrier. | + | |
=== CreateCarrier method === | === CreateCarrier method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''carrierName''|Required, carrier name| |
- | |<tt>password</tt> | + | |''carrierPin''|Carrier's personal identification number, the default value is 0000| |
- | |Required, password for authentication | + | |''status''|Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |- | + | |''externalID''|Reserved field| |
- | |<tt>accountID</tt> | + | |''colorCode''|Choose a color to associate with the device, default is a random color| |
- | |Required, account ID | + | |
- | |- | + | Return value: CarrierID |
- | |<tt>carrierName</tt> | + | |
- | |Required, carrier name | + | Function description: Creates a carrier. |
- | |- | + | |
- | |<tt>carrierPin</tt> | + | |
- | |Carrier's personal identification number, the default value is 0000 | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |- | + | |
- | |<tt>colorCode</tt> | + | |
- | |Choose a color to associate with the device, default is a random color | + | |
- | |} | + | |
- | + | ||
- | Return value: CarrierID | + | |
- | + | ||
- | Function description: Creates a carrier. | + | |
=== EditCarrier method === | === EditCarrier method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''carrierID''|Required, carrier ID| |
- | |<tt>password</tt> | + | |''carrierName''|Required, carrier name| |
- | |Required, password for authentication | + | |''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.| |
- | |<tt>accountID</tt> | + | |''carrierPin''|Carrier's personal identification number, the default value is 0000| |
- | |Required, account ID | + | |''status''|Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |- | + | |''externalID''|Reserved field| |
- | |<tt>carrierID</tt> | + | |''colorCode''|Choose a color to associate with the device, default is a random color| |
- | |Required, carrier ID | + | |
- | |- | + | Return value: String |
- | |<tt>carrierName</tt> | + | |
- | |Required, carrier name | + | Function description: Edits a carrier. |
- | |- | + | |
- | |<tt>description</tt> | + | |
- | |Required, description of the carrier | + | |
- | |- | + | |
- | |<tt>otherInformation</tt> | + | |
- | |Other information about the carrier, HTML supported. Will be displayed in a popup bubble on the tracking screen. | + | |
- | |- | + | |
- | |<tt>carrierPin</tt> | + | |
- | |Carrier's personal identification number, the default value is 0000 | + | |
- | |- | + | |
- | |<tt>status</tt> | + | |
- | |Required, carrier status, must be ACTIVE or INACTIVE, default is ACTIVE | + | |
- | |- | + | |
- | |<tt>externalID</tt> | + | |
- | |Reserved field | + | |
- | |- | + | |
- | |<tt>colorCode</tt> | + | |
- | |Choose a color to associate with the device, default is a random color | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits a carrier. | + | |
=== DeleteCarrier method === | === DeleteCarrier method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''carrierID''|Required, carrier ID| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Deletes a carrier from the system. |
- | |<tt>carrierID</tt> | + | |
- | |Required, carrier ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes a carrier from the system. | + | |
=== CarrierAddDevice method === | === CarrierAddDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''carrierID''|Required, carrier ID| |
- | |- | + | |''deviceID''|Required, device ID| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>carrierID</tt> | + | Function description: Assigns a device to a carrier. |
- | |Required, carrier ID | + | |
- | |- | + | |
- | |<tt>deviceID</tt> | + | |
- | |Required, device ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Assigns a device to a carrier. | + | |
=== CarrierDeleteDevice method === | === CarrierDeleteDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''carrierID''|Required, carrier ID| |
- | |- | + | |''deviceID''|Required, device ID| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>carrierID</tt> | + | Function description: Disassociates a device from a carrier. |
- | |Required, carrier ID | + | |
- | |- | + | |
- | |<tt>deviceID</tt> | + | |
- | |Required, device ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Disassociates a device from a carrier. | + | |
- | + | ||
- | + | ||
==== WSAlertManager Web Service ==== | ==== WSAlertManager Web Service ==== | ||
=== LoadEventResponseForAccount method === | === LoadEventResponseForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''serverity''|Required, serverity level| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>accountID</tt> | + | Function description: Loads an event response for an account. |
- | |Required, account ID | + | |
- | |- | + | |
- | |<tt>serverity</tt> | + | |
- | |Required, serverity level | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Loads an event response for an account. | + | |
=== LoadEventResponseForOrganization method === | === LoadEventResponseForOrganization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''organizationID''|Required, organization ID| |
- | |- | + | |''serverity''|Required, serverity| |
- | |<tt>password</tt> | + | |
- | |Required, password for authentication | + | Return value: String |
- | |- | + | |
- | |<tt>organizationID</tt> | + | Function description: Loads an event response for an organization. |
- | |Required, organization ID | + | |
- | |- | + | |
- | |<tt>serverity</tt> | + | |
- | |Required, serverity | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Loads an event response for an organization. | + | |
=== EditEventResponseForAccount method === | === EditEventResponseForAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''serverity''|Required, serverity| |
- | |<tt>password</tt> | + | |''additionalEmailAddresses''|Required| |
- | |Required, password for authentication | + | |''alertPopupAction''|Required, popup action| |
- | |- | + | |''alertThreshold''|Required, alert threshold| |
- | |<tt>accountID</tt> | + | |''friendlyName''|Required, friendly name| |
- | |Required, account ID | + | |''iconPath''|Required| |
- | |- | + | |''noisePath''|Required| |
- | |<tt>serverity</tt> | + | |''overridden''|Required| |
- | |Required, serverity | + | |''overrides''|Required| |
- | |- | + | |''repeat''|Required| |
- | |<tt>additionalEmailAddresses</tt> | + | |''sendEmail''|Required| |
- | |Required | + | |''severityColor''|Required| |
- | |- | + | |
- | |<tt>alertPopupAction</tt> | + | Return value: String |
- | |Required, popup action | + | |
- | |- | + | Function description: Edits an event response for an account. |
- | |<tt>alertThreshold</tt> | + | |
- | |Required, alert threshold | + | |
- | |- | + | |
- | |<tt>friendlyName</tt> | + | |
- | |Required, friendly name | + | |
- | |- | + | |
- | |<tt>iconPath</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>noisePath</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>overridden</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>overrides</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>repeat</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>sendEmail</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>severityColor</tt> | + | |
- | |Required | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits an event response for an account. | + | |
=== EditEventResponseFor Organization method === | === EditEventResponseFor Organization method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''organizationID''|Required, organization ID| |
- | |- | + | |''serverity''|Required, serverity| |
- | |<tt>password</tt> | + | |''additionalEmailAddresses''|Required| |
- | |Required, password for authentication | + | |''alertPopupAction''|Required, popup action| |
- | |- | + | |''alertThreshold''|Required, alert threshold| |
- | |<tt>organizationID</tt> | + | |''friendlyName''|Required, friendly name| |
- | |Required, organization ID | + | |''iconPath''|Required| |
- | |- | + | |''noisePath''|Required| |
- | |<tt>serverity</tt> | + | |''overridden''|Required| |
- | |Required, serverity | + | |''overrides''|Required| |
- | |- | + | |''repeat''|Required| |
- | |<tt>additionalEmailAddresses</tt> | + | |''sendEmail''|Required| |
- | |Required | + | |''severityColor''|Required| |
- | |- | + | |
- | |<tt>alertPopupAction</tt> | + | Return value: String |
- | |Required, popup action | + | |
- | |- | + | Function description: Edits an event response for an organization. |
- | |<tt>alertThreshold</tt> | + | |
- | |Required, alert threshold | + | |
- | |- | + | |
- | |<tt>friendlyName</tt> | + | |
- | |Required, friendly name | + | |
- | |- | + | |
- | |<tt>iconPath</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>noisePath</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>overridden</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>overrides</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>repeat</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>sendEmail</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>severityColor</tt> | + | |
- | |Required | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits an event response for an organization. | + | |
==== WSLocationManager Web Service ==== | ==== WSLocationManager Web Service ==== | ||
=== CreateLocation method === | === CreateLocation method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''adminUserName''|Required, user name for authentication| |
- | |<tt>adminUserName</tt> | + | |''adminPassword''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''IMEI''|Required, Device IMEI| |
- | |- | + | |''locationID''|Required, New Guid| |
- | |<tt>adminPassword</tt> | + | |''logTime''|Required, GPS date time of message| |
- | |Required, password for authentication | + | |''yPoint''|Required, Latitude| |
- | |- | + | |''xPoint''|Required, Longitude| |
- | |<tt>IMEI</tt> | + | |''altitude''|Required, altitude| |
- | |Required, Device IMEI | + | |''speed''|Required, device speed| |
- | |- | + | |''travelDirection''|Required, Travel Direction| |
- | |<tt>locationID</tt> | + | |''speedUncertainty''|Required, Speed Uncertainty or not| |
- | |Required, New Guid | + | |''responseCode''|Required| |
- | |- | + | |''assistanceUsed''|Required| |
- | |<tt>logTime</tt> | + | |
- | |Required, GPS date time of message | + | Return value: LocationID |
- | |- | + | |
- | |<tt>yPoint</tt> | + | Function description: Create a location for device. |
- | |Required, Latitude | + | |
- | |- | + | |
- | |<tt>xPoint</tt> | + | |
- | |Required, Longitude | + | |
- | |- | + | |
- | |<tt>altitude</tt> | + | |
- | |Required, altitude | + | |
- | |- | + | |
- | |<tt>speed</tt> | + | |
- | |Required, device speed | + | |
- | |- | + | |
- | |<tt>travelDirection</tt> | + | |
- | |Required, Travel Direction | + | |
- | |- | + | |
- | |<tt>speedUncertainty</tt> | + | |
- | |Required, Speed Uncertainty or not | + | |
- | |- | + | |
- | |<tt>responseCode</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>assistanceUsed</tt> | + | |
- | |Required | + | |
- | |} | + | |
- | + | ||
- | Return value: LocationID | + | |
- | + | ||
- | Function description: Create a location for device. | + | |
=== GetCurrentLocationByDevice method === | === GetCurrentLocationByDevice method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''deviceID''|Required| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Get current location for the device. |
- | |<tt>deviceID</tt> | + | |
- | |Required | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Get current location for the device. | + | |
=== GetLocationBySession method === | === GetLocationBySession method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''userName''|Required, user name for authentication| |
- | |<tt>userName</tt> | + | |''password''|Required, password for authentication| |
- | |Required, user name for authentication | + | |''lsessionD''|Required| |
- | |- | + | |
- | |<tt>password</tt> | + | Return value: String |
- | |Required, password for authentication | + | |
- | |- | + | Function description: Get locations for the session. |
- | |<tt>lsessionD</tt> | + | |
- | |Required | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Get locations for the session. | + | |
Line 1441: | Line 809: | ||
==== WSAccountManager Web Service ==== | ==== WSAccountManager Web Service ==== | ||
=== CreateAccount method === | === CreateAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''adminUserName''|Required, admin user name for the account| |
- | |- | + | |''adminPassword''|Required, admin password| |
- | |<tt>installPassword</tt> | + | |''accountName''|Required, account name| |
- | |Required, installer password for authentication | + | |''externalID''|Reserved field| |
- | |- | + | |''status''|Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |<tt>adminUserName</tt> | + | |''activateDate''|Account activation date| |
- | |Required, admin user name for the account | + | |''deactivateDate''|Account deactivation date| |
- | |- | + | |''manageSecurity''|Can manage security or not| |
- | |<tt>adminPassword</tt> | + | |''manageBrand''|Can manage brand or not| |
- | |Required, admin password | + | |''processLocationInfo''|Can process LocationInformation of map or not in account level| |
- | |- | + | |''termsOfUse''|Can use terms of use or not| |
- | |<tt>accountName</tt> | + | |''orgLimit''|Organization limit, default is |
- | |Required, account name | + | 1 (unlimited)| |
- | |- | + | |''monitorLimit''|Monitor limit, default is |
- | |<tt>externalID</tt> | + | 1 (unlimited)| |
- | |Reserved field | + | |''carrierLimit''|Carrier limit, default is |
- | |- | + | 1 (unlimited)| |
- | |<tt>status</tt> | + | |''deviceLimit''|Device limit, default is |
- | |Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE | + | 1 (unlimited)| |
- | |- | + | |''targetLimit''|Target limit, default is |
- | |<tt>activateDate</tt> | + | 1 (unlimited)| |
- | |Account activation date | + | |''areaLimit''|Area limit, default is |
- | |- | + | 1 (unlimited)| |
- | |<tt>deactivateDate</tt> | + | |''securityPath''|If Two |
- | |Account deactivation date | + | 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.| |
- | |- | + | |
- | |<tt>manageSecurity</tt> | + | Return value: AccountID |
- | |Can manage security or not | + | |
- | |- | + | Function description: Creates an account at the installer level. |
- | |<tt>manageBrand</tt> | + | |
- | |Can manage brand or not | + | |
- | |- | + | |
- | |<tt>processLocationInfo</tt> | + | |
- | |Can process LocationInformation of map or not in account level | + | |
- | |- | + | |
- | |<tt>termsOfUse</tt> | + | |
- | |Can use terms of use or not | + | |
- | |- | + | |
- | |<tt>orgLimit</tt> | + | |
- | |Organization limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>monitorLimit</tt> | + | |
- | |Monitor limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>carrierLimit</tt> | + | |
- | |Carrier limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>deviceLimit</tt> | + | |
- | |Device limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>targetLimit</tt> | + | |
- | |Target limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>areaLimit</tt> | + | |
- | |Area limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>securityPath</tt> | + | |
- | |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 === | === GetAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |
- | |<tt>installPassword</tt> | + | Return value: String |
- | |Required, installer password for authentication | + | |
- | |- | + | Function description: Checks to see whether the account exists in the system. |
- | |<tt>accountID</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Checks to see whether the account exists in the system. | + | |
- | + | ||
- | + | ||
=== GetAllAccounts method === | === GetAllAccounts method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |
- | |- | + | Return value: String |
- | |<tt>installPassword</tt> | + | |
- | |Required, installer password for authentication | + | Function description: Gets all of the accounts under this installation. |
- | |} | + | |
- | | + | |
- | Return value: String | + | |
- | + | ||
- | Function description: Gets all of the accounts under this installation. | + | |
=== EditAccount method === | === EditAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''accountID''|Required, account ID| |
- | |- | + | |''accountName''|Required, account name| |
- | |<tt>installPassword</tt> | + | |''externalID''|Reserved field| |
- | |Required, installer password for authentication | + | |''status''|Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE| |
- | |- | + | |''activateDate''|Account activation date| |
- | |<tt>accountID</tt> | + | |''deactivateDate''|Account deactivation date| |
- | |Required, account ID | + | |''manageSecurity''|Can manage security or not| |
- | |- | + | |''manageBrand''|Can manage branding or not| |
- | |<tt>accountName</tt> | + | |''processLocationInfo''|Can process LocationInformation of the map at the account level or not| |
- | |Required, account name | + | |''termsOfUse''|Can apply Terms of Use or not| |
- | |- | + | |''orgLimit''|Organization limit, default is |
- | |<tt>externalID</tt> | + | 1 (unlimited)| |
- | |Reserved field | + | |''monitorLimit''|Monitor limit, default is |
- | |- | + | 1 (unlimited)| |
- | |<tt>status</tt> | + | |''carrierLimit''|Carrier limit, default is |
- | |Required, account status, must be ACTIVE or INACTIVE, default is ACTIVE | + | 1 (unlimited)| |
- | |- | + | |''deviceLimit''|Device limit, default is |
- | |<tt>activateDate</tt> | + | 1 (unlimited)| |
- | |Account activation date | + | |''targetLimit''|Target limit, default is |
- | |- | + | 1 (unlimited)| |
- | |<tt>deactivateDate</tt> | + | |''areaLimit''|Area limit, default is |
- | |Account deactivation date | + | 1 (unlimited)| |
- | |- | + | |''securityPath''|If Two |
- | |<tt>manageSecurity</tt> | + | 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.| |
- | |Can manage security or not | + | |
- | |- | + | Return value: AccountID |
- | |<tt>manageBrand</tt> | + | |
- | |Can manage branding or not | + | Function description: Edits an account at the installer level. |
- | |- | + | |
- | |<tt>processLocationInfo</tt> | + | |
- | |Can process LocationInformation of the map at the account level or not | + | |
- | |- | + | |
- | |<tt>termsOfUse</tt> | + | |
- | |Can apply Terms of Use or not | + | |
- | |- | + | |
- | |<tt>orgLimit</tt> | + | |
- | |Organization limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>monitorLimit</tt> | + | |
- | |Monitor limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>carrierLimit</tt> | + | |
- | |Carrier limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>deviceLimit</tt> | + | |
- | |Device limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>targetLimit</tt> | + | |
- | |Target limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>areaLimit</tt> | + | |
- | |Area limit, default is -1 (unlimited) | + | |
- | |- | + | |
- | |<tt>securityPath</tt> | + | |
- | |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 === | === DeleteAccount method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''accountID''|Required, Account ID| |
- | |- | + | |
- | |<tt>installPassword</tt> | + | Return value: String |
- | |Required, installer password for authentication | + | |
- | |- | + | Function description: Deletes an account in the system at the installer level. |
- | |<tt>accountID</tt> | + | |
- | |Required, Account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes an account in the system at the installer level. | + | |
Line 1636: | Line 919: | ||
==== WSLanguageManager Web Service ==== | ==== WSLanguageManager Web Service ==== | ||
=== GetLanguageList method === | === GetLanguageList method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |
- | |- | + | Return value: String |
- | |<tt>installPassword</tt> | + | |
- | |Required, installer password for authentication | + | Function description: Gets a list of languages available in the installation. |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a list of languages available in the installation. | + | |
=== GetLanguage method === | === GetLanguage method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''languageID''|Required, language ID| |
- | |- | + | |
- | |<tt>installPassword</tt> | + | Return value: String |
- | |Required, installer password for authentication | + | |
- | |- | + | Function description: Gets a language. |
- | |<tt>languageID</tt> | + | |
- | |Required, language ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a language. | + | |
=== GetSystemLanguageList method === | === GetSystemLanguageList method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |
- | |- | + | Return value: String |
- | |<tt>installPassword</tt> | + | |
- | |Required, installer password for authentication | + | Function description: Gets a list of the available system languages. |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Gets a list of the available system languages. | + | |
=== LanguageDelete method === | === LanguageDelete method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''languageID''|Required, language ID| |
- | |- | + | |
- | |<tt>installPassword</tt> | + | Return value: String |
- | |Required, installer password for authentication | + | |
- | |- | + | Function description: Deletes a language. |
- | |<tt>languageID</tt> | + | |
- | |Required, language ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Deletes a language. | + | |
=== CreateLanguage method === | === CreateLanguage method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''languageName''|Required, language name| |
- | |- | + | |''isSystem''|Required| |
- | |<tt>installPassword</tt> | + | |''Status''|Required, status| |
- | |Required, installer password for authentication | + | |
- | |- | + | Return value: String |
- | |<tt>languageName</tt> | + | |
- | |Required, language name | + | Function description: Creates a new language. |
- | |- | + | |
- | |<tt>isSystem</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>Status</tt> | + | |
- | |Required, status | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Creates a new language. | + | |
=== EditLanguage method === | === EditLanguage method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |''installUserName''|Required, installer user name for authentication| |
- | |<tt>installUserName</tt> | + | |''installPassword''|Required, installer password for authentication| |
- | |Required, installer user name for authentication | + | |''languageID''|Required, language ID| |
- | |- | + | |''languageName''|Required, language name| |
- | |<tt>installPassword</tt> | + | |''isSystem''|Required| |
- | |Required, installer password for authentication | + | |''Status''|Required, status| |
- | |- | + | |
- | |<tt>languageID</tt> | + | Return value: String |
- | |Required, language ID | + | |
- | |- | + | Function description: Edits a language. |
- | |<tt>languageName</tt> | + | |
- | |Required, language name | + | |
- | |- | + | |
- | |<tt>isSystem</tt> | + | |
- | |Required | + | |
- | |- | + | |
- | |<tt>Status</tt> | + | |
- | |Required, status | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Edits a language. | + | |
=== SetLanguageForUser method === | === SetLanguageForUser method === | ||
- | Parameters: | + | Parameters: |
- | + | ||
- | {| class="wikitable" cellpadding="3" | + | |
- | |- | + | |
- | |<tt>installUserName</tt> | + | |
- | |Required, installer user name for authentication | + | |
- | |- | + | |
- | |<tt>installPassword</tt> | + | |
- | |Required, installer password for authentication | + | |
- | |- | + | |
- | |<tt>languageID</tt> | + | |
- | |Required, language ID | + | |
- | |- | + | |
- | |<tt>accountID</tt> | + | |
- | |Required, account ID | + | |
- | |} | + | |
- | + | ||
- | Return value: String | + | |
- | + | ||
- | Function description: Sets the language for a user. | + | |
+ | |''installUserName''|Required, installer user name for authentication| | ||
+ | |''installPassword''|Required, installer password for authentication| | ||
+ | |''languageID''|Required, language ID| | ||
+ | |''accountID''|Required, account ID| | ||
+ | Return value: String | ||
+ | Function description: Sets the language for a user. |