How do I publish responses for display on Insight Pages or use via the API?

Tara Kieffer -

updated 07/16/14 JE

Introduction

The publishing API includes a public feed of moderated responses to PIN queries.   Four characteristics must be present in order for a response to be included in the publishing API.  

  1. The query must include the standard permission.

  2. The question on the query must be marked as Publishable

  3. The source has responded with a “Yes” to the permission question.  (This can be either in the initial submission or later modified by a user after follow-up with the source.)

  4. An AIR user has reviewed the response/submission and set it to be published.  


The steps below address the steps needed in AIR to publish responses.   Go here to find out more about how to consume the API.

Getting the query set up.

  1. When creating the query, drag one or more questions to the Publishable Field section of the query.  

  2. As long as at least one question is in the publishable fields section, the standard permission question will automatically be included in the query.

  3. Publish and share query.

 

What responses look like when they start coming in.

For queries marked public and with public questions, the submission status when first received in AIR will be determined by the response to the permission question.  


If the response to the permission question is “Yes,” the publishing status of the submission will be “Unpublished.”  The status for responses to publishable questions will be “Included for Publishing”



If the response to the permission question is not “Yes,” the publishing status of the submission will be marked as “Private.”   The status for responses to publishable questions will be “Excluded from Publishing”

What actions to take.

Note: all actions can be completed in the Submission Reader.

To Publish an Unpublished submission:

  1. Review submission

  2. Click “Included for Publishing” to remove any responses from the API.  This updates status to “Excluded from Publishing.”

  3. Click “Edit Response” to make any edits to the source’s response

  4. Click publishing status button or icon to update the status “Published”

To Publish a Private submission:

  1. Receive source’s permission through email or conversation.

  2. Click publishing status button or icon

  3. When prompted, confirm you would like to override the source’s response to the permission question.

  4. In the Edit Response box, for the permission question, type “Yes”

  5. Click Save (Publishing status should now display as “Nothing to Publish”)

  6. Review submission

  7. Click “Excluded from Publishing” to add one or more responses to the API (updates status to “Included for Publishing”).  

  8. Click “Edit Response” to make any edits to the source’s response

  9. Click publishing status button or icon to update the status “Published”


To Unpublish a Published submission:

  1. Click publishing status button or icon to update the status to “Unpublished”

To remove only a response from a submission:

  1. Click “Included for Publishing” to remove any responses from the API (updates status to “Excluded from Publishing”).

Note: if no responses in a submission have a “Included for Publishing” status, the submission publishing status will be “Nothing to Publish”

Statuses

Submission states

Query

Question

Source permission

Responses

Submission

Published

publishable

one or more publishable

yes

one or more included

approved

Unpublished   

publishable

one or more publishable

yes

one or more included

not approved

Nothing to publish  

publishable

one or more publishable

yes

all manually excluded

nothing to approve

Private

publishable

one or more publishable

no

n/a

nothing to approve

Unpublishable

publishable or not

none publishable

yes or no

n/a

nothing to approve


  • Published: Clicking the checkmark unpublishes the submission and sets to “Unpublished”
    Tooltip: Click to unpublish this submission

  • Unpublished: Clicking the checkbox sets the submission to “Published.”
    Tooltip: Click to publish this submission.

  • Nothing to publish: Clicking the disabled checkbox expands the submission. If user changes a response to “Included for Publishing,” submission is set to “Unpublished.”
    Tooltip: This submission cannot be published because there is nothing to approve. Please select responses to include.

  • Private: Clicking on the lock expands the submission and highlights permission question in edit mode. If user overrides source’s response to permission question, submission is set to “Nothing to publish.”
    Tooltip: Source has not given permission to publish this submission. If you’ve received permission, click to override.

  • Unpublishable: This status cannot be changed via the AIR UI
    Tooltip: This submission cannot be published because there are no publishable questions.

What is included in the Publishing API?

The following details from the source’s record are included when one or more of the source’s submissions have a Published status.  

First Name

Last Name

Postal code

City (if not included in the submission derived from the Postal code)

Country (if not included in the submission derived from the Postal code)

County (if not included in the submission derived from the Postal code)

State (if not included in the submission derived from the Postal code)

Latitude (if not included in the submission derived from the Postal code)

Longitude (if not included in the submission derived from the Postal code)


In addition, the query name, the questions, the published responses, when the response was received and when the response was last modified will be included in the API.


FAQs:

How quickly will changes take effect?

The publishing API uses a search index.  The changes should take effect within a few seconds.   If it is taking more than 5 minutes, please log a support ticket (support@publicinsightnetwork.org)


Will there be a history of the modified responses?

Only the latest version of the modified response will display.  You will be able to see who and when the response was last modified.   You will also always be able to have access to the original response.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk