Documentación de la API REST

[
	{
		"ID": 1549,
		"UUID": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx",
		"PUBLISHRESULTS": 1,
		"ELECTIONNAME": "Sample Election",
		"STARTDATE": "June, 06 2016 00:00:00",
		"ENDDATE": "June, 13 2016 23:59:00",
		"BIODEADLINE": "June, 03 2016 23:59:00"
	},
	{
		"ID": 1562,
		"UUID": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx",
		"PUBLISHRESULTS": 0,
		"ELECTIONNAME": "Demonstration Election",
		"STARTDATE": "June, 29 2016 00:00:00",
		"ENDDATE": "June, 29 2016 00:00:00",
		"BIODEADLINE": "June, 29 2016 00:00:00"
	}
]

[
	{
		"ID": 1549,
		"UUID": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx",
		"PUBLISHRESULTS": 1,
		"ELECTIONNAME": "Sample Election",
		"STARTDATE": "June, 06 2016 00:00:00",
		"ENDDATE": "June, 13 2016 23:59:00",
		"BIODEADLINE": "June, 03 2016 23:59:00"
	}
]

• VoterID es un identificador numérico único para cada votante.
• Voted es un valor booleano que indica el estado de votación de los votantes. False para quienes no han votado, true para quienes sí lo han hecho.
• VoterGroup debe ser una cadena vacía cuando no se asocian grupos de votantes con una elección. Sin embargo, cuando se utiliza, este parámetro debe coincidir con el código de grupo de votantes correspondiente definido en la configuración de la elección para los votantes que pertenecen a un grupo específico.
• SIGs, al igual que VoterGroup, debe ser una cadena vacía cuando no se usa. Cuando se utiliza, este parámetro debe coincidir con el código SIG asociado a cualquier cargo que deba incluirse en la papeleta para ese votante.
• Weight debe tener por defecto el valor 1, pero puede ser cualquier valor entero para reflejar el peso de la papeleta de un votante en casos donde algunas papeletas tienen más peso que otras.
• js es un parámetro booleano. True para navegadores que soportan JavaScript, false para aquellos que no. Esto afecta el comportamiento de las biografías de los candidatos.

• Papeleta se distingue en que es un fragmento de XML que se crea a partir de las selecciones realizadas por el votante en la página anterior. El siguiente ejemplo demuestra el formato de XML que debe generarse. Para fines de demostración, este ejemplo asume:
  1. La papeleta contiene los cargos Presidente (id = 8812) y Tesorero (id = 8813).
  2. El votante seleccionó a Robert Harrison para Presidente y a Terry McAllister para Tesorero.
  3. El votante no proporcionó comentarios, o los comentarios no están habilitados para ninguno de los cargos.
  Para crear este XML, debe analizar el alcance FORM creado cuando la papeleta es enviada por el votante en paso uno. Busque la variable del alcance FORM, positions. Esta lista de cargos en la papeleta, delimitada por comas, puede recorrerse en un bucle y durante cada iteración se crean los distintos nodos XML.

  ‹positions›
     ‹position›
        ‹positionID›pos8812‹/positionID›
        ‹candidates›Robert Harrison‹/candidates›
        ‹comments›‹/comments›
     ‹/position›
        ‹position›
        ‹positionID›pos8813‹/positionID›
        ‹candidates›Terry McAllister‹/candidates›
        ‹comments›‹/comments›
     ‹/position›
  ‹/positions›
  

• VoterID es un identificador numérico único para cada votante.
• Weight debe tener por defecto el valor 1, pero puede ser cualquier valor entero para reflejar el peso de la papeleta de un votante en casos donde algunas papeletas tienen más peso que otras.
• Languages es una cadena de texto delimitada por comas con los códigos de idiomas soportados por el sistema (en para inglés, es para español, de para alemán, fr para francés, it para italiano, ch para chino, br para portugués).

• Papeleta

  ‹positions›
     ‹position›
        ‹positionID›pos8812‹/positionID›
        ‹candidates›Robert Harrison‹/candidates›
        ‹comments›‹/comments›
     ‹/position›
        ‹position›
        ‹positionID›pos8813‹/positionID›
        ‹candidates›Terry McAllister‹/candidates›
        ‹comments›‹/comments›
     ‹/position›
  ‹/positions›
  

• VoterID es un identificador numérico único para cada votante.
• Weight debe tener por defecto el valor 1, pero puede ser cualquier valor entero para reflejar el peso de la papeleta de un votante en casos donde algunas papeletas tienen más peso que otras.
• VoterGroup es la misma variable utilizada en la representación de la papeleta de paso uno.
• SIGs es la misma variable utilizada en la representación de la papeleta de paso uno.
• custom1 es un parámetro opcional usado para enviar datos demográficos específicos del votante.
• custom2 es un parámetro opcional usado para enviar datos demográficos específicos del votante.
• custom3 es un parámetro opcional usado para enviar datos demográficos específicos del votante.
• custom4 es un parámetro opcional usado para enviar datos demográficos específicos del votante.
• Languages es una cadena de texto delimitada por comas con los códigos de idiomas soportados por el sistema (en para inglés, es para español, de para alemán, fr para francés, it para italiano, ch para chino, br para portugués).

