Sidekick Service 2.1
Sidekick Service 2.5.15 - September 2019. This web service is part of the Sidekick Enterprise Solution. It contains methods that allow registered users to download data updates and upload log files
The following operations are supported. For a formal definition, please review the Service Description.
-
CreateIncrementalUpdateFile
Generate a server-side incremental update file -
CreatePNCUpdateFile
Generate a server-side PNC update file -
FinalizeFullUpdate
Finalizes the full update procedure and returns the date and time of the zip files -
FinalizeIncrementalUpdate
Finalizes the incremental update procedure and returns the server date and time -
FinalizePNCUpdate
Finalize the PNC update procedure -
FinalizeUploadLog
Finalize the upload log procedure -
GetDeletedRecords
Returns the list of records that exist in the client database but not exist in the server database -
GetDiagnosticLogFileHash
Returns the hash for an uploaded log file -
GetFullUpdateFile
Returns the contents of the specified file for the full update procedure -
GetFullUpdateFileChunk
Returns a chunk of the specified file for the full update procedure -
GetFullUpdateFileHash
Returns the hash of the specified file for the full update procedure -
GetFullUpdateFileList
Returns the list of files that will be downloaded in the full update procedure -
GetFullUpdateFileSize
Returns the size of the specified file for the full update procedure -
GetFullUpdateTableList
Returns the list of tables involved in the full update procedure -
GetFullUpdateUrl
Returns URL of the Full Update path, where the last Full Update ZIP files are available -
GetIncrementalUpdateFile
Returns an incremental update file -
GetIncrementalUpdateFileChunk
Returns an incremental update file chunk -
GetIncrementalUpdateFileHash
Returns an incremental update file hash -
GetIncrementalUpdateFileList
Returns the incremental update file list -
GetIncrementalUpdateFileSize
Return an incremental update file size (in bytes) -
GetIncrementalUpdateTableList
Returns the list of tables involved in the incremental update procedure -
GetMaxRequestLength
Returns the max size of chunk that the server will accept -
GetPNCUpdateFile
Returns an PNC update file -
GetPNCUpdateFileChunk
Returns an PNC update file chunk -
GetPNCUpdateFileHash
Returns an PNC update file hash -
GetPNCUpdateFileList
Returns the PNC update file list -
GetPNCUpdateFileSize
Return an PNC update file size (in bytes) -
GetPNCUpdateTableList
Initialize the PNC update procedure and returns the list of tables involved -
GetProgrammingLogFileHash
Returns the hash for an uploaded log file -
GetUserSettings
Returns user settings -
ImportDiagnosticLogFile
Allow users to import a log file in the database after the file has been uploaded -
ImportProgrammingLogFile
Allow users to import a log file in the database after the file has been uploaded -
InitializeFullUpdate
Initialize the full update procedure (backward compatibile, uses "Sidekick" as configured application) -
InitializeFullUpdateEx
Initialize the full update procedure -
InitializeFullUpdateEx2
Initialize the full update procedure -
InitializeIncrementalUpdate
Initialize the incremental update procedure (backward compatibile, uses "Sidekick" as configured application) -
InitializeIncrementalUpdateEx
Initialize the incremental update procedure -
InitializeIncrementalUpdateEx2
Initialize the incremental update procedure -
InitializePNCUpdate
Initialize the PNC update procedure (backward compatibile, uses "Sidekick" as configured application) -
InitializePNCUpdateEx
Initialize the PNC update procedure -
InitializePNCUpdateEx2
Initialize the PNC update procedure -
InitializeUploadLog
Initialize the upload log procedure (backward compatibile, uses "Sidekick" as configured application) -
InitializeUploadLogEx
Initialize the upload log procedure -
Ping
A dummy method to check the connection to the web service -
PingWithApplicationInfo
A dummy method to check the connection to the web service that also gets application name and client version information to be logged to central database. -
PingWithClientVersion
A dummy method to check the connection to the web service that also gets client version information to be logged to central database. -
PingWithSystemInfo
A dummy method to check the connection to the web service that also gets application name, client version and operating system information to be logged to central database. -
ReportAbortFullUpdate
Reports that the full update procedure has been aborted (due to errors or user decision), logging the elapsed time between Initialize and Abort -
ReportAbortIncrementalUpdate
Reports that the incremental update procedure has been aborted (due to errors or user decision), logging the elapsed time between Initialize and Abort -
ReportAbortPNCUpdate
Reports that the PNC update procedure has been aborted (due to errors or user decision), logging the elapsed time between Initialize and Abort -
ReportAbortUploadLog
Reports that the upload log procedure has been aborted (due to errors or user decision), logging the elapsed time between Initialize and Abort -
UploadDiagnosticLogFile
Allow users to upload a log file -
UploadDiagnosticLogFileChunk
Allow users to upload a log file chunk -
UploadProgrammingLogFile
Allow users to upload a log file -
UploadProgrammingLogFileChunk
Allow users to upload a log file chunk