Mobile Synchronization Web Service (MobileSyncWebService) reference
Components and data interaction
The following figure shows the components that are involved in an disconnected interviewing system, and the data interaction between the components.
The following sequence of events apply to the offline mobile application:
Note The third party mobile application is referred to as MobileApp.
▪The MobileApp connects, through the Internet, to the MobileSyncWebService and authenticates the user and device. The connection require authentication calls to theSyncWebServiceV2.
▪The MobileApp requests the list of projects, that are assigned to the user, from theMobileSyncWebService. The MobileSyncWebService then generates a Get request to the SyncWebServiceV2 for project assignments and returns the results to the MobileApp as Projects XML.
▪The MobileApp requests a specific project from the MobileSyncWebService. TheMobileSyncWebService creates a list of files that are currently available in the disk cache and provides the information to the SyncWebServiceV2. TheSyncWebServiceV2 returns the changed files. TheMobileSyncWebService saves the changed files to its disk cache and creates ProjectInfo XML, which describes the project. The XML is returned to the MobileApp.
▪The MobileApp decides which files to retrieve (for example, which available languages are useful). The MobileApp then requests each file individually, including Question XML, Routing XML, and other resource files (such as images). The MobileSyncWebService check the cache for the requested file and creates it from the project metadata file (*.mdd) when the file is not available from the cache.
▪The MobileApp uses the returned survey information to conduct interviews.
The MobileApp submits the results to the MobileSyncWebService as XML. The MobileSyncWebService converts the results to UNICOM Intelligence style files. For example, it converts Response XML to cache (*.chj) files. The MobileSyncWebService uploads the results to the SyncWebServiceV2.
Mobile Synchronization Web Service (MobileSyncWebService)
The MobileSyncWebService is implemented as a RESTful web service that accepts and returns XML. The service relies on the SyncWebServiceV2 for interaction withUNICOM Intelligence. The web service is installed on interviewing or accessories tier servers. The necessary components are installed on the servers and are publicly available.
MobileSyncWebService also supports the HTTPS protocol. Because basic authentication is used, and response data is transferred as XML, the HTTPS protocol must always be used. The lone exception is when both the client and MobileSyncWebService are both located within an internal network.
See also