EventPoint API REST Reference

In order to use the EventPoint API, you must have an apikey. All requests must include code and an apikey values. You may include these parameters in the querystring or in the headers.

Results are either JSON or XML. If no format is specified, JSON is returned. To specify an XML response, supply a paramter format=xml

Please replace the version number where /vn.n is specified. Current version is 2.1

JSONP is supported. Append a callback parameter with the value of the function that call you want to wrap the result in.

All date/times are now formatted in ISO 8601 format

Name Description Required
code Your event's unique code Yes
apikey Your API access key Yes
format Response format. May be "json" or "xml" No

Summary of Changes

Version 2.1 of the API introduces several changes that may break your application. Please check the documenation for the changes.

Possible breaking changes: Updates

Summary of Available Services

Below are all the available services

Retrieving Program Data

Program

http://api.eventpoint.com/n.n/program

Response data
{
    "id":"ff6f772b-1449-df11-850f-001ec953730b",
    "code":"yourcode",
    "name":"Your Event 2011",
    "url":"yourcode.eventpoint.com",
    "startdate":"2012-02-15T00:00:00Z",
    "enddate":"2012-02-15T00:00:00Z",
    "timezoneid":"Pacific Standard Time",
    "timezoneoffset":-4,
    "days":null,
    "categories":null,
    "topics":null,
    "timeslots":null,
    "rooms":null,
    "speakers":null
    "agenda":null
}
    

Topics

http://api.eventpoint.com/n.n/program/topics

Topics are wrapped in a result that specifies the topic results, current page, the page size, and the total number of topics returned. This service will let you query topics based on a variety of parameters, as noted below.

Name Description Required
page The page to return. First page is 1. No
pagesize Number of topics to return. Default is 100. No
keyword Keyword filter for Code,Title, or Description No
categories A comma delimited string of categories names or ids. For example: Windows,Architecture,Breakout No
speaker A comma delimited list of speaker id's No
timeslot A timeslot id No
day A day. e.g., 8/29/2011 No
start a time. e.g. 8/29/2011 8:00 AM or simply 8:00 AM. if no date is specified, then the default will be the current day if during the event OR the first day of the event. No
finish a time. e.g. 8/29/2011 8:00 AM or simply 8:00 AM. if no date is specified, then the default will be the current day if during the event OR the first day of the event. No
room room id No
includeinfo true/false. If false, a lesser amount of information is returned. If true, all topic information is returned. Use false to cut down on bandwidth usage. No
sort Sort topics by code,title,start,finish No

Response data
{
    "total":470,
    "pagesize":1000,
    "page":1,
    "topics":[
        {
            "id":"topic id",
            "code":"CODE01",
            "title":"Living the Lifestyle ",
            "description":"No technology has impacted programming in recent years the way code has.",
            "approvalstatus":"2",
            "publishingstatus":"6",
            "room":"",
            "start":"2012-02-15T00:00:00Z",
            "finish":"2012-02-15T00:00:00Z",
            "categoryids":[
                "category id 1",
                "category id 2",
                "category id 3"
                ],
            "speakerids":[
                "speaker id 1"
                ],
            "sessions":[
                    {
                        "id":"session id",
                        "roomId":"room id",
                        "timeslotId":"timeslot id",
                        "allowscheduling":false,
                        "capacity":0
                    }
                ],
            "related":[
                    {
                        "name":"Associated",
                        "values":["id 1", "id 2"]
                    }
                ],
            "info":[
                    {
                        "name":"extended_property",
                        "value":"some value"
                    }
                ],
            "documents":[
                    {
                        "name":"docname.txt",
                        "url":"http://someurl",
                        "contentlength":"199"
                    }
                ]
        }
    ]
}
    
Retrieve a single topic

http://api.eventpoint.com/n.n/program/topic/[id or code] e.g. http://api.eventpoint.com/n.n/program/topic/CODE101. Note, this is not case sensitive. Response data

{
    "id":"topic id",
    "code":"CODE01",
    "title":"Living the Lifestyle ",
    "description":"No technology has impacted programming in recent years the way code has.",
    "approvalstatus":"2",
    "publishingstatus":"6",
    "room":"",
    "start":"2012-02-15T00:00:00Z",
    "finish":"2012-02-15T00:00:00Z",
    "score":"0.0",
    "categoryids":[
        "category id 1",
        "category id 2",
        "category id 3"
        ],
    "speakerids":[
        "speaker id 1"
        ],
    "sessions":[
            {
                "id":"session id",
                "roomId":"room id",
                "timeslotId":"timeslot id",
                "allowscheduling":false,
                "capacity":0
            }
        ],
    "related":[
            {
                "name":"Associated",
                "values":["id 1", "id 2"]
            }
        ],
    "documents":[
            {
                "url":"document url",
                "name":"name.pptx",
                "contentlength":"100000"
            }
        ],
    "info":[
            {
                "name":"extended_property",
                "value":"some value"
            }
        ]
}
    

Session Changes

http://api.eventpoint.com/n.n/program/sessionchanges

Name Description Required
date Filter for session changes after a particular date No
registrantKey Filter for session changes relevant for a particular registrant No

Response data
[
    {
        "changedate":"2012-02-15T00:00:00Z",
        "changetype":"Timeslot Change/Room Change/Cancellation/NewTopic",
        "summary":"",
        "originalvalue":"old value",
        "newvalue":"new value",
        "topic": {
    "id":"topic id",
    "code":"CODE01",
    "title":"Living the Lifestyle ",
    "description":"No technology has impacted programming in recent years the way code has.",
    "approvalstatus":"2",
    "publishingstatus":"6",
    "room":"",
    "start":"2012-02-15T00:00:00Z",
    "finish":"2012-02-15T00:00:00Z",
    "score":"0.0",
    "sessions":[
            {
                "id":"session id",
                "roomId":"room id",
                "timeslotId":"timeslot id",
                "allowscheduling":false,
                "capacity":0
            }
        ],
    "info":[
            {
                "name":"extended_property",
                "value":"some value"
            }
        ]
}





    }
]
    

