Base URL:

https://31events.sitegen.ws/api/index.cfm

Content-Type response header:

application/json

PHP SDK:

https://31events.sitegen.ws/api/phpsdk/sdk.zip

SDK Description here


Resources:

Authenticate DELETE PUT POST GET /authenticate

Path:
Body:
 
Response:
Authenticates a customer with username and password

returns
an object containing an authorization token for subsequent requests
required data
{"token":"<UUID>"}
post body
an object containing username and password
required data
{"username":"<username>","password":"<password>"}

EventCreate DELETE PUT POST GET /event

Path:
Body:
Token:
 
Response:
Creates an event based on the data passed

returns
an object containing the id of the new event
required data
{"event_id":"<event_id>"}
post body
an object containing the event data
required data
{
"event_title": "Event Title",
"event_subject": "Email Subject",
"event_content": "Email Content",
"event_location": "Event Location",
"event_timezone": "Event Timezone",
"event_dateStart": "Event Start Date and Time",
"event_dateEnd": "Event Start Date and Time",
"event_reminder": Reminder in Minutes,
"event_issueTickets": Whether to Issue Tickets,
"event_ticketResponseContent": "Event Notes Printed on Tickets",
"event_hostName": "Host Name Printed on Tickets",
"event_hostEmail": "Host Email Printed on Tickets",
"event_hostCompany": "Host Company Printed on Tickets",
"event_hostPhone": "Host Phone Printed on Tickets"
}
header
authetication token
required Token
<UUID>

EventSend DELETE PUT POST GET /event/{event_id}

Path:
Token:
 
Response:
Sends the event

returns
an object containing the id of the sent event
required data
{"event_id":"<event_id>"}
header
authetication token
required Token
<UUID>

EventUpdate DELETE PUT POST GET /event/{event_id}

Path:
Body:
Token:
 
Response:
Updates an event based on the data passed

returns
an object containing the id of the updated event
required data
{"event_id":"<event_id>"}
post body
an object containing the event data
required data
{
"event_title": "Event Title",
"event_subject": "Email Subject",
"event_content": "Email Content",
"event_location": "Event Location",
"event_timezone": "Event Timezone",
"event_dateStart": "Event Start Date and Time",
"event_dateEnd": "Event Start Date and Time",
"event_reminder": Reminder in Minutes,
"event_issueTickets": Whether to Issue Tickets,
"event_ticketResponseContent": "Event Notes Printed on Tickets",
"event_hostName": "Host Name Printed on Tickets",
"event_hostEmail": "Host Email Printed on Tickets",
"event_hostCompany": "Host Company Printed on Tickets",
"event_hostPhone": "Host Phone Printed on Tickets"
}
path
event id
required event_id
<event_id>
header
authetication token
required Token
<UUID>

EventGet DELETE PUT POST GET /event/{event_id}

Path:
Token:
 
Response:
Returns an event based on the id passed

returns
an object containing the event data
required data
{"event_id":"<event_id>","event_title":"<event_title>",...}
path
event id
required event_id
<event_id>
header
authetication token
required Token
<UUID>

EventList DELETE PUT POST GET /event/list

Path:
Token:
 
Response:
Returns a list of events created by the customer

returns
an array of objects containing the events data
required data
[{"event_id":"<event_id>","event_title":"<event_title>",...},...]
header
authetication token
required Token
<UUID>

EventDelete DELETE PUT POST GET /event/{event_id}

Path:
Token:
 
Response:
Deletes an event based on the id passed

returns
an object containing the id of the deleted event
required data
{"event_id":"<event_id>"}
path
event id
required event_id
<event_id>
header
authetication token
required Token
<UUID>

EventSubscribe DELETE PUT POST GET /event/{event_id}/subscribe/{email}

Path:
 
Response:
Subscibes the email passed to the event passed

returns
an object containing the status message
required data
{"message":"Subscribed"}
path
event id to subscribe to
required event_id
<event_id>
email to subscribe
required email
<email>

EventUnsubscribe DELETE PUT POST GET /event/{event_id}/unsubscribe/{email}

Path:
 
Response:
Unsubscibes the email passed to the event passed

