NGngpvan

/activistCodes/{activistCodeId}

Use this endpoint to retrieve information about a specific Activist Code available in the current context.

get/activistCodes/{activistCodeId}

Request

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

Path parameters

activistCodeIdinteger required

Required; unique identifier for a specific Activist Code. This is either an integer or a VAN encoded identifier (e.g., EID28CG).

Response

200

activistCodeIdinteger
typestring
namestring
mediumNamestring
shortNamestring
descriptionstring
scriptQuestionstring
statusstring

Example response

{
  "activistCodeId": 3214,
  "type": "Volunteer",
  "name": "Precinct Captain",
  "mediumName": "P Capt",
  "shortName": "PC",
  "description": "Precinct Captain",
  "scriptQuestion": "Would you be willing to be a Precinct Captain?",
  "status": "Active"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.