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 /fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/GetClientID"
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
int
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 /fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
int
Sample Visual Basic.Net Code
Private Sub GetClientID()
Dim FAWAPI As New WebReference.FAWAPI()
Dim objGetClientIDParameter As New FAWAPI.GetClientIDParameter()
objGetClientIDParameter.CompanyCode = sCompanyCode
Dim objClientIDResult As WebReference.GetClientIDResult = FAWAPI.GetClientID(APIKey, objGetClientIDParameter)
If objClientIDResult.ErrorMessage.Length > 0 Then
MsgBox(objClientIDResult.ErrorMessage)
Else
MsgBox(objClientIDResult.ClientID)
End If
objClientIDResult = 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
|
Parameters
|
Object
|
Yes
|
Object of class for all the parameters
|
Parameters Properties
Name
|
Data Type
|
Required
|
Description
|
CompanyCode
|
String
|
Yes
|
CompanyCode for which you want to get the Client Id.
|
Response
GetClientIDResult
GetClientIDResult 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 GetClientID call was successful, the ErrorMessage is blank
|
ClientID
|
Int
|
If the GetClientID call was successful, ClientID contains the ClientID of given Company code.
|
GetCompanyDetails
Provides you the company details for a given Domain name.
Syntax
GetCompanyDetailsResult = GetCompanyDetails (APIKey, Parameters)
Usage
Use the GetCompanyDetails method to get the Company detail(s) (Company code and ClientID) of a specific Domain name.
The following parameters are needed to make the GetCompanyDetails 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 company detail:
-
DomainName: Domain name of the client for which you want to get the company details.
Share with your friends: |