Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Methods for the SRC Volume Tracking Application SOAP Interface

    This topic describes the methods associated with the Volume Tracking Application SOAP interface and provides information additional to that in the Web Services Definition Language (WSDL) file.

    openAccount

    • Open an account and optionally create a balance change for the account as part of one database transaction.
    • Arguments:
      • accountData—Account data object carrying account information.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    closeAccount

    • Close an account and optionally record the change to the balance change table as part of one database transaction. This method only sets the status of the account to closed. If the account is already closed, do nothing.
    • Arguments:
      • subscriberID—ID of the subscriber to whom the account belongs.
      • accountName—Name of the account to be closed.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    closeAccountsOfSubscriber

    • Close accounts for a subscriber and optionally create balance changes for the accounts as part of one database transaction. This method only sets the status of the accounts to closed. Do nothing for closed accounts.
    • Arguments:
      • subscriberID—ID of the subscriber to whom the account belongs.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    closeAccountsByName

    • Close the named accounts for all subscribers. This method only sets the status of the accounts to closed. Do nothing for closed accounts.
    • Arguments:
      • accountName—Name of the account to be closed.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    changeStatus

    • Change the status of a specified account and optionally create a balance change record as part of one database transaction. This method does not perform any status check. It can be used to set a closed account to active again.
    • Arguments:
      • subscriberID—ID of the subscriber to whom the account belongs.
      • accountName—Name of the account.
      • status—New status of the account.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    changeBalance

    • Add the given amount to the balance (decreasing it if the amount is negative) and optionally create a balance change record for the account as part of one database transaction.
    • Arguments:
      • subscriberID—ID of the subscriber to whom the account belongs.
      • accountName—Name of the account.
      • status—New status of the account.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    topUpBalance

    • Top up the named accounts with the given amount for all subscribers. This method optionally creates balance change records for the accounts as part of one database transaction. Do nothing for closed accounts.
    • Arguments:
      • subscriberID—ID of the subscriber to be topped up.
      • accountName—Name of the account to be topped up.
      • amount—Amount to be added to the balance of each account.
      • date—Date that the account’s lastupdatetime field, in milliseconds since January 1, 1970 UTC, is to be set.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    topUpBalance

    • Top up the named accounts with the given amount for all subscribers. This method optionally creates balance change records for the accounts as part of one database transaction. Do nothing for closed accounts.
    • Arguments:
      • subscriberID—ID of the subscriber to be topped up.
      • accountName—Name of the account to be topped up.
      • status—Status of the account to be topped up.
      • amount—Amount to be added to the balance of each account.
      • date—Date that the account’s lastupdatetime field, in milliseconds since January 1, 1970 UTC, is to be set.
      • writeBalanceChange—If true, an account balance change record is written to the database.
      • description—Description of the account balance change record.
      • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getAccount

    getAccountsOfSubscriber

    • Search for accounts with the given status for a subscriber.
    • Arguments:
      • subscriberID—ID of the subscriber to whom the account belongs.
      • status—Account status. If no status is specified, it returns all accounts for the subscriber regardless of their statuses.
    • Expected output—Collection of AccountData objects.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getAccountsByName

    • Search for accounts by name and status.
    • Arguments:
      • accountName—Name of the account.
      • status—Account status. If no status is specified, it returns all accounts for the subscriber regardless of their statuses.
    • Expected output—Collection of AccountData objects.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getBalanceChanges

    • Search for balance changes in a given time period for an account. If both subscriberID and accountName are null, it returns balance changes in a time period for all accounts. If both start and end times are zero, it returns all balance changes for a given account.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • accountName—Name of the account.
      • start—Start time of the period to query.
      • end—End time of the period to query.
    • Expected output—Collection of BalanceChangeData objects.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getSessionBalanceChange

    • Given a session ID and a qualifier, return the session balance change record for a named account.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • accountName—Name of the account.
      • sessionId—ID of the session to query.
      • qualifier—Qualifier of the session to query.
    • Expected output—SessionBalanceChangeData object.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getSessionBalanceChange

    • Given a session ID and a qualifier, return the session balance change value objects.
    • Arguments:
      • sessionId—ID of the session to query.
      • qualifier—Qualifier of the session to query.
    • Expected output—Collection of SessionBalanceChangeData objects.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getSessionBalanceChanges

    • Search for session balance changes in a given time period for an account. If subscriberID and accountName are null, it returns session balance changes in a time period for all accounts. If the start and end times are zero, it returns session balance changes for a given account.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • accountName—Name of the account.
      • start—Start time of the period to query.
      • end—End time of the period to query.
    • Expected output—Collection of SessionBalanceChangeData objects.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getSessionBalanceChanges

    • Given a session ID and qualifier, get the related session balance changes on the named accounts.
    • Arguments:
      • sessionId—ID of the session to query.
      • qualifier—Qualifier of the session to query.
      • subscriberID—ID of the subscriber.
      • accountNames—Names of the accounts.
    • Expected output—Map from the account name to the SessionBalanceChangeData object. If accountNames is null, it returns the related session balance change records on all accounts for the subscriber.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getAllBalanceChanges

    • Search for balance changes and session balance changes in a given time period for an account. This method converts the balance changes to session balance changes and merges the balance changes and session balance changes.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • accountName—Name of the account.
      • start—Start time of the period to query.
      • end—End time of the period to query.
    • Expected output—Collection of SessionBalanceChangeData and BalanceChangeData sorted by date field.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    terminateSessions

    getSession

    • Given a subscriber ID, session ID, and a qualifier, return the session value object.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • sessionId—ID of the session to query.
      • qualifier—Qualifier of the session to query.
    • Expected output—SessionData of the session that is found.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getSessions

    • Given the session ID and status, return a collection of session value objects. If no status is specified, it returns sessions with the session ID regardless of their status.
    • Arguments:
      • sessionId—ID of the session to query.
      • status—Status of the session to query.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    getSessions

    • Get sessions with the given status starting within a given time period for a subscriber. If the start and end times are zero, it returns sessions with the given status for the subscriber. If status is null, it returns all the relevant sessions regardless of their status.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • status—Status of the session to query.
      • start—Start time of the period to query.
      • end—End time of the period to query.
    • Expected output—Collection of SessionData objects.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    deleteAccount

    deleteAccountsOfSubscriber

    deleteAccountsByName

    deleteBalanceChanges

    • Delete balance changes in a given time period for a set of accounts. If no account names are specified, it deletes balance changes in the given time period on all subscriber accounts. If no time period is specified, it deletes all balance changes for the set of accounts. If no account names or time period are specified, it deletes all balance changes on all subscriber accounts. If both subscriberID and accountNames are not specified, it deletes the balance changes in the given time period for all subscribers and accounts.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • accountNames—Names of accounts.
      • start—Start time of the period to query.
      • end—End time of the period to query.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    deleteSessionBalanceChanges

    • Delete session balance changes in a given time period for a set of accounts. If no account names are specified, it deletes session balance changes in the given time period on all subscriber accounts. If no time period is specified, it deletes all session balance changes for the set of accounts. If no account names or time period are specified, it deletes all balance changes on all the subscriber accounts.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • accountNames—Names of accounts.
      • start—Start time of the period to query.
      • end—End time of the period to query.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    deleteSession

    deleteSessions

    • Given a session ID, delete the related sessions. Only closed sessions are deleted. For each unclosed session, an error message is logged in the debug log.
    • Arguments:
      • sessionId—ID of the session to query.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    deleteSessions

    • Delete sessions starting within a given time period for a subscriber. If no time period is specified, it deletes all sessions for the subscriber. If no subscriber is specified, it deletes sessions in a given time period for all subscribers. Only closed sessions are deleted.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • start—Start time of the period to query.
      • end—End time of the period to query.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    cleanup

    • Clean up accounts whose last update time is earlier than the given time and whose status is equal to the given status. If no subscriber is specified, it performs the cleanup for all subscribers. If no status is specified, it only deletes closed accounts.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • time—Earliest last update time of accounts to clean up.
      • status—Status of the accounts to clean up.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    cleanup

    • Clean up sessions, sessionBalanceChanges, and balanceChanges whose last update time is earlier than the given time. If no subscriber is specified, it performs the cleanup for all subscribers.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • time—Earliest last update time of accounts to clean up.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    updateAccounts

    • Modify accounts selected by subscriberId, accountName, and accountStatus arguments. In those selected accounts, it:
      • Overwrites the account status with newStatus (if newStatus is not null).
      • Overwrites the account balance with balanceAmount (if balanceAmount is not null and amountIsDelta is false).
      • Changes the account balance by balanceAmount (if balanceAmount is not null and amountIsDelta is true).
      • If the balanceChangeDescription is not null, also creates a balance change record containing the specified description, the current time, and the amount by which the account balance was changed.
      • If terminateSessions is true, generates a Callback:TERMINATESESSIONS event for every subscriber associated with the specified accounts.
    • Arguments:
      • subscriberID—ID of the subscriber.
      • accountName—Name of the account.
      • accountStatus—Status of the account.
      • newStatus—New status of the account.
      • balanceAmount—Amount to set the balance to.
      • amountIsDelta—If true, sets the balance to the value specified by balanceAmount.
      • balanceChangeDescription—Description of the account balance change record.
      • terminateSessions—If true, generates a Callback:TERMINATESESSIONS event for every subscriber associated with the specified accounts.
    • Expected output—Message describing the number of accounts that matched the subscriberId, accountName, and accountStatus arguments, the number of subscribers for those accounts, and the number of accounts that were modified.
    • SOAP fault codes—See SOAP Fault Codes for the SRC Volume Tracking Application.

    Modified: 2016-12-29