Polls

Display a Poll

Display detailed information about a poll.

 

GET URL: http:/{endpoint}/poll/{Poll Id}

API Call: http://apiv1.scribblelive.com/poll/{Poll Id}/?Token={Api Token}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Poll Id true integer The ID of the poll being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Poll Votes

Make a vote for an answer in the poll. Limit 1 vote per IP per second.

 

GET URL: http:/{endpoint}/poll/{Poll Id}/vote

API Call: http://apiv1.scribblelive.com/poll/{Poll Id}/vote/?Token={Api Token}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Poll Id true integer The ID of the poll being accessed or modified.
Answer Id true integer The ID of the answer that is used to make a vote in the poll.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Open Poll

Open the poll.

 

GET URL: http:/{endpoint}/poll/{Poll Id}/open

API Call: http://apiv1.scribblelive.com/poll/{Poll Id}/open/?Token={Api Token}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Poll Id true integer The ID of the poll being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Close a Poll

Close the poll.

 

GET URL: http:/{endpoint}/poll/{Poll Id}/close

API Call: http://apiv1.scribblelive.com/poll/{Poll Id}/close/?Token={Api Token}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Poll Id true integer The ID of the poll being accessed or modified.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Create a Poll

Create a poll. Variable “EventId” is optional.

 

GET URL: http:/{endpoint}/poll/create

API Call: http://apiv1.scribblelive.com/poll/create/?Token={Api Token}&Question={Question}&Answers={CSV list of answers}&EventId={Event ID in which to post the poll}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Token  true  string  The token is a dedicated authorization key provided to the client to consume the API.
Question  true  string  The question to be used for the poll.
Answers  true  string  The answers that the poll will have. It must be entered as a list of Comma-separated values (CSV).
Event Id  –  integer  The ID of the event where the poll should be created.
Auth  true  string  The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format  –  string  Format of the data returned by the API call. Can be either “xml”, “json” or “html”.
Advertisements