returns
an object containing the status message
required data
{"message":"Unsubscribed"}
path
event id to unsubscribe from
required event_id
<event_id>
email to unsubscribe
required email
<email>

EventBulkSubscribe DELETE PUT POST GET /event/{event_id}/subscribe

Path:
Body:
Token:
 
Response:
Subscibes the batch to the event based on the data passed

returns
an object containing the confirmation message
required data
{"message":"Subscribed"}
post body
an object containing the subscribers' data
required data
{"list":[
{
"recipient_firstName":"First Name",
"recipient_lastName":"Last Lname",
"recipient_phoneNumber":"Phone Number",
"recipient_company":"Company Name",
"recipient_email":"Email Address"
},...
]}
header
authetication token
required Token
<UUID>

EventResponses DELETE PUT POST GET /event/{event_id}/{type}

Path:
Token:
 
Response:
Returns a list of responses to the event

returns
an array of objects containing the responses
required data
[{"recipient_email":"<recipient_email>",...},...]
path
event id
required event_id
<event_id>
response type
required type
one of "accepted", "attended", "declined", "noreply" literals
header
authetication token
required Token
<UUID>

AccountCreate DELETE PUT POST GET /account

Path:
Body:
Token:
 
Response:
Creates a customer based on the data passed

returns
an object containing the id of the new customer
required data
{"customer_id":"<customer_id>"}
post body
an object containing the customer data
required data
{
"customer_firstName":"Customer First Name",
"customer_lastName":"Customer Last Name",
"customer_email":"Customer Email",
"customer_phone":"Customer Phone",
"customer_username":"Customer Username",
"customer_password":"Customer Password",
"customer_billingName":"Customer Billing Name",
"customer_billingAddress":"Customer Billing Address",
"customer_billingCity":"Customer Billing City",
"customer_billingState":"Customer Billing State",
"customer_billingZip":"Customer Billing Zip",
"customer_timezone":"Customer Timezone",
"customer_readytalkAccessCode":"Readytalk Access Code",
"customer_readytalkPassCode":"Readytalk Pass Code",
"customer_active":Activity Flag
}
header
authetication token; must be a super-user
required Token
<UUID>

AccountUpdate DELETE PUT POST GET /account/{customer_id}

Path:
Body:
Token:
 
Response:
Updates a customer based on the data passed

returns
an object containing the id of the updated customer
required data
{"customer_id":"<customer_id>"}
post body
an object containing the customer data
required data
{
"customer_firstName":"Customer First Name",
"customer_lastName":"Customer Last Name",
"customer_email":"Customer Email",
"customer_phone":"Customer Phone",
"customer_username":"Customer Username",
"customer_password":"Customer Password",
"customer_billingName":"Customer Billing Name",
"customer_billingAddress":"Customer Billing Address",
"customer_billingCity":"Customer Billing City",
"customer_billingState":"Customer Billing State",
"customer_billingZip":"Customer Billing Zip",
"customer_timezone":"Customer Timezone",
"customer_readytalkAccessCode":"Readytalk Access Code",
"customer_readytalkPassCode":"Readytalk Pass Code",
"customer_active":Activity Flag
}
path
customer id
required customer_id
<customer_id>
header
authetication token; must be a super-user
required Token
<UUID>

AccountGet DELETE PUT POST GET /account/{customer_id}

Path:
Token:
 
Response:
Returns a customer based on the id passed

returns
an object containing the customer data
required data
{"customer_id":"<customer_id>","customer_firstname":"<customer_firstname>",...}
path
customer id
required customer_id
<customer_id>
header
authetication token; must be a super-user
required Token
<UUID>

AccountList DELETE PUT POST GET /account/list

Path:
Token:
 
Response:
Returns a list of customers

returns
an array of objects containing the customers data
required data
[{"customer_id":"<customer_id>","customer_firstname":"<customer_firstname>",...},...]
header
authetication token; must be a super-user
required Token
<UUID>

AccountDelete DELETE PUT POST GET /account/{customer_id}

Path:
Token:
 
Response:
Deletes a customer based on the id passed

returns
an object containing the id of the deleted customer
required data
{"customer_id":"<customer_id>"}
path
cusomer id
required customer_id
<customer_id>
header
authetication token; must be a super-user
required Token
<UUID>