E-mail
API URL: ivlefilesync.sgcloudapp.net/api/
Function: RegisterDevice
Purpose: Registers this device to the userid specified
Input:
- (string)UserID: The UserID to register the device with
- (string)API: The login key assigned to you when you login to the website
- (string)DeviceName: A globally unique identifier for the device e.g [DEVICETYPE]_[SERIAL]
- (string)DeviceDescription: A friendly name for this device, e.g HTC Desire, IPhone4
Output:
- (string)Empty if invalid, else the DeviceSyncID
Function: UnregisterDevice
Purpose: Unregisters this device to the userid specified
Input:
- (string)UserID: The UserID to register the device with
- (string)API: The login key assigned to you when you login to the website
- (Guid)DeviceID: The DeviceSyncID that was assigned to this device
Output:
- void
Function: Sync
Purpose: Performs a sync for the device specified
Input:
- (string)UserID: The UserID to register the device with
- (string)API: The login key assigned to you when you login to the website
- (Guid)DeviceID: The DeviceSyncID that was assigned to this device
Output:
- JSON
- (string)Error: Non empty if there an error occured
- (datetime)LastSync: Date of last sync (this is the system date/time when the last sync occured, for record keeping purposes only)
- (bool)Success: true if successful, false otherwise
- (array)files -
- (string)DirectoryPath: Directory name for this file e.g CS1101\Workbin\CS1101Workbin\Folder1
- (Guid)FileID: System ID for the file (used by the next function)
- (string)FileName: Physical file name for this file
Function: Download
Purpose: Downloads the file from the system
Input:
- (string)UserID: The UserID to register the device with
- (string)API: The login key assigned to you when you login to the website
- (Guid)DeviceID: The DeviceSyncID that was assigned to this device
- (Guid)FileID: The System ID for the file
Output:
- application/octet-stream result if successful (aka file download) else http 200, empty result if not successful
Labels