This document includes information on the data types that are defined by the XML schema.

Namespaces

The XML namespaces below are declared and used within the FASPSessionNET-200911 SOAP Web Service.

xsd http://www.w3.org/2001/XMLSchema 
wsdl http://schemas.xmlsoap.org/wsdl/ 
soap http://schemas.xmlsoap.org/wsdl/soap/  
asf http://www.asperasoft.com/xml/faspsession-net/2009/11/FASPSessionNET.wsdl
asfx urn:Aspera:XML:FASPSessionNET:2009/11:Types

Generic Filters

  • string IterationToken
    • Token (returned by previous call) to retrieve the next batch of results. See paged queries.
  • int MaxResults
    • Maximum number of results to return. This value should never exceed 1000. If the expected number of results is greater than MaxResults value, one should use the IterationToken to iterate through the entire result set.

Session Filter

A session filter allows you to restrict the sessions that are returned by the API call.

  • string[] SessionUUID
    • Accepted session UUIDs.
  • string[] SessionStatus
    • Accepted session statuses.
  • string[] ServerAddress
    • Accepted IP addresses or hostnames of the servers.
  • string[] ClientAddress
    • Accepted IP addresses or hostnames of the clients.
  • string[] Cookie
    • Accepted cookies.
  • String CookieFilter
    • A regular expression to match the session's "cookie".
  • string[] JobId
    • Accepted job IDs.
  • enum Direction: {incoming, outgoing}
    • Incoming or outgoing transfer.
  • dateTime MinSessionStartDate
    • Minimum session start date.
  • dateTime MaxSessionStartDate
    • Maximum session start date.
  • dateTime MinSessionEndDate
    • Minimum session end date.
  • dateTime MaxSessionEndtDate
    • Maximum session end date.
  • string[] PrivateKey
    • Accepted private keys (from the PrivateData sections of a Job order)
  • boolean LastSessionOnly
    • In the context of jobs submitted with a retry policy, enabling this filter option will return information on only the last session of a given job instead of all retry attempts. Sessions that do not belong to a job (e.g. sessions started manually on the command line), will be returned as well.

File Transfer Filters

A file transfer filter allows specifying which file transfers are returned by the respective API calls. The file transfer filter extends the session filter. The API first selects all sessions according to the session filter criteria, and then applies the file transfer filter criteria to the transfers belonging to those sessions.

  • int64[] TransferId
    • Accepted transfer IDs
  • string[] TransferStatus
    • Accepted statuses
  • string[] Filepath
    • List of accepted absolute file paths.
  • string FilenameFilter
    • A regular expression that must match a file's full path.
  • dateTime MinTransferStartDate
    • Minimum start date of the transfer.
  • dateTime MaxTransferStartDate
    • Maximum start date of the transfer.
  • dateTime MinTransferEndDate
    • Minimum end date of the transfer.
  • dateTime MaxTransferEndtDate
    • Maximum end date of the transfer.

Query Results

This is the base type for most result values returned by the API.

  • int ResultCount
    • The number of entries returned in this result.
  • int RemainingResultCount
    • The number of remaining results that were filtered out because of the MaxResults filter criteria. Used with paged queries.
  • string IterationToken
    • A token that can be passed as filter criteria in a subsequent API call with an otherwise identical filter. See paged queries.

Session Key Result

This extends Query Results.

  • SessionKey[]

Session Key

  • string UUID
    • The session UUID.
  • string JobId
    • The job ID if this session was initiated through the API, 0 otherwise.

Session Statistics Results

This extends Query Results.

  • SessionStatistics[]

Session Statistics

This extends Session Key

  • string Status
    • Session status.
    • Values: running | paused | completed | cancelled | error | willretry | orphaned
  • int ErrorCode
    • Error code if the session failed.
  • string ErrorDescription
    • Error description if the session failed.
  • int ExpectedFileCount
    • Expected total number of files in this session. Reported only if PreCalc is turned on.
  • int ExpectedDirCount
    • Expected total number of directories in this session. Reported only if PreCalc is turned on.
  • long ExpectedByteCount
    • Expected total number bytes that will be transferred in this session. Reported only if PreCalc is turned on.
  • int FileCount
    • Total number of complete, failed, and transferring files.
  • int FilesComplete
    • Number of files that have been successfully transferred.
  • int FilesFailed
    • Number of files that have failed to transfer.
  • int FilesTransferring
    • Number of files currently being transferred.
  • long BytesWritten
    • Total number of bytes that have been written to disk at the destination.
  • long BytesTransferred
    • Total number of bytes that have been transferred during the session.
  • long BytesLost
    • Total number of bytes that have been lost during the session.
  • long Elapsed
    • Running time of the session, in microseconds.
  • int NetworkDelay
    • Current network delay in milliseconds.
  • string RateInfo
    • Unused

