Api specifications



Download 5.13 Mb.
Page23/48
Date31.07.2017
Size5.13 Mb.
#25031
1   ...   19   20   21   22   23   24   25   26   ...   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/APNUnregisterDevice"








string

string

string






HTTP/1.1 200 OK

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

Content-Length: length












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





HTTP/1.1 200 OK

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

Content-Length: length












string







Request Arguments



Name

Data Type

Required

Description

Token

String

Yes

The Token ID returned by the last AccountLogin call.

DeviceId

String

Yes

The hardware device ID of the iOS device.

DeviceToken

String

Yes

The deviceToken returned in didRegisterForRemoteNotificationsWithDeviceToken.

Response

APNUnregisterDeviceResult

APNUnregisterDeviceResult Properties

Name

Data Type

Description

ErrorMessage

String

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

APNUpdateRegistration

Syntax

APNUpdateRegistrationResult = APNUpdateRegistration(Token,Badges)

Usage

Use the APNUpdateRegistration method to update the number of unread notifications on the current Apple device.

The following parameters are needed to make the APNUpdateRegistration call:


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

  • Badges. (The number of unread notifications)

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








string

int





HTTP/1.1 200 OK

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

Content-Length: length












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

int





HTTP/1.1 200 OK

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

Content-Length: length












string







Request Arguments



Name

Data Type

Required

Description

Token

String

Yes

The Token ID returned by the last AccountLogin call.

Badges

Integer

Yes

The number of unread notifications

Response

APNUnregisterDeviceResult

APNUnregisterDeviceResult Properties

Name

Data Type

Description

ErrorMessage

String

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

DeleteMeeting

Syntax

DeleteMeetingResult= DeleteMeeting(Token,Meeting)

Usage

Use the DeleteMeeting method to cancel a scheduled meeting.

The following parameters are needed to make the DeleteMeeting call:


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

  • Meeting. (A populated meeting structure).

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








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







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

Host: api.filesanywhere.com

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







HTTP/1.1 200 OK

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

Content-Length: length












string

boolean







Request Arguments



Name

Data Type

Required

Description

Token

String

Yes

The Token ID returned by the last AccountLogin call.

Meeting

Meeting

Yes

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. Ignored in DeleteMeeting.

ReminderSent

Boolean

Yes

Flag indicating if reminder notifications have been sent. Ignored in DeleteMeeting.


Response

DeleteMeetingResult

DeleteMeetingResult Properties



Name

Data Type

Description

ErrorMessage

String

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

Deleted

Boolean

Flag indicating if the meeting was deleted successfully.

­­­DownloadWithCheckout

Syntax

DownloadWithCheckoutResult = DownloadWithCheckout(Token,ItemPath,Comments, EmailReport,AdditionalRecipients)

Usage

Use the DownloadWithCheckout method to checkout and download a file.

The following parameters are needed to make the DownloadWithCheckout call:



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

  • ItemPath. (The path of the file to be downloaded).

  • Comments. (Checkout comments)

  • EmailReport. (Flag indicating to send an email notification).

  • AdditionalRecipients. (Additional recipients to send the notification to).

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








string

string

string

boolean

string





HTTP/1.1 200 OK

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

Content-Length: length












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

boolean

string





HTTP/1.1 200 OK

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

Content-Length: length












string

string







Request Arguments



Name

Data Type

Required

Description

Token

String

Yes

The Token ID returned by the last AccountLogin call.

ItemPath

String

Yes

The path to the file to be downloaded.

Comments

String

No

Checkout comments to be logged with the file activity.

EmailReport

Boolean

Yes

Flag indicating to send email notification of the activity.

AdditionalRecipients

String

Yes

Additional recipients to send the notification to.


Download 5.13 Mb.

Share with your friends:
1   ...   19   20   21   22   23   24   25   26   ...   48




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

    Main page