Categories

http://api.eventpoint.com/n.n/program/categories

Name Description Required
parent Filter categories for a specific parent. May be an ID or the Parent category name. e.g., Track No

Response data
[
    {
        "id":"category id",
        "parentid":"parent category id",
        "name":"Some Name",
        "shortdesc":"SN",
        "description":"category descripton",
        "publish":true
    }
]
    
Retrieve page content

http://api.eventpoint.com/n.n/program/pagecontent/[id or code]

Response data
{
    "id":"content id",
    "name":"Some Name",
    "code":"code",
    "url":"url",
    "html":"html content"
}
    
Retrieve a single category

http://api.eventpoint.com/n.n/program/category/[id or shortdesc or name]

Response data
{
    "id":"category id",
    "parentid":"parent category id",
    "name":"Some Name",
    "shortdesc":"SN",
    "publish":true
}
    

Days

Note that the date formats are specified via the EventPoint Admin

http://api.eventpoint.com/n.n/program/days

[
    {
        "date":"2012-02-15T00:00:00Z",
        "longformatteddate":"Monday, November 8",
        "shortformatteddate":"11/8/2010",
        "datestring" : "11/8/2010",
        "dateindex":1
     }
]
    

Timeslots

http://api.eventpoint.com/n.n/program/timeslots

Name Description Required
day Filter timeslots for a specifc day. No

Response data
[
    {
        "id":"timeslot id",
        "start":"2012-02-15T00:00:00Z",
        "finish":"2012-02-15T00:00:00Z",
        "formattedtimeslot": "8:00 AM- 9:00 PM",
        "publish":true
    }
]    
    

Rooms

http://api.eventpoint.com/n.n/program/rooms

Response data
[
    {
        "id":"room id",
        "name":"Hall 2b",
        "capacity":300,
        "publish":true
    }
]
    

Agenda

http://api.eventpoint.com/n.n/program/agenda

Name Description Required
day Filter agenda for a specifc day. No

Response data
[
    {
        "id":"agenda id",
        "title":"agenda item title",
        "code":"code",
        "description":"description",
        "room":"room",
        "start":"2012-02-15T00:00:00Z",
        "finish":"2012-02-15T00:00:00Z",
        "formattedtimeslot": "8:00 AM- 9:00 PM"
    }
]    
    

Speakers

http://api.eventpoint.com/n.n/program/speakers

[
    {
        "id":"speaker id",
        "name":"John Smith",
        "jobtitle":"Senior Analyst",
        "companyname":"EventPoint",
        "photo":null,
        "bio":"John Smith is a Senior Analyst at EventPoint.  He likes books, long walks on the beach, and deep conversations.",
        "categoryids":[
            "category id 1",
            "category id 2",
            "category id 3"
            ],
        "topicids":[
            "topic id 1",
            "topic id 2",
            "topic id 3"
            ],
        "info":[
                {
                    "name":"extended_property",
                    "value":"some value"
                }
            ]
     }
]
    
Retrieve a single speaker

http://api.eventpoint.com/n.n/program/speaker/[id or name]

