Session Related Service Messages

SetRateParameters

void SetRateParameters( xsd:string SessionID, asfx:RateParametersType RateParameters ) 

Sets the rate parameters of a FASP session.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • RateParameters: Rate parameters to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetRateParameters

SetPolicy

void SetPolicy( xsd:string SessionID, xsd:string Policy ) 

Sets the rate parameters of a FASP session. Valid values for the Policy argument are Fixed, Fair, and Trickle.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • Policy: Rate policy to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetPolicy

SetTargetRate

void SetTargetRate( xsd:string SessionID, xsd:unsignedInt TargetRate ) 

Sets the target rate of a FASP session.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • TargetRate: Target rate, in Kbps, to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetTargetRate

SetMinimumRate

void SetMinimumRate( xsd:string SessionID, xsd:unsignedInt MinimumRate ) 

Sets the minimum rate of a FASP session.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • MinimumRate: Minimum rate, in Kbps, to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetMinimumRate

SetBandwidthCap

void SetBandwidthCap( xsd:string SessionID, xsd:unsignedInt BandwidthCap ) 

Sets the bandwidth cap of a FASP session.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • BandwidthCap: Bandwidth cap, in Kbps, to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetBandwidthCap

Job Related Service Messages

ListJobs

ArrayOf xsd:string ListJobs()

List the active Aspera.IScpTransfer jobs.

Return

  • An array of job IDs.

SOAP Action

  • IScpTransferNET-200604#ListJobs

CancelJob

void CancelJob( xsd:string JobID )

Cancels an Aspera.IScpTransfer job.

Parameters

  • JobID: An identifier of the job to cancel.

Faults

  • iscp:JobNotFoundFault

SOAP Action

  • IScpTransferNET-200604#Cancel
Video player

Video

×