Events API

Events API Documentation

Authentication

Every action to endpoints require a KEY. Make sure that you include this key in all operations. Click the button below to generate one.

Get your key here »

This key will set to expire after 24 hours. Simply generate a new key once yours has already expired.

API Address

Below is the base URL for all the operations:

https://api.polzki.com/api/

Quick Start

All calls to the API are using HTTP GET. They are all simple enough to be called directly through your browser address bar. Below is a simple call to the API:

https://api.polzki.com/api/events?key=[YOUR_KEY_HERE]

The result should be the following:

                    
{
  "Status": "success",
  "Message": "",
  "Data": [
    {
      "ID": "63bce3a078ff22f8f59acd9c",
      "EventName": "ASP.NET, C# and MVC Basics"
    },
    {
      "ID": "63bce3e078ff22f8f59acd9e",
      "EventName": "Javascript Frameworks For Beginners"
    },
    {
      "ID": "63bce3f478ff22f8f59acd9f",
      "EventName": "Web Application Security and Tactics"
    },
    {
      "ID": "63bce40d78ff22f8f59acda0",
      "EventName": "NodeJS Development BootCamp"
    }
  ]
}

Using the API

Perform any action just by calling an HTTP call to the API. All results will be JSON formatted just like below.

                
{
  "Status": "success",
  "Message": "",
  "Data": DYNAMIC-RESULT
}

Field	Definition
Status	"success" means the intended operation was successful "fail" operation did not execute properly
Message	Contains some context on of the status. It may also contain the error message why an operation has failed
Data	This part is dynamic. Depending on the operation, this field may or may not contain any content.

Event Data Structure

                    
{
    "ID": "63bce3a078ff22f8f59acd9c",
    "EventName": "ASP.NET, C# and MVC Basics"
}

Field	Definition
ID	The unique identifier of an event. Also called EventID
EventName	The full name of the Event

Attendee Data Structure

                    
{
    "ID": "63c0fb85022774ed905977e7",
    "Name": "Avocado Dragonfruit",
    "Email": "avocado.dragonfruit@46f88.818",
    "RegisterDate": "/Date(-62135596800000)/",
    "Event": {
        "ID": "63bce3f478ff22f8f59acd9f",
        "EventName": "Web Application Security and Tactics"
    }
}

Field	Definition
ID	The unique identifier of an event. Also called AttendeeID
Name	The name of the attendee
Email	The Email Address of the attendee
RegisterDate	The timestamp when the registration was made
Event	The event object bearing the Event data structure

ACTION: Get All Events

/api/events

Call Structure:

https://api.polzki.com/api/events?key=[YOUR_KEY_HERE]

Parameters:

Field	Definition
Key	Your API Key

ACTION: Get All Attendees

/api/attendees

Call Structure:

https://api.polzki.com/api/attendees?key=[YOUR_KEY_HERE]

Parameters:

Field	Definition
Key	Your API Key

ACTION: Get Single Attendee by ID

/api/attendee

Call Structure:

https://api.polzki.com/api/attendee?key=[YOUR_KEY_HERE]&attendeeid=[AttendeeID]

Parameters:

Field	Definition
Key	Your API Key
AttendeeID	The ID of an attendee that can be found on your attendee object

ACTION: ADD AN ATTENDEE

/api/addattendee

Call Structure:

https://api.polzki.com/api/addattendee?key=[YOUR_KEY_HERE]&Name=[ATTENDEE_NAME]&Email=[EMAILADDRESS]&EventID=[EVENTID]

Parameters:

Field	Definition
Key	Your API Key
Name	The name of the attendee
Email	The Email Address of the attendee
EventID	The unique identifier of an event.

ACTION: UPDATE AN ATTENDEE

/api/updateattendee

Call Structure:

https://api.polzki.com/api/updateattendee?key=[YOUR_KEY_HERE]&AttendeeID=[ATTENDEEID]&Name=[ATTENDEE_NAME]&EventID=[EVENTID]

Parameters:

Field	Definition
Key	Your API Key
AttendeeID	The ID of the Attendee you wish to update
Name	The name of the attendee
EventID	The unique identifier of an event.

You cannot edit the email address.

ACTION: DELETE AN ATTENDEE

/api/deleteattendee

Call Structure:

https://api.polzki.com/api/deleteattendee?key=[YOUR_KEY_HERE]&AttendeeID=[ATTENDEEID]

Parameters:

Field	Definition
Key	Your API Key
AttendeeID	The ID of the Attendee you wish to update