Some examples include:

  • http://api.eventpoint.com/n.n/program/speaker/12345 (by id)
  • http://api.eventpoint.com/n.n/program/speaker/John_Smith (first and last name use underscore (_) instead of space)
  • http://api.eventpoint.com/n.n/program/speaker/John+Smith (first and last name - use plus (+) instead of space)
  • http://api.eventpoint.com/n.n/program/speaker/John%20Smith (first and last name - space is url encoded)
  • Response data
    {
        "id":"speaker id",
        "name":"John Smith",
        "jobtitle":"Senior Analyst",
        "companyname":"EventPoint",
        "photo":null,
        "bio":"John Smith is a Senior Analyst at EventPoint.  He likes books, long walks on the beach, and deep conversations.",
        "categoryids":[
            "category id 1",
            "category id 2",
            "category id 3"
            ],
        "topicids":[
            "topic id 1",
            "topic id 2",
            "topic id 3"
            ],
        "info":[
                {
                    "name":"extended_property",
                    "value":"some value"
                }
            ]
    }
        

    Surveys (Evaluations)

    Surveys are used for session evaluations. To determine which survey to use, match a topic categories against the survey category.

    For question types, 1 = multiple choice, 2 or 5 = signle choice, 3 = short text, 4 = long text

    http://api.eventpoint.com/n.n/program/surveys

    Name Description Required
    parent Filter categories for a specific parent. May be an ID or the Parent category name. e.g., Track No

    Response data
    [
        {
            "id":"survey id",
            "name":"Some Name",
            "categoryids":["category id"],
            "questions":[
                {
                    "id": "question id",
                    "num": 1,
                    "questiontype": "1",
                    "text": "question text",
                    "answers": [
                        "id: "answer id",
                        "num": 1,
                        "text": "answer text"                    
                    ]
                }
            ]
            
        }
    ]
        

    Companies

    http://api.eventpoint.com/n.n/program/companies

    Companies are wrapped in a result that specifies the company results, current page, the page size, and the total number of companies returned. This service will let you query companies based on a variety of parameters, as noted below.

    Name Description Required
    page The page to return. First page is 1. No
    pagesize Number of topics to return. Default is 1000. No
    keyword Keyword filter for Name or Description No
    categories A comma delimited string of categories names or ids. For example: Windows,Architecture,Breakout No

    Response data
    {
        "total":470,
        "pagesize":1000,
        "page":1,
        "results":[
            {
                "id":"company id",
                "name":"Company name",
                "description":"This company is great.  It is.",
                "location":"location",
                "booth":"booth",
                "url":"http://www.eventpoint.com/",
                "categoryids":[
                    "category id 1",
                    "category id 2",
                    "category id 3"
                    ],
                "info":[
                        {
                            "name":"extended_property",
                            "value":"some value"
                        }
                    ]
            }
        ]
    }
        
    Retrieve a single company

    http://api.eventpoint.com/n.n/program/company/[id or name] e.g. http://api.eventpoint.com/n.n/program/company/EventPoint. Note, this is not case sensitive. Response data

    {
        "id":"company id",
        "name":"Company name",
        "description":"This company is great.  It is.",
        "location":"location",
        "booth":"booth",
        "url":"http://www.eventpoint.com/",
        "categoryids":[
            "category id 1",
            "category id 2",
            "category id 3"
            ],
        "info":[
                {
                    "name":"extended_property",
                    "value":"some value"
                }
            ]
    }
        

    Manipulating Schedule Data

    Note, you must have an administrative apikey to access Registrant data.

    Retrieve Registrant Schedule

    http://api.eventpoint.com/n.n/schedule/get

    Parameters

    Name Description Required
    registrantkey The key for the registrant whose schedule to retrieve Yes

    Response data
    {
        "topics":[
            {
                "id":"topic id",
                "code":"CODE1",
                "title": "My Session Title",
                "description":"topic description",
                "approvalstatus":"2",
                "publishingstatus":"6",
                "room":"",
                "start":"2012-02-15T00:00:00Z",
                "finish":"2012-02-15T00:00:00Z",
                "categoryids":null,
                "speakerids":null,
                "sessions":[
                        {
                            "id":"session id",
                            "roomId":"room id",
                            "timeslotId":"timeslot id",
                            "allowscheduling":false,
                            "capacity":0
                        }
                 ]
             }
         ]
    }  
        

    Add Session to Registrant Schedule

    http://api.eventpoint.com/n.n/schedule/add

    Parameters

    Name Description Required
    registrantkey The key for the registrant whose schedule to update Yes
    sessionid The sessionid to add. Alternatively, if a topic id is used a best match is performed. Yes

    Response data
    {
        "success":true,
        "status":0,
        "message":"sessionID [session id] added to schedule for RegistrantKey [registrant key]."
    }    
        

    Remove Registrant Schedule

    http://api.eventpoint.com/n.n/schedule/remove

    Parameters

    Name Description Required
    registrantkey The key for the registrant whose schedule to update Yes
    sessionid The sessionid to remove. Alternatively, if a topic id is used a best match is performed. Yes

    Response data
    {
        "success":true,
        "status":0,
        "message":"sessionID [session id] removed from schedule for RegistrantKey [registrant key]."
    }    
        

    Registrants

    Note, you must have an administrative apikey to access Registrant data.

    Authenticating Registrant for Username and Password

    http://api.eventpoint.com/n.n/registrant/authenticate

    Registrants may also have arbitrary additional "info" fields as in the below sample response.

    Parameters

    Name Description Required
    username Registrant username Yes
    password Registrant password. Yes

    Response data
    {
        "registrant":{
            "key":"registrant id here",
            "name":"Joe User",
            "username":"joe_user",
            "email":"joeuser@eventpoint.com",
            "bio":"",
            "jobtitle":"",
            "companyname":"",
            "role":"",
            "code":"",
            "shareschedule":"false",
            "sharecontacts":"false",
            "sharetripreport":"false",
            "directoryoptin":"false",
            "thirdpartyid":"",
            "thirdpartycode":"false",
            "registrationcompletedate":"2012-02-15T00:00:00Z",
            "photo":"http://myphoto.png",
            "info":[
                {"name":"Twitter","value":"twitterid"},
                {"name":"Facebook","value":"facebookid"},
                {"name":"LinkedIn","value":"linkedinid"}
             ],
            "categoryids":[
                "category id 1",
                "category id 2",
                "category id 3"
             ] 
        },
        "isvalid":true,
        "message":""
    }
        

    Authenticating Registrant for Puid

    http://api.eventpoint.com/n.n/registrant/authenticateforpuid

    Parameters

    Name Description Required
    puid Registrant puid Yes

    Response data
    {
        "registrant":{
            "key":"registrant id here",
            "name":"Joe User",
            "username":"joe_user",
            "email":"joeuser@eventpoint.com",
            "bio":"",
            "jobtitle":"",
            "companyname":"",
            "role":"",
            "code":"",
            "shareschedule":"false",
            "sharecontacts":"false",
            "sharetripreport":"false",
            "directoryoptin":"false",
            "thirdpartyid":"",
            "thirdpartycode":"false",
            "registrationcompletedate":"2012-02-15T00:00:00Z",
            "photo":"http://myphoto.png",
            "info":[
                {"name":"Twitter","value":"twitterid"},
                {"name":"Facebook","value":"facebookid"},
                {"name":"LinkedIn","value":"linkedinid"}
             ],
            "categoryids":[
                "category id 1",
                "category id 2",
                "category id 3"
             ] 
        },
        "isvalid":true,
        "message":""
    }
        

    Find Registrant for Key

    http://api.eventpoint.com/n.n/registrant/findbykey

    Parameters

    Name Description Required
    registrantkey Registrant Key Yes

    Response data
    {
        "registrant":{
            "key":"registrant id here",
            "name":"Joe User",
            "username":"joe_user",
            "email":"joeuser@eventpoint.com",
            "bio":"",
            "jobtitle":"",
            "companyname":"",
            "role":"",
            "code":"",
            "shareschedule":"false",
            "sharecontacts":"false",
            "sharetripreport":"false",
            "directoryoptin":"false",
            "thirdpartyid":"",
            "thirdpartycode":"false",
            "registrationcompletedate":"2012-02-15T00:00:00Z",
            "photo":"http://myphoto.png",
            "info":[
                {"name":"Twitter","value":"twitterid"},
                {"name":"Facebook","value":"facebookid"},
                {"name":"LinkedIn","value":"linkedinid"}
             ],
            "categoryids":[
                "category id 1",
                "category id 2",
                "category id 3"
             ] 
        },
        "isvalid":true,
        "message":""
    }
        

    Find Registrant by Email

    http://api.eventpoint.com/n.n/registrant/findbyemail

    Parameters

    Name Description Required
    Email Registrant email address Yes

    Response data
    {
        "registrant":{
            "key":"registrant id here",
            "name":"Joe User",
            "username":"joe_user",
            "email":"joeuser@eventpoint.com",
            "bio":"",
            "jobtitle":"",
            "companyname":"",
            "role":"",
            "code":"",
            "shareschedule":"false",
            "sharecontacts":"false",
            "sharetripreport":"false",
            "directoryoptin":"false",
            "thirdpartyid":"",
            "thirdpartycode":"false",
            "registrationcompletedate":"2012-02-15T00:00:00Z",
            "photo":"http://myphoto.png",
            "info":[
                {"name":"Twitter","value":"twitterid"},
                {"name":"Facebook","value":"facebookid"},
                {"name":"LinkedIn","value":"linkedinid"}
             ],
            "categoryids":[
                "category id 1",
                "category id 2",
                "category id 3"
             ] 
        },
        "isvalid":true,
        "message":""
    }
        

    Find Registrant by ThirdPartyID

    http://api.eventpoint.com/n.n/registrant/thirdpartyid

    Use this method when there is another registration vendor. This lets you find registrants in the reg vendor's system..

    Parameters

    Name Description Required
    Email third party registrant system id Yes

    Response data
    {
        "registrant":{
            "key":"registrant id here",
            "name":"Joe User",
            "username":"joe_user",
            "email":"joeuser@eventpoint.com",
            "bio":"",
            "jobtitle":"",
            "companyname":"",
            "role":"",
            "code":"",
            "shareschedule":"false",
            "sharecontacts":"false",
            "sharetripreport":"false",
            "directoryoptin":"false",
            "thirdpartyid":"",
            "thirdpartycode":"false",
            "registrationcompletedate":"2012-02-15T00:00:00Z",
            "photo":"http://myphoto.png",
            "info":[
                {"name":"Twitter","value":"twitterid"},
                {"name":"Facebook","value":"facebookid"},
                {"name":"LinkedIn","value":"linkedinid"}
             ],
            "categoryids":[
                "category id 1",
                "category id 2",
                "category id 3"
             ] 
        },
        "isvalid":true,
        "message":""
    }
        

    Exhibitors

    Note, you must have an administrative apikey to access certain Exhibitor data.

    AddRegistrantExpo

    http://api.eventpoint.com/n.n/expo/addregistrantexpo

    Parameters

    Name Description Required
    registrantKey Registrant Key. Yes
    companyid Company/Exhibitor id Yes

    Response data
    {
        "Id":"response id",
        "Status":0,
        "Success":true,
        "Message":"status message"
    }
        

    RemoveRegistrantExpo

    http://api.eventpoint.com/n.n/expo/removeregistrantexpo

    Parameters

    Name Description Required
    registrantKey Registrant Key. Yes
    companyid Company/Exhibitor id Yes

    Response data
    {
        "Id":"response id",
        "Status":0,
        "Success":true,
        "Message":"status message"
    }
        

    RegistrantsForExpo

    http://api.eventpoint.com/n.n/expo/registrantsforexpo

    Parameters

    Name Description Required
    companyid Company/Exhibitor id Yes

    Response data
    [
        {
            "key":" reg key ",
            "name":"Joe Smith",
            "username":"joesmith@eventpoint.com",
            "email":"joesmith@eventpoint.com",
            "bio":"",
            "jobtitle":"Average Joe",
            "companyname":"eventpoint",
            "role":"",
            "code":"",
            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
            "qlkey":null,
            "info":null
        }
    ]
        

    RegistrantsForExpo

    http://api.eventpoint.com/n.n/expo/exposforregistrant

    Parameters

    Name Description Required
    companyid Company/Exhibitor id Yes

    Response data
    [
        {
            "id":"company id",
            "name":"Company name",
            "description":"This company is great.  It is.",
            "location":"location",
            "booth":"booth",
            "url":"http://www.eventpoint.com/",
            "categoryids":[
                "category id 1",
                "category id 2",
                "category id 3"
                ],
            "info":[
                    {
                        "name":"extended_property",
                        "value":"some value"
                    }
                ]
        }
    ]
        

    Evaluations

    Note, you must have an administrative apikey to access certain Eval data.

    Submit Evaluation

    http://api.eventpoint.com/n.n/eval/submitsurvey

    Parameters

    Name Description Required
    objectid Id of session or topic or company. This is to submit an evaluation for that object. Yes
    registrantKey registrant key of registrant submitting survey Yes
    surveyId Survey id. No
    q1,q2,q3,etc Note, these are not "officially" parameter names. These are dependent on the particular survey being submitted. So, if you had a survey with question numbers 1, 2, and 3, where 1&2 are a single choice answer, and 3 is a text answer, you would submit the following parameters:
    q1=answerid_1
    &q2=answerid_2
    &q3=some free form text
    Yes

    Response data Response data
    {
        "id":"response id",
        "status":0,
        "success":true,
        "message":"status message"
    }
        

    Completed Evaluations

    http://api.eventpoint.com/n.n/eval/completedsurveys

    Use this service to retrieve a list of completed surveys and evaluations. NOTE, if this is a "Session Evaluation", the "objectid" will always be the SessionId, not the TopicId, regardless of whether or not the evaluation was submitted with a "SessionId"

    Parameters

    Name Description Required
    registrantKey Key of registrant who to retrieve completes surveys. Yes

    Response data
    { 
        "message":null,
        "surveys":[
            {"surveyid":"surveyid 1","objectid":"sessionid 2","completeddate":"2012-06-14T14:15:36"},
            {"surveyid":"surveyid 1","objectid":"sessionid 1","completeddate":"2012-06-14T14:16:10"}
        ]
    }
        

    Can Submit Survey

    http://api.eventpoint.com/n.n/eval/cansubmitsurvey

    Use this service to check if a registrant can submit a survey

    Parameters

    Name Description Required
    objectid Id of session or topic or company. This is to submit an evaluation for that object. Yes
    registrantKey registrant key of registrant submitting survey Yes
    surveyId Survey id. No

    Response data Response data
    {
        "id":"response id",
        "status":0,
        "success":true,
        "message":"status message"
    }
        

    Discussions

    Note, you must have an administrative apikey to access certain Discussion data.

    Threads

    http://api.eventpoint.com/n.n/discussion/threads

    Parameters

    Name Description Required
    objectid Id of session or company. This is to retrieve discussions for that object. No
    objecttype Value of 'session' or 'company'. To retrieve a list of all company discussions, use objecttype=company No
    page The page to return. First page is 1. No
    pagesize Number of topics to return. Default is 1000. No
    keyword Keyword filter for Subject or Description No

    Response data
    {
        "total":21,
        "pagesize":10000,
        "page":1,
        "results":
            [
                {
                    "id":" thread id ",
                    "subject":"Event Logistics",
                    "body":"Discuss the Event Logistics",
                    "objectid":"",
                    "objecttype":"",
                    "numposts":55,
                    "isarchived":"false",
                    "lastmessageid":" message id ",
                    "lastpostdate":"2012-02-15T00:00:00Z",
                    "created":"2012-02-15T00:00:00Z",
                    "lastauthor":
                        {
                            "key":" reg key ",
                            "name":"Dude Lebowski",
                            "username":"dude@eventpoint.com",
                            "email":"dude@eventpoint.com",
                            "bio":"",
                            "jobtitle":"dude",
                            "companyname":"eventpiont",
                            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/92acbbec-d427-e011-be0d-001ec953730b.png",
                            "qlkey":null,
                            "info":null
                        },
                    "author":
                        {
                            "key":" reg key ",
                            "name":"Dude Lebowski",
                            "username":"dude@eventpoint.com",
                            "email":"dude@eventpoint.com",
                            "bio":"",
                            "jobtitle":"dude",
                            "companyname":"eventpiont",
                            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/92acbbec-d427-e011-be0d-001ec953730b.png",
                            "qlkey":null,
                            "info":null
                        },
                     "replies":null
                }
            ]
    }
        

    Retrieve a Thread

    http://api.eventpoint.com/n.n/discussion/thread/[id]

    NOTE: You must either supply the id, or objectid=[session or companyid]. Also note, that messages are sorted according to their most recent activity in decending order, but threading is also kept in tact. The messages will be order by level, and then by created date. For instance, here is a typical ordering:

    M 1
      R 1.1
         R 1.1.1
         R 1.1.2
    M 2
      R 2.1
         R 2.1.1
      R 2.2
         R 2.2.1
                
    Also note, that message replies are not embedded as documents recursively within each other. Use the level property to determine how to render your message. Finally, if you supply the "view" parameter, message threading will not be taken into account.

    Parameters

    Name Description Required
    id Thread Id No
    objectid Instead of using threadid, you may pass objectid. This will retrieve a session or company discussion. No
    page The page to return. First page is 1. No
    pagesize Number of topics to return. Default is 1000. No
    keyword Keyword filter for Subject or Description No
    sort Possible values of "created" or "numposts". "created" is the default order, and it sorts messages in decending order. No
    view If you supply a value of 'list', then a non-threaded list is supplied No

    Response data
    {
        "total":21,
        "pagesize":10000,
        "page":1,
        "results":
            [
                {
                    "id":" thread id ",
                    "subject":"Event Logistics",
                    "body":"Discuss the Event Logistics",
                    "objectid":"",
                    "objecttype":"",
                    "numposts":55,
                    "isarchived":"false",
                    "lastmessageid":" message id ",
                    "lastpostdate":"2012-02-15T00:00:00Z",
                    "created":"2012-02-15T00:00:00Z",
                    "lastauthor":
                        {
                            "key":" reg key ",
                            "name":"Dude Lebowski",
                            "username":"dude@eventpoint.com",
                            "email":"dude@eventpoint.com",
                            "bio":"",
                            "jobtitle":"dude",
                            "companyname":"eventpiont",
                            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/92acbbec-d427-e011-be0d-001ec953730b.png",
                            "qlkey":null,
                            "info":null
                        },
                    "author":
                        {
                            "key":" reg key ",
                            "name":"Dude Lebowski",
                            "username":"dude@eventpoint.com",
                            "email":"dude@eventpoint.com",
                            "bio":"",
                            "jobtitle":"dude",
                            "companyname":"eventpoint",
                            "role":"",
                            "code":"",
                            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/thedude.png",
                            "qlkey":null,
                            "info":null
                        },
                     "replies":
                        [
                            {
                                "id":" message id ",
                                "subject":"Post from Averag Joe",
                                "body":" body of post ",
                                "threadid":" thread id ",
                                "parentid":" parent id ( note it can be the thread id) ",
                                "created":"2012-02-15T00:00:00Z",
                                "level":1,
                                "author":
                                    {
                                        "key":" reg key ",
                                        "name":"Joe Smith",
                                        "username":"joesmith@eventpoint.com",
                                        "email":"joesmith@eventpoint.com",
                                        "bio":"",
                                        "jobtitle":"Average Joe",
                                        "companyname":"eventpoint",
                                        "role":"",
                                        "code":"",
                                        "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                                        "qlkey":null,
                                        "info":null
                                    } 
                            }                                   
                        ]
                }
            ]
    }
        

    View Message

    http://api.eventpoint.com/n.n/discussion/message/[id]

    Parameters

    Name Description Required
    id Message id. Yes

    Response data
    {
        "id":" message id ",
        "subject":"Post from Averag Joe",
        "body":" body of post ",
        "threadid":" thread id ",
        "parentid":" parent id ( note it can be the thread id) ",
        "created":"2012-02-15T00:00:00Z",
        "level":1,
        "author":
            {
                "key":" reg key ",
                "name":"Joe Smith",
                "username":"joesmith@eventpoint.com",
                "email":"joesmith@eventpoint.com",
                "bio":"",
                "jobtitle":"Average Joe",
                "companyname":"eventpoint",
                "role":"",
                "code":"",
                "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                "qlkey":null,
                "info":null
            } 
    }  
        

    Add or Update a Message

    http://api.eventpoint.com/n.n/discussion/savemessage

    Parameters

    Name Description Required
    messageid if no messageid is supplied, a new message will be created. If a messageid is supplied, that message will be updated. No
    threadid thread id. Yes
    parentid if this message is a reply to another message, then supply that message's id for the parentid. No
    objectid the objectid to associate thread with. Currently only available for UserGroups. no
    objecttype The object type to associate thread with no
    subject Subject of Message No
    body Message body. No
    registrantKey Key of registrant who message is from. Yes

    Response data
    {
        "id":"message id",
        "success":true,
        "status":0,
        "message":"Message has been posted ( id: message id )"
    }
        

    Delete Message

    http://api.eventpoint.com/n.n/discussion/deletemessage/[id]

    NOTE: in order to preserve the structure of a thread and all the replies, a message isn't actually deleted. Instead the Subject & Body are changed to 'Message Removed'. The original contents of the message remain tracked.

    Parameters

    Name Description Required
    id Message id. Yes

    Response data
    {
        "id":"message id",
        "success":true,
        "status":0,
        "message":"Message contents successfully removed"
    }
        

    Follow Message

    http://api.eventpoint.com/n.n/discussion/followmessage/

    Parameters

    Name Description Required
    messageidid Message id. Yes
    registrantKey Key of registrant Yes

    Response data
    {
        "id":"message id",
        "success":true,
        "status":0,
        "message":"Message followed for registrant "
    }
        

    Un-Follow Message

    http://api.eventpoint.com/n.n/discussion/unfollowmessage/

    Parameters

    Name Description Required
    messageidid Message id. Yes
    registrantKey Key of registrant Yes

    Response data
    {
        "id":"message id",
        "success":true,
        "status":0,
        "message":"Message unfollowed for registrant "
    }
        

    Messages followed by a registrant

    http://api.eventpoint.com/n.n/discussion/messagesfollowed/

    Parameters

    Name Description Required
    registrantKey Key of registrant Yes

    Response data
    [
        {
            "id":" message id ",
            "subject":"Post from Averag Joe",
            "body":" body of post ",
            "threadid":" thread id ",
            "parentid":" parent id ( note it can be the thread id) ",
            "created":"2012-02-15T00:00:00Z",
            "level":1,
            "author":
                {
                    "key":" reg key ",
                    "name":"Joe Smith",
                    "username":"joesmith@eventpoint.com",
                    "email":"joesmith@eventpoint.com",
                    "bio":"",
                    "jobtitle":"Average Joe",
                    "companyname":"eventpoint",
                    "role":"",
                    "code":"",
                    "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                    "qlkey":null,
                    "info":null
                } 
        }  
    ]
        

    Messages posted by a registrant

    http://api.eventpoint.com/n.n/discussion/messagesbyperson/

    Parameters

    Name Description Required
    registrantKey Key of registrant Yes

    Response data
    [
        {
            "id":" message id ",
            "subject":"Post from Averag Joe",
            "body":" body of post ",
            "threadid":" thread id ",
            "parentid":" parent id ( note it can be the thread id) ",
            "created":"2012-02-15T00:00:00Z",
            "level":1,
            "author":
                {
                    "key":" reg key ",
                    "name":"Joe Smith",
                    "username":"joesmith@eventpoint.com",
                    "email":"joesmith@eventpoint.com",
                    "bio":"",
                    "jobtitle":"Average Joe",
                    "companyname":"eventpoint",
                    "role":"",
                    "code":"",
                    "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                    "qlkey":null,
                    "info":null
                } 
        }  
    ]
        

    Latest messages for a thread

    http://api.eventpoint.com/n.n/discussion/latestforthread/

    Parameters

    Name Description Required
    threadid Thread id Yes
    date Show only messages posted after a certain date No
    page The page to return. First page is 1. No
    pagesize Number of topics to return. Default is 1000. No

    Response data
    [
        {
            "id":" message id ",
            "subject":"Post from Averag Joe",
            "body":" body of post ",
            "threadid":" thread id ",
            "parentid":" parent id ( note it can be the thread id) ",
            "created":"2012-02-15T00:00:00Z",
            "level":1,
            "author":
                {
                    "key":" reg key ",
                    "name":"Joe Smith",
                    "username":"joesmith@eventpoint.com",
                    "email":"joesmith@eventpoint.com",
                    "bio":"",
                    "jobtitle":"Average Joe",
                    "companyname":"eventpoint",
                    "role":"",
                    "code":"",
                    "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                    "qlkey":null,
                    "info":null
                } 
        }  
    ]
        

    People

    http://api.eventpoint.com/n.n/directory/people

    Registrants are wrapped in a result that specifies the results, current page, the page size, and the total number of registrants returned. This service will let you query registrants based on a variety of parameters, as noted below. Also, note that in order to be returned in the results that the registrant must be opted in to the Attendee Directory

    Name Description Required
    page The page to return. First page is 1. No
    pagesize Number of topics to return. Default is 100. No
    keyword Keyword filter for Code,Title, or Description No
    categories A comma delimited string of categories names or ids. For example: Windows,Architecture,Breakout No
    sort Sort results by firstname, lastname No

    Response data
    {
        "total":470,
        "pagesize":1000,
        "page":1,
        "results":
            [
                {
                    "key":" reg key ",
                    "name":"Joe Smith",
                    "username":"joesmith@eventpoint.com",
                    "email":"joesmith@eventpoint.com",
                    "bio":"",
                    "jobtitle":"Average Joe",
                    "companyname":"eventpoint",
                    "role":"",
                    "code":"",
                    "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                    "qlkey":null,
                    "info":null
                }
            ]
    }
        
    Retrieve a single person

    http://api.eventpoint.com/n.n/directory/person/[registrantkey or name]

    Some examples include:

  • http://api.eventpoint.com/n.n/directory/person/12345 (by id)
  • http://api.eventpoint.com/n.n/directory/person/John_Smith (first and last name use underscore (_) instead of space)
  • http://api.eventpoint.com/n.n/directory/person/John+Smith (first and last name - use plus (+) instead of space)
  • http://api.eventpoint.com/n.n/directory/person/John%20Smith (first and last name - space is url encoded)
  • Response data
    {
        "registrant":{
            "key":"registrant id here",
            "name":"Joe User",
            "username":"joe_user",
            "email":"joeuser@eventpoint.com",
            "bio":"",
            "jobtitle":"",
            "companyname":"",
            "role":"",
            "code":"",
            "photo":"http://myphoto.png",
            "info":[
                {"name":"Twitter","value":"twitterid"},
                {"name":"Facebook","value":"facebookid"},
                {"name":"LinkedIn","value":"linkedinid"}
             ] 
        },
        "isvalid":true,
        "message":""
    }
        

    Contacts

    http://api.eventpoint.com/n.n/directory/contacts

    Name Description Required
    registrantKey Key of registrant Yes

    Response data
    {
        "total":470,
        "pagesize":1000,
        "page":1,
        "results":
            [
                {
                    "key":" reg key ",
                    "name":"Joe Smith",
                    "username":"joesmith@eventpoint.com",
                    "email":"joesmith@eventpoint.com",
                    "bio":"",
                    "jobtitle":"Average Joe",
                    "companyname":"eventpoint",
                    "role":"",
                    "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                    "qlkey":null,
                    "info":null
                }
            ]
    }
        
    Add Contact

    http://api.eventpoint.com/n.n/directory/addcontact/

    Parameters

    Name Description Required
    registrantKey Key of registrant Yes
    addkey registrant to add as contact. Yes

    Response data
    {
        "id":"add key",
        "success":true,
        "status":0,
        "message":"Registrant added to contacts"
    }
        
    Remove Contact

    http://api.eventpoint.com/n.n/directory/removecontact/

    Parameters

    Name Description Required
    registrantKey Key of registrant Yes
    removekey registrant to remove as contact. Yes

    Response data
    {
        "id":"remove key",
        "success":true,
        "status":0,
        "message":"Registrant removed from contacts"
    }
        

    Similar People

    An algorithm is used to deterimine similar contacts

    http://api.eventpoint.com/n.n/directory/similar

    Name Description Required
    registrantKey Key of registrant Yes
    page The page to return. First page is 1. No
    pagesize Number of topics to return. Default is 100. No

    Response data
    {
        "total":470,
        "pagesize":1000,
        "page":1,
        "results":
            [
                {
                    "key":" reg key ",
                    "name":"Joe Smith",
                    "username":"joesmith@eventpoint.com",
                    "email":"joesmith@eventpoint.com",
                    "bio":"",
                    "jobtitle":"Average Joe",
                    "companyname":"eventpoint",
                    "role":"",
                    "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                    "qlkey":null,
                    "info":null
                }
            ]
    }
        

    Send Message to another Registrant

    http://api.eventpoint.com/n.n/directory/sendmessage

    Name Description Required
    messageFromKey Key of registrant Yes
    messageToKey Key of registrant Yes
    subject subject of message. Yes
    body body of message. Yes
    parentid if this is a response, the parentid of the original message. No

    Response data
    {
        "id":"",
        "success":true,
        "status":0,
        "message":"message sent"
    }
        

    Meetings

    All of a registrant's meetings

    http://api.eventpoint.com/n.n/directory/meetings

    Name Description Required
    registrantKey Key of registrant Yes

    Response data
    {
        "total":470,
        "pagesize":1000,
        "page":1,
        "results":
            [
                {
                    "id":" meeting id ",
                    "name":" name ",
                    "description":" meeting description ",
                    "status":"active",
                    "start":"2012-02-15T00:00:00Z",
                    "finish":"2012-02-15T00:00:00Z",
                    "location":" meeting location ",
                    "formattedtimeslot":"6:00 AM - 6:00 PM",
                    "organizer":
                        {
                            "key":" reg key ",
                            "name":"Joe Orgo",
                            "username":"joeorgo@eventpoint.com",
                            "email":"joeorgo@eventpoint.com",
                            "bio":"",
                            "jobtitle":"Joe Organizer",
                            "companyname":"eventpoint",
                            "role":"",
                            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoeOrganizer.png",
                            "qlkey":null,
                            "info":null
                        },
                     "participants":
                        [
                            {
                                "registrant":
                                    {
                                        "key":" reg key ",
                                        "name":"Joe Smith",
                                        "username":"joesmith@eventpoint.com",
                                        "email":"joesmith@eventpoint.com",
                                        "bio":"",
                                        "jobtitle":"Average Joe",
                                        "companyname":"eventpoint",
                                        "role":"",
                                        "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                                        "qlkey":null,
                                        "info":null
                                    },
                                 "status":"accepted"
                            }
                        ]
                }
    
            ]
    }
        
    View single meeting

    http://api.eventpoint.com/n.n/directory/meeting/[id]

    Parameters

    Name Description Required
    id meeting id Yes

    Response data
    {
        "id":" meeting id ",
        "name":" name ",
        "description":" meeting description ",
        "status":"active",
        "start":"2012-02-15T00:00:00Z",
        "finish":"2012-02-15T00:00:00Z",
        "location":" meeting location ",
        "formattedtimeslot":"6:00 AM - 6:00 PM",
        "organizer":
            {
                "key":" reg key ",
                "name":"Joe Orgo",
                "username":"joeorgo@eventpoint.com",
                "email":"joeorgo@eventpoint.com",
                "bio":"",
                "jobtitle":"Joe Organizer",
                "companyname":"eventpoint",
                "role":"",
                "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoeOrganizer.png",
                "qlkey":null,
                "info":null
            },
         "participants":
            [
                {
                    "registrant":
                        {
                            "key":" reg key ",
                            "name":"Joe Smith",
                            "username":"joesmith@eventpoint.com",
                            "email":"joesmith@eventpoint.com",
                            "bio":"",
                            "jobtitle":"Average Joe",
                            "companyname":"eventpoint",
                            "role":"",
                            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                            "qlkey":null,
                            "info":null
                        },
                     "status":"accepted"
                }
            ]
    }
            
    
        
    Add or update a meeting

    http://api.eventpoint.com/n.n/directory/savemeeting/

    NOTE: if this is a new meeting, do not supply a meetingid. You can get the value of the meetingid in the response.

    Parameters

    Name Description Required
    meetingid Meeting id No
    organizerKey Key of meeting organizer Yes
    name Meeting name Yes
    description Meeting description No
    start Meeting start time Yes
    finish Meeting finish time Yes
    location Meeting location Yes

    Response data
    {
        "id":"meeting id",
        "success":true,
        "status":0,
        "message":"Meeting has been saved"
    }  
    
        
    Update meeting invitees

    http://api.eventpoint.com/n.n/directory/updatemeetinginvitees/

    Parameters

    Name Description Required
    meetingid meeting id Yes
    addinvitees comma delimited list of reg keys to add Yes
    removeinvitees comma delimited list of reg keys to remove Yes

    NOTE: The response to this service is the actual meeting itself, with all of the current participants

    Response data
    {
        "id":" meeting id ",
        "name":" name ",
        "description":" meeting description ",
        "status":"active",
        "start":"2012-02-15T00:00:00Z",
        "finish":"2012-02-15T00:00:00Z",
        "location":" meeting location ",
        "formattedtimeslot":"6:00 AM - 6:00 PM",
        "organizer":
            {
                "key":" reg key ",
                "name":"Joe Orgo",
                "username":"joeorgo@eventpoint.com",
                "email":"joeorgo@eventpoint.com",
                "bio":"",
                "jobtitle":"Joe Organizer",
                "companyname":"eventpoint",
                "role":"",
                "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoeOrganizer.png",
                "qlkey":null,
                "info":null
            },
         "participants":
            [
                {
                    "registrant":
                        {
                            "key":" reg key ",
                            "name":"Joe Smith",
                            "username":"joesmith@eventpoint.com",
                            "email":"joesmith@eventpoint.com",
                            "bio":"",
                            "jobtitle":"Average Joe",
                            "companyname":"eventpoint",
                            "role":"",
                            "photo":"https://someevent.eventpoint.com/resources/documents/p/someevent/photos/averagejoe.png",
                            "qlkey":null,
                            "info":null
                        },
                     "status":"accepted"
                }
            ]
    }
            
    
        
    Cancel a meeting

    http://api.eventpoint.com/n.n/directory/cancelmeeting/

    This lets the organizer of the meeting cancel the actual meeting

    Parameters

    Name Description Required
    meetingid Meeting id Yes

    Response data
    {
        "id":"meeting id",
        "success":true,
        "status":0,
        "message":"Meeting has been cancelled"
    }  
    
        
    Accept a meeting invitation

    http://api.eventpoint.com/n.n/directory/acceptmeeting/

    Parameters

    Name Description Required
    meetingid Meeting id Yes
    registrantKey key of registrant to accept meeting Yes

    Response data
    {
        "id":"meeting id",
        "success":true,
        "status":0,
        "message":"Meeting invitation has been accepted"
    }  
    
        
    Decline a meeting invitation

    http://api.eventpoint.com/n.n/directory/declinemeeting/

    Parameters

    Name Description Required
    meetingid Meeting id Yes
    registrantKey key of registrant to accept meeting Yes

    Response data
    {
        "id":"meeting id",
        "success":true,
        "status":0,
        "message":"Meeting Inviation has been declined"
    }  
    
        

    Send Message meeting participants

    http://api.eventpoint.com/n.n/directory/sendmeetingmessage

    Name Description Required
    meetingid Meeting id Yes
    registrantKey Key of registrant to send from Yes
    body body of message. Yes

    Response data
    {
        "id":"",
        "success":true,
        "status":0,
        "message":"message sent"
    }