Api specifications



Download 5.13 Mb.
Page29/48
Date31.07.2017
Size5.13 Mb.
#25031
1   ...   25   26   27   28   29   30   31   32   ...   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 /v2/fawapi.asmx HTTP/1.1

Host: api.filesanywhere.com

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

Content-Length: length

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








string

date

date

string

Undefined or AccessControl or FormDelete or Copy or DeleteFolderFile or RestoreData or AdminAddUser or PurgeUser or FileVersion or AdminEditUser or GroupShare or CopyIndexing or SendLoginDetails or Move or CreateFolder or GeneralNotification or ImageToPDFConversion or Download or RenameFolderFile or AdminSettingsChanged or Upload or ChangePwd or ResetAccount or SetAccountStatus or ZohoRequest



Undefined or Add or Update or Delete

Undefined or DeleteEFormData or DeleteEFormDataAndForm

Undefined or Add or Update or Delete

Undefined or API or Classic or DropBoxClassic or DropBoxFlash or Flash or Java or LocalClassic or UltimateUploader or Zoho or Form







HTTP/1.1 200 OK

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

Content-Length: length












string





dateTime

Undefined or AccessControl or FormDelete or Copy or DeleteFolderFile or RestoreData or AdminAddUser or PurgeUser or FileVersion or AdminEditUser or GroupShare or CopyIndexing or SendLoginDetails or Move or CreateFolder or GeneralNotification or ImageToPDFConversion or Download or RenameFolderFile or AdminSettingsChanged or Upload or ChangePwd or ResetAccount or SetAccountStatus or ZohoRequest

string

string

string



Folder or File

long

string





dateTime

Undefined or AccessControl or FormDelete or Copy or DeleteFolderFile or RestoreData or AdminAddUser or PurgeUser or FileVersion or AdminEditUser or GroupShare or CopyIndexing or SendLoginDetails or Move or CreateFolder or GeneralNotification or ImageToPDFConversion or Download or RenameFolderFile or AdminSettingsChanged or Upload or ChangePwd or ResetAccount or SetAccountStatus or ZohoRequest

string

string

string



Folder or File

long

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 /v2/fawapi.asmx HTTP/1.1

Host: api.filesanywhere.com

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

Content-Length: length








string

date

date

string

Undefined or AccessControl or FormDelete or Copy or DeleteFolderFile or RestoreData or AdminAddUser or PurgeUser or FileVersion or AdminEditUser or GroupShare or CopyIndexing or SendLoginDetails or Move or CreateFolder or GeneralNotification or ImageToPDFConversion or Download or RenameFolderFile or AdminSettingsChanged or Upload or ChangePwd or ResetAccount or SetAccountStatus or ZohoRequest



Undefined or Add or Update or Delete

Undefined or DeleteEFormData or DeleteEFormDataAndForm

Undefined or Add or Update or Delete

Undefined or API or Classic or DropBoxClassic or DropBoxFlash or Flash or Java or LocalClassic or UltimateUploader or Zoho or Form







HTTP/1.1 200 OK

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

Content-Length: length












string





dateTime

Undefined or AccessControl or FormDelete or Copy or DeleteFolderFile or RestoreData or AdminAddUser or PurgeUser or FileVersion or AdminEditUser or GroupShare or CopyIndexing or SendLoginDetails or Move or CreateFolder or GeneralNotification or ImageToPDFConversion or Download or RenameFolderFile or AdminSettingsChanged or Upload or ChangePwd or ResetAccount or SetAccountStatus or ZohoRequest

string

string

string



Folder or File

long

string





dateTime

Undefined or AccessControl or FormDelete or Copy or DeleteFolderFile or RestoreData or AdminAddUser or PurgeUser or FileVersion or AdminEditUser or GroupShare or CopyIndexing or SendLoginDetails or Move or CreateFolder or GeneralNotification or ImageToPDFConversion or Download or RenameFolderFile or AdminSettingsChanged or Upload or ChangePwd or ResetAccount or SetAccountStatus or ZohoRequest

string

string

string



Folder or File

long

string











Request Arguments



Name

Data Type

Required

Description

Token

String

Yes

The Token ID returned by the last AccountLogin call.

StartDate

DateTime

Yes

The date marking the start of the log activities returned.

EndDate

DateTime

Yes

The date marking the end of the log activities returned.

FolderOrFile

String

Yes

The file path or folder base path to return activities for.

ActivityType

Enum

No

Filter for types of activities to return.

SubType

Object

No

Filter for sub types of activities to return.

Response

ListLogActivitiesResult

ListLogActivitiesResult Properties

Name

Data Type

Description

ErrorMessage

String

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

Items.ActionDate

DateTime

The datetime stamp the action was performed.

