This document includes a list of SOAP Service Messages available including their arguments and return values.

GetSessions

SessionKeysResult GetSessions(SessionFilter)

Returns the keys of all sessions matching the provided SessionFilter.

GetSessionInfo

SessionInfoResult GetSessionInfo (SessionFilter)

Returns all available information about sessions matching the provided SessionFilter.

GetSessionStatistics

SessionStatisticsResult GetSessionStatistics (SessionFilter)

Returns statistics for all sessions matching the provided SessionFilter. For ongoing sessions, the statistics represent current progress information. For finished sessions, the statistics are the final values.

GetFileTransfers

FileTransferKeysResult GetFileTransfers (FileTransferFilter)

Returns the keys of all file transfers matching the provided FileTransferFilter.

GetFileTransferInfo

FileTransferInfoResult GetFileTransferInfo (FileTransferFilter)

Returns the absolute names of all files matching the provided FileTransferFilter.

GetFileTransferStatistics

FileTransferStatisticsResult GetFileTransferStatistics (FileTransferFilter)

Returns statistics for all file transfers matching the provided FileTransferFilter. For ongoing transfers, the statistics represent current progress information. For finished transfers, the statistics are the final values.

The file transfer filter extends the session filter (i.e. it includes all of the session filter's criteria). The API first selects all sessions according to the session filter criteria, and then applies the file transfer filter criteria to the transfers belonging those sessions.

GetInfo

InfoResult GetInfo (FileTransferFilter)

Returns all available information for sessions and transfers matching the provided filter. This call is the combination of a GetSessionInfo(SessionFilter) and a GetFileTransferInfo(FileTransferFilter) call in one. Session information is returned only for sessions that match the session-specific filter criteria of the FileTransferFilter. Transfer information is returned for transfers that belong to the previously selected sessions and match the transfer-specific filter criteria of the FileTransferFilter.

GetStatistics

StatisticsResult GetStatistics (FileTransferFilter)

Returns statistics for sessions and transfers matching the provided filter. This call is the combination of a GetSessionStatistics(SessionFilter) and a GetFileTransferStatistics(FileTransferFilter) call in one. Session statistics are returned only for sessions that match the session-specific filter criteria of the FileTransferFilter. Transfer statistics are returned for transfers that belong to the previously selected sessions and match the transfer-specific filter criteria of the FileTransferFilter.

Video player

Video

×