Api specifications
Download 5.13 Mb.
|
SOAP 1.2The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. POST /FACORPAPI/FAWAPI.asmx HTTP/1.1 Host: api.filesanywhere.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length Sample Visual Basic.Net Code Private Sub SetProfileImage() Dim SetProfileImageParameter As New FAWAPI.SetProfileImageParameter() SetProfileImageParameter.FileName = sFileName SetProfileImageParameter.FileData = bFileData Dim SetProfileImageResult As FAWAPI.SetProfileImageResult = FAWAPI.SetProfileImage(sToken, SetProfileImageParameter)
MsgBox SetProfileImageResult.ErrorMessage End If SetProfileImageResult = Nothing FAWAPI = Nothing End Sub
Parameters Properties
Response SetProfileImageResult SetProfileImageResult Properties
SendFileShareLink Shares files and folders securely with anyone, even non-members, using a web URL link. An email is sent by the system containing an encrypted web link, which when clicked by the recipient, will prompt them to download the shared files and folders, or view them online, according to the parameters (options) given when calling the function. If the 'RecipientEmails' parameter is equal to the value 'GENERALLINK', the function will return the FileShare URL Link without sending an email. This link can be used directly from any location, and the link behaves exactly like the way it does when sent in an email. Syntax SendFileShareLinkResult= SendFileShareLink(Token, FileShareLinkItems,RecipientEmails,FolderView,ShareDays,RecordFileHistoryLog,NotifyDownloadByEmail,SendReadReceipt,LinkInFileAttachment,ReadOnlyPermission, DownloadLimit,DisplayWatermark,WatermarkAtCenter,WatermarkAtBottom,UserEmailAsSender,EmailSubject,EmailBody,LinkPassWord,FlagCoverPage,CoverPageTitle,CoverPageMessage,ApprovalText,InputPromptMessage,SignaturePrompt,PlayOptions,DisplayUserName,DisplayEmailAddress,DisplayComments) Usage Use the SendFileShareLink method to create and send a FileShare link. The following parameters are needed to make the SendFileShareLink 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 /FACORPAPI/FAWAPI.asmx HTTP/1.1 Host: api.filesanywhere.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://api.filesanywhere.com/SendFileShareLink"
string
string
string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length
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 /FACORPAPI/FAWAPI.asmx HTTP/1.1 Host: api.filesanywhere.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length
string
string
string
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length
Request Arguments
Response SendFileShareLinkResult SendFileShareLinkResult Properties
REST API Service Description For a formal definition, please review the Service Description at: https://restapi.filesanywhere.com/FAWAPI.svc REST API Operations The following operations are supported. For a formal definition, please review the Service Description.
Let’s Get Started! This section helps you in getting started with using the REST API. It tells you what you need in order to start using the REST API in your development environment. It includes the following steps:
Sign up for a Filesanywhere account using FAWAPI Using FAWAPI web service, invoke AccountLogin method, which will return Token number. Description of AccountLogin method can be found in below URL. https://api.filesanywhere.com/v2/fawapi.asmx?op=AccountLogin Use this token to invoke all REST API methods. Obtain the REST API WSDL The WSDL file is available at https://restapi.filesanywhere.com/FAWAPI.svc?singleWsdl REST API Calls DownloadFile This method returns back a stream using which you can download a file. Syntax HTTPs Request POST: /DownloadFile HOST: https://restapi.filesanywhere.com/FAWAPI.svc Filesanywhere-API-Arg : {"ItemPath":"","Token":""} Invoke this Host URL, and post the argument ItemPath and Token. Usage Use the DownloadFile method to get a stream using which you can download a file. The following parameters are needed to make the DownloadFile call:
Sample C#.Net Code private void DownloadRequest(string sToken, string FilePath) { String sWCFURL = "https://restapi.filesanywhere.com/FAWAPI.svc/DownloadFile"; //DownloadRequest is an object which contains Token and ItemPath as a //properties which serialized and passed to REST API. DownloadRequest drequest = new DownloadRequest { Token = sToken, ItemPath = FilePath }; var request = (HttpWebRequest)WebRequest.Create(sWCFURL); request.ContentType = "text/json"; request.Method = "POST"; DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(DownloadRequest)); if (drequest != null) { using (var streamWriter = new StreamWriter(request.GetRequestStream())) { MemoryStream mem = new MemoryStream(); ser.WriteObject(mem, drequest); string data = Encoding.UTF8.GetString(mem.ToArray(), 0, (int)mem.Length); streamWriter.Write(data); } } HttpWebResponse HttpResponse = null; try { HttpResponse = (HttpWebResponse)request.GetResponse(); if (HttpResponse.StatusCode == HttpStatusCode.OK) { using (Stream iStream = HttpResponse.GetResponseStream()) { string sDestPath = “D:\\” + Path.GetFileName(FilePath); FileStream destStream = File.Create(sDestPath); iStream.CopyTo(destStream); destStream.Close(); } } else {//Error Message txtOutput.Text = new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd(); } } catch (WebException error) { HttpResponse = (HttpWebResponse)error.Response; } } public class DownloadRequest { public string ItemPath { get; set; } public string Token { get; set; } } Request Arguments Request arguments should be passed as a JSON serialized string e.g.: {"ItemPath":"\\PATNIDEV\\test.docx","Token":"E9BVY5YK8C1Y2ZCS97KKWTJ095IP9XVT7Z597E20C910"}
Response If the file is available to be downloaded, the response will be a HttpStatus code 200 OK. In case of status code OK, user can save the Stream to a local destination path, as mentioned in above sample code. In case of validation error, it will return status code 406 (Not acceptable), and in case of warning exception it will return 417 (Expectation failed) To get the error message, the stream needs to be read into a string object, as in the c# code below: Error = new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd(); ZipDownloadFileOrFolder This method returns back a stream from which a zip file containing a file or a folder can be downloaded. If the return HttpStatus code is 202 (Accepted), it means that the zip process is in progress, and, this method can be called repeatedly until the zip processing is complete. Making subsequent calls with the same parameters will query the status of the intial zip request process. Syntax HTTP Request POST: /ZipDownloadFileOrFolder HOST: https://restapi.filesanywhere.com/FAWAPI.svc Filesanywhere-API-Arg : {"ItemPath":"","Token":""} Invoke this Host URL, and post the argument ItemPath and Token. Usage Use the ZipDownloadFileOrFolder method to download a zip file containing a file or a folder. The following parameters are needed to make the ZipDownloadFileOrFolder call:
Sample C#.Net Code private void ZipDownloadRequest(string sToken, string FilePath) { String sWCFURL = " https://restapi.filesanywhere.com/FAWAPI.svc/ZipDownloadFileOrFolder" //DownloadRequest is an object which contains Token and ItemPath as a //properties which serialized and passed to REST API. DownloadRequest drequest = new DownloadRequest { Token = sToken, ItemPath = FilePath }; var request = (HttpWebRequest)WebRequest.Create(sWCFURL); request.ContentType = "text/json"; request.Method = "POST"; DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(DownloadRequest)); if (drequest != null) { using (var streamWriter = new StreamWriter(request.GetRequestStream())) { MemoryStream mem = new MemoryStream(); ser.WriteObject(mem, drequest); string data = Encoding.UTF8.GetString(mem.ToArray(), 0, (int)mem.Length); streamWriter.Write(data); } } HttpWebResponse HttpResponse = null; do { _response = (HttpWebResponse)request.GetResponse(); if (_response.StatusCode == HttpStatusCode.OK) { using (Stream iStream = _response.GetResponseStream()) { if (iStream == null) return; string sDestPath = sDestPath = “D:\\FileName.zip”; FileStream destStream = File.Create(sDestPath); iStream.CopyTo(destStream); destStream.Close(); txtOutput.Text = "Zip file downloaded successfully at location " + txtDestPath.Text; } return; } else if (_response.StatusCode == HttpStatusCode.Accepted) { txtOutput.Text = "Processing Zip download id =" + new StreamReader(_response.GetResponseStream()).ReadToEnd(); } else { txtOutput.Text = "Error =" + new StreamReader(_response.GetResponseStream()).ReadToEnd(); break; } request = CreateRequest(sWCFURL1); } while (_response.StatusCode == HttpStatusCode.OK); _response = null; } public class DownloadRequest { public string ItemPath { get; set; } public string Token { get; set; } } Request Arguments Request arguments should be passed as a JSON serialized string e.g.: {"ItemPath":"\\PATNIDEV\\test\\","Token":"E9BVY5YK8C1Y2ZCS97KKWTJ095IP9XVT7Z597E20C910"}
Response If the file is available to be downloaded, the response will be a HttpStatus code 200 OK. In case of status code OK, user can save the Stream to a local destination path, as mentioned in above c# code. If zipping is in progress, then it will return status code 202 (Accepted). In case of validation error, it will return status code 406 (Not acceptable), and in case of warning exception it will return 417 (Expectation failed) To get the error message, the stream needs to be read into a string object, as in the c# code below: Error = new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd();
This method performs checkout on a file and then returns back a stream using which you can download the file. Syntax HTTPs Request POST: /DownloadWithCheckout HOST: https://restapi.filesanywhere.com/FAWAPI.svc Filesanywhere-API-Arg : {"Comments":"","EmailReport":true,"ItemPath":"","Recipients":"","Token":""} Invoke this Host URL, and post the argument ItemPath, Token, Comments, EmailReport, Recipients. Usage Use the DownloadWithCheckout method to checkout a file and get a stream using which you can download the file. The following parameters are needed to make the DownloadFile call:
Sample C#.Net Code private void DownloadRequest(string sToken, string FilePath) { String sWCFURL = "https://restapi.filesanywhere.com/FAWAPI.svc/DownloadWithCheckout" //DownloadRequest is an object which contains Token and ItemPath as a //properties which serialized and passed to REST API. DownloadCheckoutRequest drequest = new DownloadCheckoutRequest { Token = sToken, ItemPath = txtFilePath.Text, Comments = txtComments.Text, EmailReport = chkSendEmail.Checked, Recipients = txtRecipients.Text }; var request = (HttpWebRequest)WebRequest.Create(sWCFURL); request.ContentType = "text/json"; request.Method = "POST"; DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(DownloadCheckoutRequest)); if (drequest != null) { using (var streamWriter = new StreamWriter(request.GetRequestStream())) { MemoryStream mem = new MemoryStream(); ser.WriteObject(mem, drequest); string data = Encoding.UTF8.GetString(mem.ToArray(), 0, (int)mem.Length); streamWriter.Write(data); } } HttpWebResponse HttpResponse = null; try { HttpResponse = (HttpWebResponse)request.GetResponse(); if (HttpResponse.StatusCode == HttpStatusCode.OK) { using (Stream iStream = HttpResponse.GetResponseStream()) { string sDestPath = “D:\\” + Path.GetFileName(FilePath); FileStream destStream = File.Create(sDestPath); iStream.CopyTo(destStream); destStream.Close(); } } else {//Error Message txtOutput.Text = new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd(); } } catch (WebException error) { HttpResponse = (HttpWebResponse)error.Response; } } public class DownloadCheckoutRequest { public string ItemPath { get; set; } public string Token { get; set; } public string Comments { get; set; } public Boolean EmailReport { get; set; } public string Recipients { get; set; } } Request Arguments Request arguments should be passed as an JSON serialize string e.g.: {"Comments":"","EmailReport":true,"ItemPath":"","Recipients":"","Token":""}
Response If the file is available to be downloaded, the response will be a HttpStatus code 200 OK. In case of status code OK, user can save the Stream to a local destination path, as mentioned in above c# code. In case of validation error, it will return status code 406 (Not acceptable), and in case of warning exception it will return 417 (Expectation failed) To get the error message, the stream needs to be read into a string object, as in the c# code below: Error = new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd(); DownloadFromFileShare This method allows you to download one or more files or folders from a FileShare link. Syntax HTTP Request POST: /DownloadFromFileShare HOST: https://api.filesanywhere.com/FAWAPI.svc Filesanywhere-API-Arg : {"FSToken":"","FileIDList":"","PathList":""} Invoke this Host URL, and post the argument FSToken, FileIdList and PathList. Usage This method allows you to download one or more files or folders (* delimited list, also must start with *) from a FileShare link. You will get back a stream for downloading. If there is a folder path in the list or more than one file to be downloaded, they will be zipped and the zip file will be streamed. The following parameters are needed to make the DownloadFromFileShare call:
Sample C#.Net Code private string DownloadFSFile(string sFSToken, string sFileID, string sPath){ String sWCFURL = " https://restapi.filesanywhere.com/FAWAPI.svc/DownloadFromFileShare" FSDownloadRequest drequest = new FSDownloadRequest { FSToken = sFSToken, FileIDList = sFileID, PathList = sPath }; var request = (HttpWebRequest)WebRequest.Create(sURL); request.ContentType = "text/json"; request.Method = "POST"; request.CookieContainer = new CookieContainer(); DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(FSDownloadRequest)); if (drequest != null) { using (var streamWriter = new StreamWriter(request.GetRequestStream())) { MemoryStream mem = new MemoryStream(); ser.WriteObject(mem, drequest); string data = Encoding.UTF8.GetString(mem.ToArray(), 0, (int)mem.Length); streamWriter.Write(data); } } HttpWebResponse HttpResponse = null; try { HttpResponse = (HttpWebResponse)request.GetResponse(); if (HttpResponse.StatusCode == HttpStatusCode.OK) { using (Stream iStream = HttpResponse.GetResponseStream()) { string sFileName = Path.GetFileName(sPath); if (sPath.Contains("*")) { sFileName = "TestFile.zip"; } string sDestPath = “D:\\” + sFileName; FileStream destStream = File.Create(sDestPath); iStream.CopyTo(destStream); destStream.Close(); } } else if (HttpResponse.StatusCode == HttpStatusCode.Accepted) { txtOutput.Text = "Processing Zip download id =" + new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd(); } else { txtOutput.Text = "Error =" + new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd(); } } catch (WebException error) { HttpResponse = (HttpWebResponse)error.Response; sError = error.Response.ToString(); } }
Request arguments should be passed as a JSON serialized string e.g.: {"FSToken":"b101793b","FileIDList":"3500851","PathList":"\\PATNIDEV\\0013Dbox\\ImagePDF.docx"}
Response If the file share files are available to be downloaded, the response will be a HttpStatus code 200 OK. In case of status code OK, user can save the Stream to a local destination path, as mentioned in above c# code. If file share zip is in progress, then it will return status code 202 (Accepted). In case of validation error, it will return status code 406 (Not acceptable), and in case of warning exception it will return 417 (Expectation failed) To get the error message, the stream needs to be read into a string object, as in the c# code below: Error = new StreamReader(HttpResponse.GetResponseStream()).ReadToEnd(); API Revision History Directory: api api -> Itnm 9 and tip 2 Hints and Tips Including Netcool Network Management 2 28-May-2013 api -> Using Tivoli Extended Oracle Agent in Windows for Beginners api -> Cos do-it phone and Online Survey Data 2013. sav Codebook Survey information api -> Ibm connections 6 install on Linux RedHat version 2 api -> About Asia Pacific Internet Research Alliance (apira) api -> Tools & techniques of employee benefit and retirement planning 11th Edition College Course Materials api -> A project Document of the atc application Programming Interface (api) Working Group api -> A project Document of the atc application Programming Interface (api) Working Group api -> Standard Development Report api -> Guide to Seven Agile Methodologies Download 5.13 Mb. Share with your friends:
|