SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v2/fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/GetELinkDefaults2"
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
int
string
string
string
string
int
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v2/fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
Response xmlns="http://api.filesanywhere.com/">
string
int
string
string
string
string
int
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
Response
GetELinkDefaultsResult2v2
GetELinkDefaultsResult2v2 Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetELinkDefaults2 method was executed. If the GetELinkDefaults2 call was successful, the ErrorMessage is blank
|
ShareDays
|
Integer
|
The number of days the link will be active.
|
FlagLog
|
String
|
Flag indicating to log access to the link.
|
FlagEmail
|
String
|
Flag indicating to send an email notification of the link to the recipients.
|
FlagMediaView
|
String
|
Flag indicating the view type to display by default.
|
FlagPlayOptions
|
String
|
Flag indicating the play options.
|
DownloadLimit
|
String
|
The maximum number of times files can be downloaded.
|
FlagViewOnly
|
String
|
Flag specifying whether to allow downloads or not.
|
FlagWatermark
|
String
|
Flag indicating whether or not to generate a watermark.
|
WatermarkCenter
|
String
|
The watermark text for the center.
|
WatermarkBottom
|
String
|
The watermark text for the bottom.
|
FlagEmailFromSystem
|
String
|
Flag indicating to send the notification from the system email account or the user’s email account.
|
EmailSubject
|
String
|
Email notification subject.
|
EmailBody
|
String
|
Email notification body.
|
FlagAttachment
|
String
|
|
FlagReadReceipt
|
String
|
Flag indicating to send a read receipt when the notification email is read.
|
FlagCoverPage
|
String
|
Flag indicating whether or not to use a cover page.
|
CoverPageTitle
|
String
|
The title for the cover page.
|
CoverPageMessage
|
String
|
The message body for the cover page.
|
ApprovalText
|
String
|
Text to display to require approval from the user.
|
InputPromptText
|
String
|
Text to display to retrieve input from the user.
|
SignaturePromptText
|
String
|
Text to display to retrieve a signature from the user.
|
GetELinkDefaults3
Syntax
GetELinkDefaults3Result = GetELinkDefaults3(Token)
Usage
Use the GetELinkDefaults3 method to retrieve the default settings for creating a new FileShare link.
The following parameters are needed to make the GetELinkDefaults3 call:
-
Token. (The Token ID returned by the last AccountLogin call).
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v2/fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/GetELinkDefaults3"
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
int
string
string
string
string
int
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
boolean
boolean
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v2/fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
int
string
string
string
string
int
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
boolean
boolean
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
Response
GetELinkDefaultsResult3v2
GetELinkDefaultsResult3v2 Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetELinkDefaults2 method was executed. If the GetELinkDefaults2 call was successful, the ErrorMessage is blank
|
ShareDays
|
Integer
|
The number of days the link will be active.
|
FlagLog
|
String
|
Flag indicating to log access to the link.
|
FlagEmail
|
String
|
Flag indicating to send an email notification of the link to the recipients.
|
FlagMediaView
|
String
|
Flag indicating the view type to display by default.
|
FlagPlayOptions
|
String
|
Flag indicating the play options.
|
DownloadLimit
|
String
|
The maximum number of times files can be downloaded.
|
FlagViewOnly
|
String
|
Flag specifying whether to allow downloads or not.
|
FlagWatermark
|
String
|
Flag indicating whether or not to generate a watermark.
|
WatermarkCenter
|
String
|
The watermark text for the center.
|
WatermarkBottom
|
String
|
The watermark text for the bottom.
|
FlagEmailFromSystem
|
String
|
Flag indicating to send the notification from the system email account or the user’s email account.
|
EmailSubject
|
String
|
Email notification subject.
|
EmailBody
|
String
|
Email notification body.
|
FlagAttachment
|
String
|
|
FlagReadReceipt
|
String
|
Flag indicating to send a read receipt when the notification email is read.
|
FlagCoverPage
|
String
|
Flag indicating whether or not to use a cover page.
|
CoverPageTitle
|
String
|
The title for the cover page.
|
CoverPageMessage
|
String
|
The message body for the cover page.
|
ApprovalText
|
String
|
Text to display to require approval from the user.
|
InputPromptText
|
String
|
Text to display to retrieve input from the user.
|
SignaturePromptText
|
String
|
Text to display to retrieve a signature from the user.
|
ShowEmailAddress
|
Boolean
|
Flag indicating to show the name of the owner of the fileshare.
|
ShowName
|
Boolean
|
Flag indicating to show the email address of the owner of the fileshare.
|
Share with your friends: | 
