Api specifications

Syntax

APNEchoNotificationResult = APNEchoNotification(Token,Message)

Usage

Use the APNEchoNotification method to test APNS on a registered device.

The following parameters are needed to make the APNEchoNotification call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  Message . (The test message to send to the device currently registered for the logged in user.)
  

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








string

string






HTTP/1.1 200 OK

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

Content-Length: length










string

guid

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

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

APNEchoNotificationResult

APNEchoNotificationResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the APNEchoNotification method was executed. If the APNEchoNotification call was successful, the ErrorMessage is blank
NotificationId	GUID	The identifier for the notification sent. This can be used in conjunction with APNGetNotificationProperties to determine the status of the notification.

APNGetNotificationProperties

Syntax

APNGetNotificationPropertiesResult = APNGetNotificationProperties(Token,NotificationId)

Usage

Use the APNGetNotificationProperties method to fetch the status and other properties of an APNS notification.

The following parameters are needed to make the APNRegisterDevice call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  NotificationId. (The identifier for the notification to retrieve properties for).
  

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








string

guid

HTTP/1.1 200 OK

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

Content-Length: length

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

guid

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

APNGetNotificationPropertiesResult

APNGetNotificationPropertiesResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the APNGetNotificationProperties method was executed. If the APNGetNotificationProperties call was successful, the ErrorMessage is blank
APNNotificationId	GUID	The identifier for the notification.
NotificationDate	DateTime	The datetime stamp when the notification was generated.
NotificationPostDate	DateTime	The datetime stamp when the notification was sent to APNS services.
Attempts	Integer	The number of attempts to send the notification.
NotificationStatus	String	The status of the notification.

APNRegisterDevice

Syntax

APNRegisterDeviceResult = APNRegisterDevice(Token,DeviceId,DeviceToken)

Usage

Use the APNRegisterDevice method to register an Apple iOS device for push notification services.

The following parameters are needed to make the APNRegisterDevice call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  DeviceId. (The iOS hardware device id)
  
• 
  DeviceToken. (The deviceToken returned in
  didRegisterForRemoteNotificationsWithDeviceToken).
  

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








string

string

string

HTTP/1.1 200 OK

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

Content-Length: length

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

Request Arguments

APNRegisterDeviceResult

APNRegisterDeviceResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the APNRegisterDevice method was executed. If the APNRegisterDevice call was successful, the ErrorMessage is blank

APNSendNotification

Syntax

APNSendNotificationResult = APNSendNotification(Token,NotificationType)

Usage

Use the APNSendNotification method to send an Apple push notification to an iOS device. This is for testing purposes only and will only send notifications to the device registered for the provided token, using the default values for substitution parameters.

The following parameters are needed to make the APNSendNotification call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  NotificationType. (The type of notification to be sent to the current iOS device).
  

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








string

FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

HTTP/1.1 200 OK

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

Content-Length: length

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

FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

APNSendNotificationResult

APNSendNotificationResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the APNSendNotification method was executed. If the APNSendNotification call was successful, the ErrorMessage is blank
NotificationId	Guid	The identifier for the notification message.

APNUnregisterDevice

Syntax

APNUnregisterDeviceResult = APNUnregisterDevice(Token,DeviceId,DeviceToken)

Usage

Use the APNUnregisterDevice method to unregister an Apple iOS device for push notification services.

The following parameters are needed to make the APNRegisterDevice call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  DeviceId. (The iOS hardware device id)
  
• 
  DeviceToken. (The deviceToken returned in
  didRegisterForRemoteNotificationsWithDeviceToken).