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-200601 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/2006/01/FASPSessionNET.wsdl
asfx urn:Aspera:XML:FASPSessionNET:2006/01:Types

AggregateStatisticsType

<asfx:AggregateStatisticsType>

Aggregate statistics related to the transfer.

  • xsd:unsignedInt FileCount - Total number of complete, failed, and transferring files.
  • xsd:unsignedInt FilesComplete - Number of file that have been successfully transferred.
  • xsd:unsignedInt FilesFailed - Number of file that have failed to transfer.
  • xsd:unsignedInt FilesTransferring - Number of files currently being transferred.
  • xsd:unsignedLong BytesWritten - Total number of bytes that have been written to disk.
  • xsd:unsignedLong BytesTransferred - Total number of bytes that have been transferred during the session.
  • xsd:unsignedLong BytesLost - Total number of bytes that have been lost during the session.
  • xsd:unsignedLong uSecondsElapsed - Running time of the session, in microseconds.

ApplicationDataType

<asfx:ApplicationDataType>

Application-level data that will be carried by a FASP session.

  • xsd:string Token - A token used for external authorization.
  • xsd:string Cookie - An arbitrary field used for application-specific requirements.

ClientType

<asfx:ClientType>

Information pertaining to the client endpoint.

  • xsd:string Endpoint - Indicates which endpoint is acting as the client.
    • Valid Values: Local | Remote
  • xsd:string Address - IP address or host name of the system.
  • xsd:unsignedShort FASPPort - FASP (UDP) port over which data is being transferred.

EndportReferenceType

<asfx:EndpointReferenceType>

Represents a system acting as a web services endpoint.

  • xsd:string Address - Uniform Resource Identifier (URI) of the endpoint.
  • xsd:string Action - SOAP action to carry in any messages sent to the system.
    • The SOAP action will vary depending on the web services framework being used. In some cases, it is not required at all. When it is required, it is typically used to route the request to the appropriate handler.

ErrorType

<asfx:ErrorType>

Indicates session error details.

  • xsd:int Code - Error code indicating the reason the session failed. As long as the session is successful, this value will be 0.
  • xsd:string Description - Detiled description of the error that occurred.

FileStatisticsType

<asfx:FileStatisticsType>

File statistics related to the transfer.

  • xsd:string Name - Name of the currently transferring file.
  • xsd:unsignedLong Size - Size, in bytes, of the currently transferring file.
  • xsd:unsignedLong BytesWritten - Total number of bytes that have been written to disk.
  • xsd:unsignedLong BytesContiguous - Total number of bytes that are contiguous on disk.
  • xsd:unsignedLong BytesLost - Total number of bytes that have been lost during the session.
  • xsd:unsignedLong StartByte - The position, in bytes, where the file was started for this session.  Usually, this will be equal to 0. However, in the case of a resumed transfer, this will indicate the the file offset from where the transfer was resumed.
  • xsd:unsignedLong uSecondsElapsed - Running time of the transfer for the current file, in microseconds.
  • xsd:int ErrorCode - Error code indicating the reason the file failed to transfer. As long as the file is being sucessfully transferred, this value will be 0.
  • xsd:string ErrorDescription - Detiled description of the error that occurred.

NetworkSatisticsType

<asfx:NetworkStatisticsType>

Network statistics related to the transfer.

xsd:unsignedInt Delay - This element is currently unused.

xsd:float Efficiency - This element is currently unused.

OperationType

<asfx:OperationType>

Indicates the transfer operation being carried out.

  • xsd:string Operation - Indicates the type of operation. The value of this element will either be Download or Upload, depending on the direction of the transfer. The direction is always determined by viewing the transfer from the perspective of the client.
    • Valid Values: Download | Upload
  • xsd:string SourcePath - This element is unused.
  • xsd:string DestinationPath - This element is unused.

RateParametersType

<asfx:RateParametersType>

Indicates rate-related information pertaining to the transfer.

  • xsd:string Policy - Indicates the rate policy being utilized by the transfer.
    • Valid Values: Fixed | Fair | Trickle 
  • xsd:unsignedInt TargetRate - The target rate of data transmission, in Kbps.
  • xsd:unsignedInt MinimumRate - The minimum rate of data transmission, in Kbps.
  • xsd:unsignedInt BandwidthCap - A cap on data transfer rates, in Kbps.

SecurityParametersType

<asfx:SecurityParametersType>

Indicates security-related pertaining to the transfer.

  • xsd:string EncryptionCipher - Indicates the encryption cipher being used to encrypt data during transfer.
    • Valid Values: None | AES128

ServerType

<asfx:ServerType>

Information pertaining to the server endpoint. 

  • xsd:string Endpoint - 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.
    • Valid Values: Local | Remote 
  • xsd:string Address - IP address or host name of the system. 
  • xsd:unsignedShort SSHPort - SSH (TCP) port over which the transfer was initiated.
  • xsd:unsignedShort FASPPort - FASP (UDP) port over which data is being transferred.
  • xsd:string User - The user used to authenticate the transfer.

SessionType

<asfx:SessionType>

Indicates information about a FASP session. 

  • xsd:string SessionID - An identifier that uniquely identifies the session.
  • asfx:ApplicationDataType ApplicationData - Application-level data carried by the session.
  • asfx:OperationType Operation - Operation being performed by the session.
  • asfx:ServerType Server - Server endpoint participating in the session.
  • asfx:ClientType Client - Client endpoint participating in the session.
  • asfx:RateParametersType RateParameters - Rate parameters used by the session.
  • asfx:SecurityParametersType SecurityParameters - Security parameters used by the session.
  • asfx:StatisticsType Statistics - Statistics obtained during the session. 
  • asfx:ErrorType Error - Error details for the session.

StatisticsType

<asfx:StatisticsType>

Statistics related to the transfer.

  • asfx:AggregateStatisticsType Aggregate - Statistics aggregated accross all files transferred during the session.
  • asfx:FileStatisticsType File - Statistics about the current file being transferred during the session.
  • asfx:NetworkStatisticsType Network - Network statistics collected during the session.

SubscriptionResourceType

<asfx:SubscriptionResourceType>

A subscription resource established by an endpoint. 

  • xsd:string ID - An identifier used to uniquely identify the subscription.
  • asfx:EndpointReferenceType Observer - An endpoint that will receive notifications about events occuring to the resource subscribed to. 
  • asfx:TopicExpressionType Topics - A list of topics that the observer is interested in receiving notifications about.
  • xsd:unsignedInt TimeRemaining - The remaining time, in seconds, before the subscription will expire.

TopicExpressionType

<asfx:TopicExpressionType>

Contains an array of topics. 

  • ArrayOf xsd:string Topic - An array of strings that indicate individual topics.

SubscriptionNotFoundFaultType

<asfx:SubscriptionNotFoundFaultType>

A fault indicating that the subscription was not found. 

  • xsd:string SubscriptionID - Subscription identifier.

SessionNotFoundFaultType

<asfx:SessionNotFoundFaultType>

A fault indicating that the session was not found. 

  • xsd:string SessionID - Session identifier.
Video player

Video

×