Api specifications



Download 5.13 Mb.
Page44/48
Date31.07.2017
Size5.13 Mb.
#25031
1   ...   40   41   42   43   44   45   46   47   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 /FACORPAPI/FAWAPI.asmx HTTP/1.1

Host: localhost

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

Content-Length: length

SOAPAction: "http://api.filesanywhere.com/UploadFileWithFolderAccessKey"










string

string

string

base64Binary





HTTP/1.1 200 OK

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

Content-Length: length












string

boolean









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: localhost

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

Content-Length: length








string

string

string

base64Binary





HTTP/1.1 200 OK

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

Content-Length: length












string

boolean







Sample Visual Basic.Net Code

Private Sub GetFolderAccessKey()

Dim FAWAPI As New WebReference.FAWAPI

Dim UploadFileResults

As New WebReference.UploadFileResult


UploadFileResults = FAWAPI. UploadFileWithFolderAccessKey

(APIKey, FolderAccessKey, FileName, FileData)

If UploadFileResults.ErrorMessage IsNot Nothing Then

Msgbox UploadFileResults.ErrorMessage

Else

Msgbox UploadFileResults.Uploaded



End If

UploadFileResults = Nothing

FAWAPI = Nothing

End Sub
Request Arguments



Name

Data Type

Required

Description

APIKey

String

Yes

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

FolderAccessKey

String

Yes

Unique Access Key of a folder belonging to a specified user.

FileName

String

Yes

Name of the file to be uploaded.

FileData

Base64Binary

Yes

The contents of the file as binary data in XML base64Binary format

Response

UploadFileResult

UploadFileResult Properties

Name

Data Type

Description

ErrorMessage

String

A description of the error, if any error was encountered while the UploadFile method was executed. If the UploadFile call was successful, the ErrorMessage is blank

Uploaded

Boolean

True or False indicating whether the UploadFile call was a success or a failure

User will not get any progress update of upload by using this method.


UpdateUserProfile

Update user profile details.
Note: If the following fields are left blank, the system will erase any existing content on the profile page: First Name, Last Name, Company Name, Job Title, Phone, Cell Phone, Address, City, State, Zip and Country. If PrimaryEmail or SecondaryEmail are left blank, then the system will not make any changes to the existing primary or secondary email address.

Syntax

UpdateUserProfileResult = UpdateUserProfile(Token, Paremeters)
Usage

Use the UpdateUserProfile function to update the user profile details.

The following parameters are needed to make the UpdateUserProfile call:


  • Token (The Token ID returned by the last AccountLogin call).

  • Parameters is the object which contains the following properties to hold the required values to set the user profile details:

    • FirstName: First Name

    • LastName: Last Name

    • CompanyName: Company Name

    • JobTitle: Job Title

    • Phone: Phone Number

    • CellPhone: Cell Phone Number

    • Address

    • State

    • City

    • State

    • Zip

    • Country

    • PrimaryEmail: Primary Email

    • SecondaryEmail: Secondary Email



Download 5.13 Mb.

Share with your friends:
1   ...   40   41   42   43   44   45   46   47   48




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

    Main page