NGngpvan

/canvassFileRequests/{canvassFileRequestId}

Changed on

Is identical to the message which is sent to the canvass file request's webhook, if found.

get/canvassFileRequests/{canvassFileRequestId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/canvassFileRequests/{canvassFileRequestId}
  • Auth
    HTTP basic

Path parameters

canvassFileRequestIdinteger required

The ID of the canvass file request

Response

200

canvassFileRequestIdinteger
canvassFileRequestGuidstring
savedListIdinteger
webhookUrlstring
downloadUrlstring
statusstring
typeinteger
dateExpiredstring
errorCodeunknown

Example response

{
  "canvassFileRequestId": 123,
  "canvassFileRequestGuid": "DC7309A7-19F5-4DC7-8437-33FDBBADC2DA",
  "savedListId": 555888,
  "webhookUrl": "https://webhook.example.org/canvassFileRequests",
  "downloadUrl": "https://vancanvassfiles.blob.core.windows.net/canvass-file/DC7309A7-2012-05-05T10:18:43.6007964-04:00.csv",
  "status": "Completed",
  "type": 102,
  "dateExpired": "2012-05-05T12:18:43.6007964-04:00"
}

Changes