Api specifications



Download 5.13 Mb.
Page41/48
Date31.07.2017
Size5.13 Mb.
#25031
1   ...   37   38   39   40   41   42   43   44   ...   48

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










string
string




HTTP/1.1 200 OK

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

Content-Length: length












string





int

string





int

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

string





int

string











Sample Visual Basic.Net Code

Private Sub GetComapnyDetails()

Dim FAWAPI As New WebReference.FAWAPI()

Dim objGetCompanyDetailsParameter As New FAWAPI. GetCompanyDetailsParameter()

objGetCompanyDetailsParameter.DomainName = sDomainName

Dim objGetCompanyDetailsResult As WebReference. GetCompanyDetailsResult

= FAWAPI.GetCompanyDetails (APIKey, objGetCompanyDetailsParameter)

If objGetCompanyDetailsResult.ErrorMessage.Length > 0 Then

MsgBox(objGetCompanyDetailsResult.ErrorMessage)

Else

MsgBox(objGetCompanyDetailsResult.ClientID)



MsgBox(objGetCompanyDetailsResult.CompanyCode)
End If

objGetCompanyDetailsResult = 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

DomainName

String

Yes

DomainName for which you want to get the Client Id and CompanyCode

Response

GetCompanyDetailsResult

GetCompanyDetailsResult 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 GetCompanyDetails call was successful, the ErrorMessage is blank

CompanyDetails

Company Detail Array

If GetComapnyDetails call was successful Array of CompanyDetail will return.

ComapnyDetail Properties



Name

Data Type

Description

ClientID

Int

ClientID of company.

CompanyCode

String

CompanyCode of company.

GetStorageLocation

This function returns the storage locations for use with FTP, SFTP and WebDAV.

Syntax

GetStorageLocationResult = GetStorageLocation()

Usage

Use the GetStorageLocation function to get storage locations for FilesAnywhere FTP, SFTP and WebDAV servers.

The following parameter is needed to make the GetStorageLocation call:



  • APIKey (A Developer API Key. See the “Getting Started” section above, to find out how to obtain a Developer API Key).




Download 5.13 Mb.

Share with your friends:
1   ...   37   38   39   40   41   42   43   44   ...   48




The database is protected by copyright ©ininet.org 2024
send message

    Main page