How-To: Dispatch a form via the API

Related Links

 

 

 

About

Dispatching via the API sends a dispatch message to the ProntoForms server, which in turn will dispatch that record to the user. Read more about the API here. Additionally, an overview of dispatching can be found here

To use this dispatching system, you will have to install an API add-on to your browser, such as via POSTMAN Chrome Plugin or RESTclient.

 

Dispatch via the API

  1. Ensure the form you would like to dispatch to is enabled to receive dispatches. For more, see the How to: Set up a form for dispatching.
  2. Launch the plugin. 
  3. Under the Basic Authorization tab, change the method to POST.

     Screenshot_2015-02-17_17.32.22.png

  4. Insert the URL <https://api.prontoforms.com/api/1/data/dispatch.xml> into the text box.

    Screenshot_2.png

  5.  Use the API Key as the Username and the API Key Secret as the Password.  If you do not have an API Key and Secret, read about Setting up an API Application on Prontoforms. Then, click Refresh Headers.  

     

    Screenshot_2015-02-17_17.18.47.png

  6. Under the raw heading, identify:

    • the ID of the form to dispatch to: <formId>FORM ID</formId>
    • the ID of the user who will receive the form: <userId>USER ID</userId> 
    • the Question Label of the question being filled, and the data to dispatch to that field: <answer label="QUESTION LABEL">ANSWER</answer> 

    Note: When using the API to dispatch data to a question that has been configured to "collect additional answers," the additional answers will NOT  be automatically populated in the form.  If it is essential that these values are pushed, it is up to the dispatcher to include the data in the dispatch.  


    Below is a sample of what the raw text will look like after form, user, question and response have been identified: 

    Screenshot_2015-02-17_16.30.32.png

  7. Tap Send. If successful, a Dispatch Result will appear complete with a Data ID and Reference Number.

      Screenshot_2015-02-17_17.41.58.png

[top]

Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request

Comments