POST /rest/v3/elections/{electionID}/ballot/step_three
Host: www.electionsonline.com
key: 08BF6D9D-YC16-72F4-385AD9AF30CCF877
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

ballot=‹positions›‹position›‹positionID›pos8812‹/positionID›‹candidates›Robert Harrison‹/candidates›‹comments›‹/comments›‹/position›‹position›‹positionID›pos8813‹/positionID›‹candidates›Terry McAllister‹/candidates›‹comments›‹/comments›‹ /position›‹/positions›&voterID=123&weight=1&voterGroup=&sigs=&custom1=&custom2=&custom3=&custom4=&languages=en

{
    "heading": "PHNwYW4gY2xhc3M9Imxhbmd1YWdlXzEiPkJhbGxvdCBhY2NlcHRlZDwvc3Bhbj4=",
    "message": "PHNwYW4gY2xhc3M9Imxhbmd1YWdlXzEiPlRoYW5rIHlvdS4gWW91ciBiYWxsb3Q
    	gaGFzIGJlZW4gYWNjZXB0ZWQuPC9zcGFuPg==",
    "status": "1",
    "ballot_id": "DSSYjuoBdDkJi2fjq3C1WL",
    "verify_heading": "PHNwYW4gY2xhc3M9Imxhbmd1YWdlXzEiPkJhbGxvdCB2ZXJpZmljYXRpb
    	248L3NwYW4+",
    "verify_message": "PHNwYW4gY2xhc3M9Imxhbmd1YWdlXzEiPihPcHRpb25hbCkgVmVyaWZ5a
    	W5nIHRoaXMgYmFsbG90IGxhdGVyIHJlcXVpcmVzIHNhdmluZyBkYXRhIGFib3V0IGl0IHJpZ
        2h0IG5vdy48L3NwYW4+",
    "verify_button": "PHNwYW4gY2xhc3M9Imxhbmd1YWdlXzEiPkdldCB2ZXJpZmljYXRpb24g
    	ZGF0YTwvc3Bhbj4="
}

[
    {
        "ID": 2891481,
        "FIRSTNAME": "Pete",
        "LASTNAME": "Lopez",
        "EMAIL": "lopez@phony-domain.net",
        "WEIGHT": 1.0000,
        "VOTERGROUP": null,
        "SIGS": null,
        "ROLES": "voter",
        "VOTED": 1,
        "CUSTOM1": null,
        "CUSTOM2": null,
        "CUSTOM3": null,
        "CUSTOM4": null,
        "LANGUAGE": null,
        "OTP_TYPE": "s",
        "STATIC_OTP": 109379
    },
    {
        "ID": 2891486,
        "FIRSTNAME": "Jimmy",
        "LASTNAME": "Roberts",
        "EMAIL": "jimmy@phony-domain.tech",
        "WEIGHT": 1.0000,
        "VOTERGROUP": null,
        "SIGS": null,
        "ROLES": "voter",
        "VOTED": 0,
        "CUSTOM1": null,
        "CUSTOM2": null,
        "CUSTOM3": null,
        "CUSTOM4": null,
        "LANGUAGE": null,
        "OTP_TYPE": null,
        "STATIC_OTP": null
    }
]

{
    "sigs": null,
    "email": "terry@phony-domain.net",
    "voted": 0,
    "weight": 1.0000,
    "custom1": null,
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "language": null,
    "otp_type": null,
    "voter_id": 2891501,
    "last_name": "McMurray",
    "first_name": "Terry",
    "voter_group": "student"
}

6103,4982,1085,10876,2374,1984

La respuesta es un objeto JSON (ver Respuesta de ejemplo más abajo) que contiene tres claves. Los valores asociados a esas claves dependen de la respuesta de este endpoint. Cuando este endpoint emite un token, la clave token_issued tendrá el valor yes y la clave token contendrá el token que puede usar para autenticar al votante y dirigirlo a la papeleta. Haga esto redirigiendo la solicitud a la siguiente URL proporcionando el token de la respuesta como valor del parámetro token. Por ejemplo:

https://www.electionsonline.com/vote/login.cfm?token=xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx.

En otros casos, por ejemplo si el votante ya ha votado, aparecerá un mensaje al respecto en la clave message y token estará vacío.

En la solicitud de ejemplo que se muestra a continuación, los cuatro campos custom al final de la cadena de pares nombre/valor son todos opcionales. Inclúyalos si desea enviar datos demográficos personalizados del votante al sistema. De lo contrario, pueden omitirse.

{
        "Token": "f3de9ee1-c143-11ee-8cac-74867a213c83",
        "Message": "",
        "token_issued": "yes"
}