{"id":28410,"date":"2021-06-29T09:33:15","date_gmt":"2021-06-29T09:33:15","guid":{"rendered":"https:\/\/www.inogic.com\/blog\/?p=28410"},"modified":"2021-09-01T09:30:54","modified_gmt":"2021-09-01T09:30:54","slug":"how-to-perform-basic-crud-operations-using-offline-web-api-in-mobile-clients","status":"publish","type":"post","link":"https:\/\/www.inogic.com\/blog\/2021\/06\/how-to-perform-basic-crud-operations-using-offline-web-api-in-mobile-clients\/","title":{"rendered":"How to Perform Basic CRUD Operations using Offline Web API in Mobile Clients"},"content":{"rendered":"

\"Dynamics<\/a><\/h2>\n

Introduction<\/strong><\/h2>\n

Microsoft<\/strong> has provided offline<\/strong> ability to use \u201cDynamics 365 for phones app\u201d or \u201cField Service (Dynamics 365) App\u201d. Mobile Offline allows users to work with the data in offline mode as well i.e. when they are not connected to the internet. So, in the offline mode, if we want to create or manage the data programmatically, we need to use Microsoft Dynamics Offline Web API methods within the script.<\/p>\n

Microsoft Dynamics Offline Web API methods can be used for basic commands while working in offline mode. The basic methods that are available for using the Xrm.WebApi.offline<\/strong> include the following: createRecord,\u00a0 retrieveRecords, retrieveMultipleRecords, updateRecord and deleteRecord.<\/p>\n

\n

Note:<\/em><\/strong> These OfflineWebApi<\/strong> methods will work only for tables that are enabled for mobile offline<\/strong> and only basic validation will be performed on the data that is being input. <\/em><\/p>\n

By using the below method, we can identify whether the entity is available to use in offline mode: <\/em>Xrm.WebApi.offline.isAvailableOffline(entityLogicalName);<\/em><\/strong><\/p>\n<\/blockquote>\n

In this blog, I will show the sample codes to create, retrieve, update and delete records using Xrm.WebApi.offline<\/strong> methods in JavaScript<\/strong>.<\/p>\n

    \n
  1. \n

    Create:<\/u><\/strong><\/h3>\n<\/li>\n<\/ol>\n

    It is used to create table record. The required parameters of this function are;<\/p>\n

      \n
    1. \n
        \n
      1. entityLogicalName \u2013 Logical name of the table.<\/li>\n
      2. data \u2013 JSON object of the data to create a new record.<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

        \/\/This function is used to create a contact record<\/code>
        \nfunction createContact() {<\/code>
        \n\u00a0\u00a0\u00a0 var objContact = null;<\/code>
        \n\u00a0\u00a0\u00a0 try {<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Create the Json object of contact record<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 objContact = new Object();<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 objContact[\"firstname\"] = \"Jenny\";<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 objContact[\"lastname\"] = \"Smith\";<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Call Create method<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.WebApi.offline.createRecord(\"contact\", objContact).then(function (result) {<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(\"Contact record has been created successfully.\");<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 function (error) {<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(error.message);<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 });<\/code>
        \n\u00a0\u00a0\u00a0 } catch (e) {<\/code>
        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(e.message);<\/code>
        \n\u00a0\u00a0\u00a0 }<\/code><\/p>\n

          \n
        1. \n

          Update<\/u><\/strong>:<\/strong><\/h3>\n<\/li>\n<\/ol>\n

          It is used to update table record. The required parameters of this function are;<\/p>\n

            \n
          1. \n
              \n
            1. entityLogicalName \u2013 Logical name of the table.<\/li>\n
            2. entityId \u2013 GUID of record.<\/li>\n
            3. data \u2013 JSON object of the data to update record.<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

              \/\/This function is used to update a contact record<\/code>
              \nfunction updateContact() {<\/code>
              \n\u00a0\u00a0\u00a0 var objContact = null;<\/code>
              \n\u00a0\u00a0\u00a0 try {<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Create the Json object of contact record<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 objContact = new Object();<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 objContact[\"telephone1\"] = \"18018015012\";<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 objContact[\"fax\"] = \"123456\";<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 objContact[\"parentcustomerid_account@odata.bind\"] = \"\/accounts(08f4aca2-9793-eb11-b1ac-0022481cb79b)\"<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Call Update method<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.WebApi.offline.updateRecord(\"contact\", \"fb4231a9-dba4-eb11-b1ac-000d3a4e57c1\", objContact).then(function (result) {<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(\"Contact record has been updated successfully.\");<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0 function (error) {<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(error.message);<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0 });<\/code>
              \n\u00a0\u00a0\u00a0 } catch (e) {<\/code>
              \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(e.message);<\/code>
              \n\u00a0\u00a0\u00a0 }<\/code>
              \n}<\/code><\/p>\n

                \n
              1. \n

                Delete<\/u><\/strong>:<\/strong><\/h3>\n<\/li>\n<\/ol>\n

                It is used to delete table record. The required parameters of this function are;<\/p>\n

                  \n
                1. \n
                    \n
                  1. entityLogicalName \u2013 Logical name of the table.<\/li>\n
                  2. entityId \u2013 GUID of record.<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

                    \/\/This function is used to delete a contact record<\/code>
                    \nfunction deleteContact() {<\/code>
                    \n\u00a0\u00a0\u00a0 try {<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Call Delete method<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.WebApi.offline.deleteRecord(\"contact\", \"5d0111d1-bf05-4079-b695-247e4c9acac2\").then(function (result) {<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(\"Contact record has been deleted successfully.\");<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0 function (error) {<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(error.message);<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0 });<\/code>
                    \n\u00a0\u00a0\u00a0 } catch (e) {<\/code>
                    \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(e.message);<\/code>
                    \n\u00a0\u00a0\u00a0 }<\/code>
                    \n}<\/code><\/p>\n

                      \n
                    1. \n

                      Retrieve<\/u><\/strong>:<\/strong><\/h3>\n<\/li>\n<\/ol>\n

                      It is used to retrieve a single record from a table. The required parameters of this function are;<\/p>\n

                        \n
                      1. entityLogicalName \u2013 Logical name of the table.<\/li>\n
                      2. entityId – GUID of record.<\/li>\n
                      3. options \u2013 OData Query.<\/li>\n<\/ol>\n

                        \/\/This function is used to retrieve single contact record<\/code>
                        \nfunction retrieveContact() {<\/code>
                        \n\u00a0\u00a0\u00a0 try {<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Call Retrieve method<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.WebApi.offline.retrieveRecord(\"contact\", \"fb4231a9-dba4-eb11-b1ac-000d3a4e57c1\", \"?$select=firstname,lastname,telephone1\").then(function (result) {<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(\"Contact retrieved successfully - FirstName: \" + result.firstname + \", LastName: \" + result.lastname + \" and Telephone: \" + result.telephone1);<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0 function (error) {<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(error.message);<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0 });<\/code>
                        \n\u00a0\u00a0\u00a0 } catch (e) {<\/code>
                        \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(e.message);<\/code>
                        \n\u00a0\u00a0\u00a0 }<\/code><\/p>\n

                          \n
                        1. \n

                          RetrieveMultiple<\/u><\/strong>:<\/strong><\/h3>\n<\/li>\n<\/ol>\n

                          It is used to retrieve multiple records from the table. The required parameters of this function are;<\/p>\n

                            \n
                          1. entityLogicalName \u2013 Logical name of the table.<\/li>\n
                          2. options \u2013 we can use OData Query and FetchXML as well.<\/li>\n<\/ol>\n

                            RetrieveMultiple method with OData Query<\/strong> \u2013<\/h4>\n

                            \/\/This function is used to retrieve contact records using OData Query<\/code>
                            \nfunction retrieveContactsWithOdata() {<\/code>
                            \n\u00a0 \u00a0\u00a0try {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Call Retrieve method<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.WebApi.offline.retrieveMultipleRecords(\"contact\", \"?$select=firstname,lastname,telephone1&$filter=_parentcustomerid_value ne null\").then(function (result) {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(\"Length: \" + result.entities.length);<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0 function (error) {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(error.message);<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0 });<\/code>
                            \n\u00a0\u00a0\u00a0 } catch (e) {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(e.message);<\/code>
                            \n\u00a0\u00a0\u00a0 }<\/code>
                            \n}<\/code><\/p>\n

                            RetrieveMultiple method with FetchXML<\/strong> \u2013 To use a FetchXML, use the fetchXml attribute to specify the query.<\/h4>\n

                            \/\/This function is used to retrieve contact records using Fetch XML<\/code>
                            \nfunction retrieveContactsWithFetch() {<\/code>
                            \n\u00a0\u00a0\u00a0 var fetchXML = null;<\/code>
                            \n\u00a0\u00a0\u00a0 try {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Fetch XML to retrieve Contact records<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 fetchXML = \"<fetch version='1.0' output-format='xml-platform' mapping='logical' distinct='false'>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<entity name='contact'>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<attribute name='fullname' \/>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<attribute name='telephone1' \/>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<attribute name='contactid' \/>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<order attribute='fullname' descending='false' \/>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<filter type='and'>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<condition attribute='parentcustomerid' operator='not-null' \/>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<\/filter>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"<\/entity>\" +<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0 \"<\/fetch>\";<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/Call Retrieve method<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.WebApi.offline.retrieveMultipleRecords(\"contact\", \"?fetchXml=\" + fetchXML).then(function (result) {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(\"Length: \" + result.entities.length);<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0 function (error) {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(error.message);<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0 });<\/code>
                            \n\u00a0\u00a0\u00a0 } catch (e) {<\/code>
                            \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Xrm.Navigation.openAlertDialog(e.message);<\/code>
                            \n\u00a0\u00a0\u00a0 }<\/code>
                            \n}<\/code><\/p>\n

                            Conclusion<\/strong><\/h2>\n

                            By using the Offline Web API<\/strong> methods, we can easily create and manage the table record which is available in the offline database for offline use within mobile clients i.e., \u201cDynamics 365 for phones app\u201d or \u201cField Service (Dynamics 365) App\u201d.<\/p>\n

                            \"Maplytics\"<\/a><\/p>\n

                             <\/p>\n","protected":false},"excerpt":{"rendered":"

                            Introduction Microsoft has provided offline ability to use \u201cDynamics 365 for phones app\u201d or \u201cField Service (Dynamics 365) App\u201d. Mobile Offline allows users to work with the data in offline mode as well i.e. when they are not connected to the internet. So, in the offline mode, if we want to create or manage the\u2026 Read More »<\/a><\/span><\/p>\n","protected":false},"author":13,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[65],"tags":[1813],"class_list":["post-28410","post","type-post","status-publish","format-standard","hentry","category-webapi","tag-web-api"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/28410","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/comments?post=28410"}],"version-history":[{"count":0,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/28410\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/media?parent=28410"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/categories?post=28410"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/tags?post=28410"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}