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/v1/FAWAPI.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/GetStorageLocation"
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
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 /FACORPAPI/v1/FAWAPI.asmx HTTP/1.1
Host: localhost
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
string
string
string
string
Sample Visual Basic.Net Code
Private Sub GetStorageLocation()
Dim FAWAPI As New WebReference.FAWAPI()
Dim StorageLocationResult As New WebReference.GetStorageLocationResult
StorageLocationResult = FAWAPI.GetStorageLocation(APIKey)
If StorageLocationResult.ErrorMessage.Length > 0 Then
MsgBox(StorageLocationResult.ErrorMessage)
Else
For Each sl As WebReference.StorageLocation In StorageLocationResult.StorageLocations
'Use StorageLocation type to fetch details
MsgBox(sl.URLType & ": " & sl.SiteURL)
Next
End If
StorageLocationResult = Nothing
FAWAPI = Nothing
End Sub
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
APIKey
|
String
|
Yes
|
A Developer API Key. The “Getting Started” section describes how to obtain a Developer API Key
|
Response
GetStorageLocationResult
GetStorageLocationResult PropertiesName
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetStorageLocation method was executed. If the GetStorageLocation call was successful, the ErrorMessage is blank
|
StorageLocations
|
List of type StorageLocation
|
If the GetStorageLocation call was successful, StorageLocations contains a list of type StorageLocation
|
StorageLocation
StorageLocation Properties
Name
|
Data Type
|
Description
|
URLType
|
String
|
Type of storage location
|
SiteURL
|
String
|
Storage location URL of specific storage type
|
GetFolderAccessKey
This function returns the folder access key for a folder belonging to a specified user.
Syntax
GetFolderAccessKeyResult = GetFolderAccessKey(Token, UserName, Password, FolderPath)
Usage
Use the GetFolderAccessKey function to get or generate the unique folder access key for a folder belonging to a specified user.
The following parameters are needed to make the GetFolderAccessKey call:
-
Token (The Token ID returned by the last AccountLogin call).
-
UserName (FilesAnywhere UserName). This is the FilesAnywhere username using which the user logs in to the FilesAnywhere account.
-
Password (FilesAnywhere Password). This is the user’s FilesAnywhere account password.
-
FolderPath is the path of a folder or a folder name.
-
User can pass the full FilesAnywhere path of the folder in the form \UserVolume\FolderNameA\FolderNameB\
-
User can pass only the folder name (without \). In this case, the API will create the folder in the first writable folder it finds.
Share with your friends: |