NGngpvan

/people/{vanId}/canvassResponses/{referenceId}

Changed on

Use this endpoint to retrieve the canvass response associated with a given referenceId. A referenceId can only be obtained from a POST request to /people/{vanId}/canvassResponses, with the includeReferenceIdInResponse body parameter set to true. After a successful POST request, it may take up to 30 minutes for the new canvass response record to be created. If you attempt to use this endpoint to retrieve information about a canvass response record within 30 minutes of the initial POST, you may receive a 404: Not Found error response.

get/people/{vanId}/canvassResponses/{referenceId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/people/{vanId}/canvassResponses/{referenceId}
  • Auth
    HTTP basic

Path parameters

vanIdinteger required

Required; Unique person identifier available in the current context

referenceIdstring required

Required; Unique GUID found in the response body of POST /people/{vanId}/canvassResponses when includeReferenceIdInResponse is set to true.

Response

200

vanIdstring

Example response

{
  "vanId": "6297278",
  "canvassResponses": [
    {
      "canvassResponseId": 1530651,
      "canvassContext": {
        "contactTypeId": 37,
        "inputTypeId": 11,
        "dateCanvassed": "2023-06-01T11:06:00-04:00",
        "phone": {
          "phoneId": 6886215,
          "phoneNumber": "4567890100",
          "dialingPrefix": "1",
          "countryCode": "US",
          "dateCreated": "2023-06-16T13:09:00Z",
          "phoneType": "Home",
          "isCellStatus": {
            "statusId": 3,
            "statusName": "Likely Not a Cell"
          }
        }
      },
      "resultCodeId": 14,
      "externalReferenceId": "58F366C1-B215-46E8-AF45-7FD255DAE3B0"
    }
  ]
}

Changes