Action Network

Question Answers Version 1

Note: This documentation describes Version 1 of our API, which is now depreciated. It will continue to work, but it will not reveive any updates or bug fixes. We recommend you use Version 2 instead. In Version 2, question answers (and questions) have been removed, and are replaced by custom field hash objects on person resources. Documentation for people for Version 2 of our API is available here.

This document describes the OSDI question answers collection and question answer resource as implemented by the Action Network.

Question answers represent answers people have given to questions. Question answers map to the values of the Action Network's custom form field system, so entries on named HTML inputs will show up in the API as question answers, and the values of custom column headings on uploads will show up as question answers as well.

Question answers have values and other fields, and are linked to the question they are answering and the person who answered it.

Note: Question answers are deduplicated on person, so a person cannot answer the same question twice.

Sections:

Endpoints and URL structures
Field names and descriptions
Links
Scenario: Retrieving a collection of question answer resources (GET)
Scenario: Retrieving an individual question answer resource (GET)
Scenario: Creating a new question answer (POST)
Scenario: Modifying a question answer (PUT)
Scenario: Deleting a question answer (DELETE)

Endpoints and URL structures

Endpoints:

https://actionnetwork.org/api/v1/questions/[question_id]/question_answers

https://actionnetwork.org/api/v1/forms/[forms_id]/submissions/[submission_id]/question_answers

https://actionnetwork.org/api/v1/people/[person_id]/question_answers

Question answer resources live at endpoints relating to the person who answered the question, the submission they created when answering the question, and the question they answered. The endpoints return a collection of all question answers associated with that person, question, or submission.

URL Structures:

https://actionnetwork.org/api/v1/questions/[question_id]/question_answers/[question_answer_id]

https://actionnetwork.org/api/v1/forms/[form_id]/submissions/[submission_id]/question_answers/[question_answer_id]

https://actionnetwork.org/api/v1/people/[person_id]/question_answers/[question_answer_id]

To address a specific question_answer, use the identifier without the action_network: prefix to construct a URL, like https://actionnetwork.org/api/v1/questions/d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3/question_answers/167ce1d2-70b7-423e-b480-914981cbeaff

Field names and descriptions

Field Name	Type	Required on POST	Description
identifiers	array[]		An array of identifiers in the format `[system name]:[id]`. See the general concepts document for more information about identifiers.
originating_system	string	Yes	A human readable string identifying where this question answer originated. May be used in the user interface for this purpose.
created_at	datetime		The date and time the resource was created. System generated, not editable.
modified_at	datetime		The date and time the resource was last modified. System generated, not editable.
value	string	Yes	The actual question answer response from the person.
person_id	string		The identifier of the person associated with this question answer. Not editable.
question_id	string		The identifier of the question associated with this question answer. Not editable.
osdi:question	osdi:question*		The question this question answer is related to. An embedded question resource.

Links

Link Name	Description
self	A link to this individual question resource.
osdi:question	A link to the question associated with this question answer. Click here for questions documentation.
osdi:person	A link to the person associated with this question answer. Click here for people documentation.

Scenario: Retrieving a collection of question answer resources (GET)

Question answer resources are sometimes presented as collections of question answers. For example, calling the question answers endpoint on a specific question will return a collection of all the question answers associated that question.

Request

						
GET https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers

Header:
api-key:[your api key here]

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


{
  "total_pages": 1,
  "per_page": 25,
  "page": 1,
  "total_records": 20,
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers"
    },
    "osdi:question_answers": [
      {
        "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/b9556b93-4be3-48c6-991d-1b5809c5472e"
      },
      {
        "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/c89ea9a5-898f-4a05-a09e-3de352272c74"
      },
      //truncated for brevity
    ],
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      }
    ]
  },
  "_embedded": {
    "osdi:question_answers": [
      {
        "identifiers": [
          "action_network:b9556b93-4be3-48c6-991d-1b5809c5472e"
        ],
        "originating_system": "Action Network",
        "value": "This is my story",
        "person_id": "17be9a36-bb9a-4f68-94a8-40523b9dab27",
        "question_id": "6ca859fc-4801-4aad-8d4b-c793826ba4c3",
        "_embedded": {
          "osdi:question": {
            "identifiers": [
              "action_network:6ca859fc-4801-4aad-8d4b-c793826ba4c3"
            ],
            "originating_system": "Action Network",
            "name": "Your story",
            "question_type": "Paragraph",
            "created_at": "2014-03-27T14:24:22Z",
            "modified_at": "2014-03-27T14:24:22Z",
            "_links": {
              "self": {
                "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
              },
              "osdi:question_answers": {
                "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers"
              }
            }
          }
        },
        "created_at": "2014-03-27T14:28:17Z",
        "modified_at": "2014-03-27T14:28:17Z",
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/b9556b93-4be3-48c6-991d-1b5809c5472e"
          },
          "osdi:question": {
            "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
          },
          "osdi:person": {
            "href": "https://actionnetwork.org/api/v1/people/17be9a36-bb9a-4f68-94a8-40523b9dab27"
          }
        }
      },
      {
        "identifiers": [
          "action_network:c89ea9a5-898f-4a05-a09e-3de352272c74"
        ],
        "originating_system": "Action Network",
        "value": "My story is really long.",
        "person_id": "a1ea6af0-ae1f-43be-8b72-5e483407e083",
        "question_id": "6ca859fc-4801-4aad-8d4b-c793826ba4c3",
        "_embedded": {
          "osdi:question": {
            "identifiers": [
              "action_network:6ca859fc-4801-4aad-8d4b-c793826ba4c3"
            ],
            "originating_system": "Action Network",
            "name": "Your story",
            "question_type": "Paragraph",
            "created_at": "2014-03-27T14:24:22Z",
            "modified_at": "2014-03-27T14:24:22Z",
            "_links": {
              "self": {
                "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
              },
              "osdi:question_answers": {
                "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers"
              }
            }
          }
        },
        "created_at": "2014-03-27T14:24:22Z",
        "modified_at": "2014-03-27T14:24:22Z",
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/c89ea9a5-898f-4a05-a09e-3de352272c74"
          },
          "osdi:question": {
            "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
          },
          "osdi:person": {
            "href": "https://actionnetwork.org/api/v1/people/a1ea6af0-ae1f-43be-8b72-5e483407e083"
          }
        }
      },
      //truncated for brevity
    ]
  }
}

Scenario: Retrieving an individual question answer resource (GET)

Calling an individual question answer resource will return the resource directly, along with all associated fields and appropriate links to additional information about the question answer.

Request

						
GET https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/b9556b93-4be3-48c6-991d-1b5809c5472e

Header:
api-key:[your api key here]

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


{
  "identifiers": [
    "action_network:b9556b93-4be3-48c6-991d-1b5809c5472e"
  ],
  "originating_system": "Action Network",
  "value": "This is my story",
  "person_id": "17be9a36-bb9a-4f68-94a8-40523b9dab27",
  "question_id": "6ca859fc-4801-4aad-8d4b-c793826ba4c3",
  "_embedded": {
    "osdi:question": {
      "identifiers": [
        "action_network:6ca859fc-4801-4aad-8d4b-c793826ba4c3"
      ],
      "name": "Your story",
      "originating_system": "Action Network",
      "question_type": "Paragraph",
      "created_at": "2014-03-27T14:24:22Z",
      "modified_at": "2014-03-27T14:24:22Z",
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
        },
        "osdi:question_answers": {
          "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers"
        },
        "curies": [
          {
            "name": "osdi",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          },
          {
            "name": "action_network",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          }
        ]
      }
    }
  },
  "created_at": "2014-03-27T14:28:17Z",
  "modified_at": "2014-03-27T14:28:17Z",
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/b9556b93-4be3-48c6-991d-1b5809c5472e"
    },
    "osdi:question": {
      "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
    },
    "osdi:person": {
      "href": "https://actionnetwork.org/api/v1/people/17be9a36-bb9a-4f68-94a8-40523b9dab27"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      }
    ]
  }
}

Scenario: Creating a new question answer (POST)

You can post a new question answer in three ways. First, you can post to the question_answers endpoint of a question resource and link to an existing person -- this will create a new question answer associated with that question and person. Or, you can post to the question_answers endpoint of a submission and link to an existing question. This will create a new question answer associated with that submission and the linked question. Finally, you can create a new question and question answer inline (and optionally a person) when you post a new submission on a form using the record_submission_helper endpoint and key/value pairs.

Here is an example of posting a new question answer to the question_answers endpoint of a specific question and linking to an existing person:

Request

						
POST https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/

Header:
Content-Type: application/json
api-key:[your api key here]
						

{	
  "identifiers": [
    "free_question_answers:1"
  ],
  "value": "My story is important, listen now!",
  "originating_system": "FreeQuestionAnswers.com",
  "_links" : {
    "osdi:person" : { 
      "href" : "https://actionnetwork.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29" 
    }
  }
}

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


{
  "identifiers": [
    "free_question_answers:1",
    "action_network:379a7d52-f191-4871-8898-fb3573c284a5"
  ],
  "originating_system": "FreeQuestionAnswers.com",
  "value": "My story is important, listen now!",
  "person_id": "c945d6fe-929e-11e3-a2e9-12313d316c29",
  "question_id": "6ca859fc-4801-4aad-8d4b-c793826ba4c3",
  "_embedded": {
    "osdi:question": {
      "identifiers": [
        "action_network:6ca859fc-4801-4aad-8d4b-c793826ba4c3"
      ],
      "originating_system": "Action Network",
      "name": "Your story",
      "question_type": "Paragraph",
      "created_at": "2014-03-27T14:24:22Z",
      "modified_at": "2014-03-27T14:24:22Z",
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
        },
        "osdi:question_answers": {
          "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers"
        },
        "curies": [
          {
            "name": "osdi",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          },
          {
            "name": "action_network",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          }
        ]
      }
    }
  },
  "created_at": "2014-03-27T20:35:14Z",
  "modified_at": "2014-03-27T20:35:14Z",
  "_links": {
    "osdi:person": {
      "href": "https://actionnetwork.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
    },
    "self": {
      "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/379a7d52-f191-4871-8898-fb3573c284a5"
    },
    "osdi:question": {
      "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      }
    ]
  }
}

In the above example, you can see how the foreign identifier being posted is merged into the identifiers array. We will intelligently search and deduplicate based on foreign and native identifiers. So if you post a question answer with an identifier that matches one already assigned to a question answer resource, your POST request will update that resource with new information instead of creating a duplicate.

Question answers are deduplicated on person, so a person cannot have more than one answer to a question. If you post a new question answer associated with the same person as an existing one, we will replace the old question answer with the new one.

This is an example of posting a question answer on a the question_answers endpoint of a submission and linking to an existing question. For more information about submissions, please see the submissions documentation page.

Request

						
POST https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/c449e8cd-0a81-42d1-91f7-47cacf33dbe4/question_answers

Header:
Content-Type: application/json
api-key:[your api key here]
						

{
  "value":"This is my story.",
  "originating_system":"FreeForms.com",
  "_links": {
    "osdi:question": {
      "href": "https://actionnetwork.org/api/v1/questions/5587b89e-68ce-4b18-8484-60f5b220a3a1"
    }
  }
}

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


{
  "identifiers": [
    "action_network:1da7ab65-a28e-4284-9092-540c6bac6ddf"
  ],
  "value":"This is my story.",
  "originating_system":"FreeForms.com",
  "person_id": "17be9a36-bb9a-4f68-94a8-40523b9dab27",
  "question_id": "5587b89e-68ce-4b18-8484-60f5b220a3a1",
  "_embedded": {
    "osdi:question": {
      "identifiers": [
        "action_network:5587b89e-68ce-4b18-8484-60f5b220a3a1"
      ],
      "name": "Tell your story",
      "question_type": "Paragraph",
      "originating_system":"FreeForms.com",
      "created_at": "2014-03-21T23:44:56Z",
      "modified_at": "2014-03-21T23:44:56Z",
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v1/questions/5587b89e-68ce-4b18-8484-60f5b220a3a1"
        },
        "osdi:question_answers": {
          "href": "https://actionnetwork.org/api/v1/questions/5587b89e-68ce-4b18-8484-60f5b220a3a1/question_answers"
        },
        "curies": [
          {
            "name": "osdi",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          },
          {
            "name": "action_network",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          }
        ]
      }
    }
  },
  "created_at": "2014-03-27T14:16:08Z",
  "modified_at": "2014-03-27T14:16:08Z",
  "_links": {
    "osdi:question": {
      "href": "https://actionnetwork.org/api/v1/questions/5587b89e-68ce-4b18-8484-60f5b220a3a1"
    },
    "self": {
      "href": "https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/c449e8cd-0a81-42d1-91f7-47cacf33dbe4/question_answers/1da7ab65-a28e-4284-9092-540c6bac6ddf"
    },
    "osdi:person": {
      "href": "https://actionnetwork.org/api/v1/people/17be9a36-bb9a-4f68-94a8-40523b9dab27"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      }
    ]
  }
}

The new question answer is now associated with the person who made this submission as well as the question that was linked on post.

Here is an example of posting a submission, person, and question answers all at the same time using the record_submission_helper endpoint and key/value pairs.

Request

						
PUT https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/c449e8cd-0a81-42d1-91f7-47cacf33dbe4/question_answers

Header:
Content-Type: application/json
api-key:[your api key here]
						

{
  "originating_system" : "FreeForms.com",
  "action_network:question_answers" : {
    "I am a parent" : "true",
    "Your story" : "This is my story"
  },
  "person" : {
    "family_name" : "Smith",
    "given_name" : "John",
    "postal_addresses" : [ { "postal_code" : "20009" }],
    "email_addresses" : [ { "address" : "jsmith@mail.com" }]
  } 
}

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


{
  "identifiers": [
    "action_network:a59557b8-316c-4d9b-9b7a-b9be2aac4b2a"
  ],
  "originating_system": "FreeForms.com",
  "created_at": "2014-03-27T14:24:22Z",
  "modified_at": "2014-03-27T14:24:22Z",
  "action:person_id": "a1ea6af0-ae1f-43be-8b72-5e483407e083",
  "action_network:form_id": "adb951cb-51f9-420e-b7e6-de953195ec86",
  "_embedded": {
    "osdi:question_answers": [
      {
        "identifiers": [
          "action_network:22cebb5b-0216-4141-96bf-515e7e6d9a48"
        ],
        "originating_system": "FreeForms.com",
        "value": "true",
        "person_id": "a1ea6af0-ae1f-43be-8b72-5e483407e083",
        "question_id": "16a5adba-e356-4476-a9f4-3ce0ebd41b6c",
        "_embedded": {
          "osdi:question": {
            "identifiers": [
              "action_network:16a5adba-e356-4476-a9f4-3ce0ebd41b6c"
            ],
            "name": "I am a parent",
            "question_type": "Paragraph",
            "created_at": "2014-03-27T14:24:22Z",
            "modified_at": "2014-03-27T14:24:22Z",
            "originating_system": "FreeForms.com",
            "_links": {
              "self": {
                "href": "https://actionnetwork.org/api/v1/questions/16a5adba-e356-4476-a9f4-3ce0ebd41b6c"
              },
              "osdi:question_answers": {
                "href": "https://actionnetwork.org/api/v1/questions/16a5adba-e356-4476-a9f4-3ce0ebd41b6c/question_answers"
              },
              "curies": [
                {
                  "name": "osdi",
                  "href": "https://actionnetwork.org/docs/v1/{rel}",
                  "templated": true
                },
                {
                  "name": "action_network",
                  "href": "https://actionnetwork.org/docs/v1/{rel}",
                  "templated": true
                }
              ]
            }
          }
        },
        "created_at": "2014-03-27T14:24:22Z",
        "modified_at": "2014-03-27T14:24:22Z",
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/question_answers/22cebb5b-0216-4141-96bf-515e7e6d9a48"
          },
          "osdi:question": {
            "href": "https://actionnetwork.org/api/v1/questions/16a5adba-e356-4476-a9f4-3ce0ebd41b6c"
          },
          "osdi:person": {
            "href": "https://actionnetwork.org/api/v1/people/a1ea6af0-ae1f-43be-8b72-5e483407e083"
          },
          "curies": [
            {
              "name": "osdi",
              "href": "https://actionnetwork.org/docs/v1/{rel}",
              "templated": true
            },
            {
              "name": "action_network",
              "href": "https://actionnetwork.org/docs/v1/{rel}",
              "templated": true
            }
          ]
        }
      },
      {
        "identifiers": [
          "action_network:c89ea9a5-898f-4a05-a09e-3de352272c74"
        ],
        "value": "This is my story",
        "originating_system": "FreeForms.com",
        "person_id": "a1ea6af0-ae1f-43be-8b72-5e483407e083",
        "question_id": "6ca859fc-4801-4aad-8d4b-c793826ba4c3",
        "_embedded": {
          "osdi:question": {
            "identifiers": [
              "action_network:6ca859fc-4801-4aad-8d4b-c793826ba4c3"
            ],
            "name": "Your story",
            "originating_system": "FreeForms.com",
            "question_type": "Paragraph",
            "created_at": "2014-03-27T14:24:22Z",
            "modified_at": "2014-03-27T14:24:22Z",
            "_links": {
              "self": {
                "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
              },
              "osdi:question_answers": {
                "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers"
              },
              "curies": [
                {
                  "name": "osdi",
                  "href": "https://actionnetwork.org/docs/v1/{rel}",
                  "templated": true
                },
                {
                  "name": "action_network",
                  "href": "https://actionnetwork.org/docs/v1/{rel}",
                  "templated": true
                }
              ]
            }
          }
        },
        "created_at": "2014-03-27T14:24:22Z",
        "modified_at": "2014-03-27T14:24:22Z",
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/question_answers/c89ea9a5-898f-4a05-a09e-3de352272c74"
          },
          "osdi:question": {
            "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
          },
          "osdi:person": {
            "href": "https://actionnetwork.org/api/v1/people/a1ea6af0-ae1f-43be-8b72-5e483407e083"
          },
          "curies": [
            {
              "name": "osdi",
              "href": "https://actionnetwork.org/docs/v1/{rel}",
              "templated": true
            },
            {
              "name": "action_network",
              "href": "https://actionnetwork.org/docs/v1/{rel}",
              "templated": true
            }
          ]
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/a59557b8-316c-4d9b-9b7a-b9be2aac4b2a"
    },
    "osdi:form": {
      "href": "https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86"
    },
    "osdi:person": {
      "href": "https://actionnetwork.org/api/v1/people/a1ea6af0-ae1f-43be-8b72-5e483407e083"
    },
    "osdi:question_answers": {
      "href": "https://actionnetwork.org/api/v1/forms/adb951cb-51f9-420e-b7e6-de953195ec86/submissions/a59557b8-316c-4d9b-9b7a-b9be2aac4b2a/question_answers"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      }
    ]
  }
}

