Api specifications

SOAP 1.1

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/GetAPIURL"

Content-Type: text/xml; charset=utf-8

Content-Length: length










string

string

SOAP 1.2

POST /FACORPAPI/v1/FAWAPI.asmx HTTP/1.1

Host: localhost

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length








string

int






HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length










string

string








Sample Visual Basic.Net Code

Private Sub GetAPIURL()

Dim FAWAPI As New WebReference.FAWAPI()

Dim APIURLResult As New WebReference.GetAPIURLResult

APIURLResult = FAWAPI.GetAPIURL(APIKey, ClientId)

If APIURLResult.ErrorMessage.Length > 0 Then

MsgBox(APIURLResult.ErrorMessage)

Else

End If

FAWAPI = Nothing

End Sub

Request Arguments

GetAPIURLResult

GetAPIURLResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the GetAPIURL method was executed. If the GetAPIURL call was successful, the ErrorMessage is blank
APIURL	String	If the GetAPIURL call was successful, APIURL contains the API URL of given ClientId

GetClientID

Provides you the ClientID for a Company code.

Syntax

GetClientIDResult = GetClientID(APIKey, Parameters)

Usage

Use the GetClientID method to get the ClientID of a specific Company code.

The following parameters are needed to make the GetClientID call:

• 
  APIKey (A Developer API Key. See the “Getting Started” section above, to find out how to obtain a Developer API Key).
  
• 
  Parameters is the object which contains the following property to hold the required parameters value to get the Client ID:
  
  • 
    CompanyCode: Company code of the client for which you want to get the ClientID.