ZCAPIService | Zoho Creator Help

ZCAPIService

ZCAPIService

This service lets you fetch the list of applications and sections along with its components.

Methods
fetchSectionList(for:completionHandler:)To fetch the list of all sections and their components (Forms, Reports and Pages) and the list of all approvals in an application
 
fetchAppContext(for application: Application, completionHandler: @escaping (Result<AppContext>) -> Void)To fetch the appContext which contains the applicationId, appLinkName, scopeId of the application.
 
fetchThemeInfo(for application: Application, completionHandler: @escaping (Result<ThemeInfo>) -> Void)To fetch themeInfo of the application. This can be used to apply themes to your ViewController.
 
 
fetchSectionList(for:completionHandler:)

Parameters

application An object which holds Application Info.
completionHandler The application list will be returned to the completionHandler.
 
fetchNewNotificationRedirectionInfo(for appContext: AppContext? = nil, notificationID: String ,category: ZCNotification.Category, completionHandler: @escaping (Result<ZCNotificationRedirection>) -> Void)

Parameters


      appContext

This is mandatory and it holds application info. If not passed, then the API will not work. To get this appContext, use the fetchAppContext method in ZCAPIService. 
notificationID Contains the unique ID of a notification.
category Contains the notification category.

     completionHandler

The ZCNotificationRedirection will be returned to the  completionHandler.
 
fetchNewNotifications(for appContext: AppContext? = nil, lastNotificationID: String? ,filterUnread:Bool , filteredApp :ZCNotificationApp?, completionHandler: @escaping (Result<ZCNotificationList>) -> Void)

Parameters


            appContext


This is mandatory and it holds application info. If not passed, then the API will not work. To get this appContext, use the fetchAppContext method in ZCAPIService. 
 
lastNotificationID Will fetch notifications that have been sent after this notification ID. If 'nil', then all notifications will be fetched.
filteredUnread If true, it will fetch only unread notifications
else it will fetch all the notifications.

        filteredApp

    nil

      completionHandler

The ZCNotificationList will be returned to the  completionHandler.
 
 
fetchAppContext(for application: Application, completionHandler: @escaping (Result<AppContext>) -> Void)

Parameters

application An object which holds Application Info.
completionHandler AppContext will be returned to the completionHandler.
fetchThemeInfo(for application: Application, completionHandler: @escaping (Result<ThemeInfo>) -> Void)

Parameters

application An object which holds Application Info.
completionHandler ThemeInfo will be returned to the completionHandler.
 

    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION





                          Quick Links Workflow Automation Data Collection
                          Web Forms Enterprise Begin Data Collection
                          Interactive Forms Workplace Data Collection App
                          CRM Forms Customer Service Accessible Forms
                          Digital Forms Marketing Forms for Small Business
                          HTML Forms Education Forms for Enterprise
                          Contact Forms E-commerce Forms for any business
                          Lead Generation Forms Healthcare Forms for Startups
                          Wordpress Forms Customer onboarding Order Forms for Small Business
                          No Code Forms Construction RSVP tool for holidays
                          Free Forms Travel
                          Prefill Forms Non-Profit

                          Intake Forms Legal
                          Mobile App
                          Form Designer HR
                          Mobile Forms
                          Card Forms Food Offline Forms
                          Assign Forms Photography
                          Mobile Forms Features
                          Translate Forms Real Estate Kiosk in Mobile Forms
                          Electronic Forms

                          Notification Emails for Forms Alternatives Security & Compliance
                          Holiday Forms Google Forms alternative  GDPR
                          Form to PDF Jotform alternative HIPAA Forms
                          Email Forms
                          Encrypted Forms
                          Embeddable Forms
                          Secure Forms
                          Drag and Drop form builder
                          WCAG


                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • Sample code snippets

                                                                                                                Below are code snippets that demonstrate how to use the different methods of Zoho Creator's SDK for iOS: To construct the FieldAccessPath To fetch a form object To fetch the choices from a field To submit a form To set a field's value To upload a ...
                                                                                                              • iOS SDK

                                                                                                                This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. Mobile Software Development Kits (mobile SDK) provide a set of software development tools that allow for a wide range of ...
                                                                                                              • Configure push notifications for your iOS app

                                                                                                                This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. As part of your Creator application’s workflows, you can configure push notifications. For these to work in your iOS app, ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources