Api specifications



Download 5.13 Mb.
Page31/48
Date31.07.2017
Size5.13 Mb.
#25031
1   ...   27   28   29   30   31   32   33   34   ...   48

ScheduleMeeting

Syntax

ScheduleMeetingResult= ScheduleMeeting(Token,Organizer,MeetingName,MeetingDate,DurationInMinutes,MeetingDescription,SendReminder,ReminderLeadTime,Attendees)

Usage

Use the ScheduleMeeting method to schedule a meeting between 2 or more users.

The following parameters are needed to make the ScheduleMeeting call:


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

  • Organizer. (The user identifier for the meeting organizer).

  • MeetingName. (A string identifier or title for the meeting).

  • MeetingDate. (The scheduled start date and time for the meeting).

  • DurationInMinutes. (The planned length of the meeting in minutes).

  • MeetingDescription. (Agenda or planned discussion).

  • SendReminder. (Flag indicating to notify attendees of the meeting).

  • ReminderLeadTime.(The number of minutes before the meeting starts to send the reminder).

  • Attendees. (User identifiers for all parties invited to attend the meeting).

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








string



string

dateTime

int

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour













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

int

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



string

dateTime

int

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour













HTTP/1.1 200 OK

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

Content-Length: length








Response xmlns="http://api.filesanywhere.com/">



string



long

string



None or Organizer or Attendee or OrganizerOrAttendee

dateTime

int

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.

Organizer

OrganizerId

No

The user identifier for the meeting organizer. If null, then the current user is the organizer.

MeetingName

String

Yes

String identifier or title of the meeting.

MeetingDate

DateTime

Yes

The scheduled start date and time of the meeting.

DurationInMinutes

Integer

Yes

The planned length of the meeting in minutes.

MeetingDescription

String

Yes

Agenda or discussion plans for the meeting.

SendReminder

Boolean

Yes

Flag indicating to send reminder notifications for the meeting to attendees.

ReminderLeadTime

Enum

Yes

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

Attendees

AttendeeId()

Yes

Array of user identifiers representing users invited to the meeting.

Response

ScheduleMeetingResult

ScheduleMeetingResult Properties



Name

Data Type

Description

ErrorMessage

String

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

Meeting

Meeting

A populated meeting structure.

­­­
A Meeting 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.

Attendees

UserIdentifier()

Yes

Array of user identifiers representing attendees.

ReminderSent

Boolean

Yes

Flag indicating if reminder notifications have been sent.

SearchFiles

Syntax

SearchFilesResult= SearchFiles(Token,Path,MP,ItemName,TextInFile,Comments,Tag,SizeUnit,SizeFrom,SizeTo,DateFrom,DateTo,CheckFolderName,CheckSubFolders,CheckIndex,SortBy,SortOrder,StartPage,PageSize)

Usage

Use the SearchFiles method to search for files and folders by properties or content.

The following parameters are needed to make the SearchFiles call:


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

  • Path. (The base path in which to search).

  • MP. (Model Param).

  • ItemName. (The name of the file or folder to search for).

  • TextInFile. (Content within the file to search for).

  • Comments. (Comments to search for).

  • Tag. (Tag to search for).

  • SizeUnit. (The unit of measurement for size filters).

  • SizeFrom. (The least size in units of SizeUnit to search for).

  • SizeTo. (The greatest size in units of SizeUnit to search for).

  • DateFrom. (The least date to search for).

  • DateTo. (The greatest date to search for).

  • CheckFolderName. (Flag indicating to check the base path).

  • CheckSubFolders. (Flag indicating to perform a recursive search).

  • CheckIndex. (Flag indicating to search the index file).

  • SortBy. (Indicates the desired sort criteria for the results).

  • SortOrder. (Indicates ascending or descending ordering of results).

  • StartPage. (Indicates the current page number in the results).

  • PageSize. (Indicates the size of paged results).


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








string

string



string

string

string

string

string

None or KiloBytes or MegaBytes or GigaBytes

long

long

dateTime

dateTime

boolean

boolean

boolean

NAME or TYPETEXT or MODIFIEDDATE or SIZE

ASC or DESC

int

int








HTTP/1.1 200 OK

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

Content-Length: length












string





string

string

string



long

string

string





string

string

string



long

string

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

string



string

string

string

string

string

None or KiloBytes or MegaBytes or GigaBytes

long

long

dateTime

dateTime

boolean

boolean

boolean

NAME or TYPETEXT or MODIFIEDDATE or SIZE

ASC or DESC

int

int







HTTP/1.1 200 OK

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

Content-Length: length












string





string

string

string



long

string

string





string

string

string



long

string

string











Request Arguments



Name

Data Type

Required

Description

Token

String

Yes

The Token ID returned by the last AccountLogin call.

Path

String

Yes

The base path in which to search.

MP

String

Yes

Model Param.

ItemName

String

Yes

The name of the file or folder to search for.

TextInFile

String

Yes

The text to search for within the files.

Comments

String

Yes

The comments to search for.

Tag

String

Yes

The tag to search for.

SizeUnit

Enum

Yes

The unit of measure for size parameters.

SizeFrom

Long

No

The least size in units of SizeUnit to search for.

SizeTo

Long

No

The greatest size in units of SizeUnit to search for.

DateFrom

DateTime

No

The least date to search for.

DateTo

DateTime

No

The greatest date to search for.

CheckFolderName

Boolean

Yes

Flag indicating to check the provided Path.

CheckSubFolders

Boolean

Yes

Flag indicating to perform a recursive search.

CheckIndex

Boolean

Yes

Flag indicating to search the index file.

SortBy

Enum

Yes

Indicates the desired sort criteria for results.

SortOrder

Enum

Yes

Indicates ascending or descending sort ordering of results.

StartPage

Integer

Yes

Indicates the current page number within the paged results.

PageSize

Integer

Yes

Indicates the size of the paged results.

Response


Download 5.13 Mb.

Share with your friends:
1   ...   27   28   29   30   31   32   33   34   ...   48




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

    Main page