Items.ActivityType

Enum

The type of activity performed.

Items.AppUserName

String

The username who performed the action.

Items.SourcePath

String

The source path of the file or folder acted upon.

Items.DestinationPath

String

The destination path of the file or folder acted upon.

Items.SubActivity

Object

The activity sub-type.

Items.SourceItemType

Enum

The source file or folder type.

Items.Size

Long

The size of the file, or 0 for folder.

Items.Comments

String

The comments associated with the action.

ListMeetings

Syntax

ListMeetingsResult= ListMeetings(Token,Role,OrganizerOrAttendee,FromDate,ToDate, ,SortBy,SortOrder)

Usage

Use the ListMeetings method to list the meetings a user is attending.

The following parameters are needed to make the ListMeetings call:


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

  • Role. (A filter used to distinguish meetings where the user is an organizer, an attendee, or either).

  • OrganizerOrAttendee. (The user identifier for the meeting organizer or attendee).

  • FromDate. (Date range start filter).

  • ToDate. (Date range end filter).

  • SortBy. (The meeting property to sort the list results).

  • SortOrder. (Ascending or descending sort).

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 /v2/fawapi.asmx HTTP/1.1

Host: api.filesanywhere.com

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

Content-Length: length

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










string

None or Organizer or Attendee or OrganizerOrAttendee



int

string



dateTime

dateTime

MeetingName or MeetingDate or Role or SendReminders or RemindersSent

ASC or DESC





HTTP/1.1 200 OK

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

Content-Length: length












string





long

string



None or Organizer or Attendee or OrganizerOrAttendee

dateTime

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour

boolean





long

string



None or Organizer or Attendee or OrganizerOrAttendee

dateTime

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour

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 /v2/fawapi.asmx HTTP/1.1

Host: api.filesanywhere.com

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

Content-Length: length










string

None or Organizer or Attendee or OrganizerOrAttendee



int

string



dateTime

dateTime

MeetingName or MeetingDate or Role or SendReminders or RemindersSent

ASC or DESC





HTTP/1.1 200 OK

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

Content-Length: length












string





long

string



None or Organizer or Attendee or OrganizerOrAttendee

dateTime

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour

boolean





long

string



None or Organizer or Attendee or OrganizerOrAttendee

dateTime

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour

boolean











Request Arguments



Name

Data Type

Required

Description

Token

String

Yes

The Token ID returned by the last AccountLogin call.

Role

Enum

Yes

Filter to distinguish meetings the user is an organizer for, an attendee of, or either.

OrganizerOrAttendee

UserIdentifier

No

The user identifier to search for. If null, then the current user is used.

FromDate

DateTime

No

Date range start filter.

ToDate

DateTime

No

Date range end filter.

SortBy

Enum

Yes

The meeting property to sort the result s by.

SortOrder

Enum

Yes

Ascending or descending sort.

Response

ListMeetingsResult

ListMeetingsResult Properties



Name

Data Type

Description

ErrorMessage

String

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

Meetings

MeetingFromList()

An array of populated MeetingFromList structures.

­­­
A MeetingFromList has the following properties:

Property Name

Data Type

Required

Description

MeetingId

Long

Yes

Unique identifier for the meeting.

MeetingName

String

Yes

String identifier or title for the meeting.

Organizer

UserIdentifier

Yes

User identifier representing the organizer.

Role

Enum

Yes

The role of the current user in the meeting.

MeetingDate

DateTime

Yes

The scheduled start date of the meeting.

DurationInMinutes

Integer

Yes

The planned length of the meeting in minutes.

MeetingDescription

String

Yes

The agenda or discussion plans for the meeting.

SendReminder

Boolean

Yes

Flag indicating if reminder notifications are to be sent to attendees.

ReminderLeadTime

Enum

Yes

The number of minutes before the meeting starts to send reminder notifications.

ReminderSent

Boolean

Yes

Flag indicating if reminder notifications have been sent.

ListUserVolumes2

This method lists all user volumes which are accessible from the user’s FilesAnywhere account. This includes the user’s own account, inbox, version history, and other GroupShares if they exist.

Syntax

ListUserVolumesResult = ListUserVolumes2(Token)

Usage

Use the ListUserVolumes method to get a list of all shares to the logged in user. The list also includes the current user’s private storage, inbox, and version history directories.

The following parameters are needed to make the ListUserVolumes2 call:



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

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 /v2/fawapi.asmx HTTP/1.1

Host: api.filesanywhere.com

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

Content-Length: length

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








string





HTTP/1.1 200 OK

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

Content-Length: length












string





string

string


string






string

string


string















Download 5.13 Mb.

Share with your friends:
1   ...   25   26   27   28   29   30   31   32   ...   48




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

    Main page