In this example, a new person was created, a new submission for that person on this form was created, and new questions and question answers also created and linked to the new person and submission.

Scenario: Modifying a question answer (PUT)

You can modify an existing question answer by using PUT on its individual endpoint.

Request

						
PUT https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/379a7d52-f191-4871-8898-fb3573c284a5

Header:
Content-Type: application/json
api-key:[your api key here]
						

{	
  "identifiers": [
    "free_question_answers:2"
  ]
}

Response

						
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate


{
  "identifiers": [
    "free_question_answers:1",
    "action_network:379a7d52-f191-4871-8898-fb3573c284a5",
    "free_question_answers:2"
  ],
  "originating_system": "FreeQuestionAnswers.com",
  "value": "My story is important, listen now!",
  "person_id": "c945d6fe-929e-11e3-a2e9-12313d316c29",
  "question_id": "6ca859fc-4801-4aad-8d4b-c793826ba4c3",
  "_embedded": {
    "osdi:question": {
      "identifiers": [
        "action_network:6ca859fc-4801-4aad-8d4b-c793826ba4c3"
      ],
      "originating_system": "Action Network",
      "name": "Your story",
      "question_type": "Paragraph",
      "created_at": "2014-03-27T14:24:22Z",
      "modified_at": "2014-03-27T14:24:22Z",
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
        },
        "osdi:question_answers": {
          "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers"
        },
        "curies": [
          {
            "name": "osdi",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          },
          {
            "name": "action_network",
            "href": "https://actionnetwork.org/docs/v1/{rel}",
            "templated": true
          }
        ]
      }
    }
  },
  "created_at": "2014-03-27T20:35:14Z",
  "modified_at": "2014-03-27T20:35:14Z",
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3/question_answers/379a7d52-f191-4871-8898-fb3573c284a5"
    },
    "osdi:question": {
      "href": "https://actionnetwork.org/api/v1/questions/6ca859fc-4801-4aad-8d4b-c793826ba4c3"
    },
    "osdi:person": {
      "href": "https://actionnetwork.org/api/v1/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v1/{rel}",
        "templated": true
      }
    ]
  }
}

The above example added a new identifier to the question answer.

Editing of certain fields via PUT is not allowed, and is noted in the field names table above. For example, you can't change the person a question is associated with. Invalid entries will be ignored.

Scenario: Deleting a question answer (DELETE)

Deleting question answers is not allowed via the API. DELETE requests will return an error.

Question Answers Version 1

Sections:

Endpoints and URL structures

Field names and descriptions

Links

Scenario: Retrieving a collection of question answer resources (GET)

Scenario: Retrieving an individual question answer resource (GET)

Scenario: Creating a new question answer (POST)

Scenario: Modifying a question answer (PUT)

Scenario: Deleting a question answer (DELETE)

Action Network API Documentation