Session Info Results

This extends Query Results

  • SessionInfo[]

Session Info

This extends Session Statistics

  • dateTime StartDate
    • Date and time when the session started (UTC).
  • dateTime EndDate
    • Date and time when the session ended (UTC).
  • string Token
    • Token used for external authorization.
  • string Cookie
    • Arbitrary field used for application-specific requirements.
  • enum Direction
    • The direction of the transfer.
    • Values: incoming | outgoing
  • string ServerEndpoint
    • Indicates which endpoint is acting as the server.
    • The value of this element will either be Local or Remote, indicating which endpoint is acting as the server.
    • Values: Local | Remote
  • string ServerAddress
    • IP address or host name of the system.
  • int ServerSSHPort
    • SSH (TCP) port over which the transfer was initiated.
  • int ServerFASPPort
    • fasp (UDP) port over which data is being transferred.
  • string User
    • The user used to authenticate the session on the server.
  • string ClientEndpoint
    • Indicates which endpoint is acting as the client. The value of this element will either be Local or Remote, indicating which endpoint is acting as the client.
    • Values: Local | Remote
  • string ClientAddress
    • IP address or host name of the system.
  • int ClientFASPPort
    • fasp (UDP) port over which data is being transferred.
  • string RatePolicy
    • Indicates the rate policy being utilized by the transfer.
    • Values: Fixed | High | Fair | Trickle
  • int TargetRate
    • Target rate of data transmission, in Kbps.
  • int MinimumRate
    • Minimum rate of data transmission, in Kbps.
  • int BandwidthCap
    • Cap on data transfer rates, in Kbps.
    • If empty or 0, will use default of 10Mbps.
  • string EncryptionCipher
    • Indicates the encryption cipher being used to encrypt data during transfer.
    • Values: None | AES128
  • int JobRetryCount
    • The Xth attempt to successfully complete the transfer job. 0 for the initial session or if the session was not initiated through a transfer job.
  • int JobMaxRetries
    • The maximum number of retries to successfully complete job or 0 if the session was not initiated through a transfer job.
  • string PrivateKey
    • The private key from the PrivateData section of a transfer job.
  • string SourcePath
    • Submitted source path.
  • string DestinationPath
    • Submitted destination path.
  • int VLinkId
    • Unused.

File Transfer Key Result

This extends Query Results

  • FileTransferKey[]

File Transfer Keys

  • string SessionUUID
    • The UUID of the session that the transfer belongs to.
  • string Path
    • The full path of the transferred file.
  • long LocalId
    • The local transfer ID
  • string UUID
    • Unused.

File Transfer Statistics Results

This extends Query Results

  • FileTransferStatistics[]

File Transfer Statistics

This extends File Transfer Keys

  • string Status
    • File transfer status.
    • Values: running | completed | error
  • int ErrorCode
    • Error code if the transfer failed.
  • string ErrorDescription
    • Error description if the transfer failed.
  • long size
    • The file size.
  • long StartOffset
    • Byte position at which the transfer started. Usually, this will be equal to 0. However, in the case of a resumed transfer, this indicates the file offset from where the transfer was resumed.
  • long BytesWritten
    • Number of bytes written to the destination file.
  • long BytesContiguous
    • Number of contiguous bytes written to the destination file.
  • long BytesLost
    • Number of bytes lost on the network (and retransmitted).
  • long Elapsed
    • Running time of the transfer in micro seconds.

File Transfer Info Results

This extends Query Results

  • FileTransferInfo[]

File Transfer Info

This extends File Transfer Statistics

  • dateTime StartDate
    • Date and time when the transfer started (UTC).
  • dateTime EndDate
    • Date and time when the transfer ended (UTC).
  • string Checksum
    • Checksum calculated from file data.
  • string ChecksumType
    • Type of checksum.
  • string FileType
    • Unused.
  • string Action
    • Unused.
  • string ContentProtection
    • Unused.

Info Results

This extends Query Results

  • SessionInfo[]
  • FileTransferInfo[]

Statistics Results

This extends Query Results

  • SessionStatistics[]
  • FileTransferStatistics[]

Filter Changed Error

This error is returned if a query attempts to use a filter with an invalid iteration token. An iteration token is always linked to the filter that was used in the initial call that retrieved it. Repeating a query with the iteration token from a previous call requires that the filter remains otherwise unchanged.

Video player

Video

×