NGngpvan

/people/{personIdType}:{personId}/canvassResponses

Changed on

This endpoint is the same as POST /people/{vanId}/canvassResponses but uses external IDs rather than VANIDs.

post/people/{personIdType}:{personId}/canvassResponses

Request

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

Path parameters

personIdTypestring required

Required; a known person identifier type available in the current context

personIdstring required

Required; an external identifier, URL encoded

Request body

resultCodeIdinteger

Optional; specifies the Result Code of this Response. If no resultCodeId is specified, responses must be specified. Conversely, if responses are specified, resultCodeId must be null (a result of Canvassed is implied). The resultCodeId must be a valid Result Code in the current context.

Response

200

referenceIdstring

Example response

{
  "referenceId": "b958d667-8f88-498f-8a2d-559fdd8f145d"
}

Changes