Events API : vTools Events

<!DOCTYPE html> <html lang="en"> <head><script src='https://s3-us-west-2.amazonaws.com/ieeeshutpages/gdpr/settings.js'></script><link rel='stylesheet' type='text/css' href='https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.0.3/cookieconsent.min.css' /><script src='https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.0.3/cookieconsent.min.js'></script><script>window.addEventListener('load', function(){ window.cookieconsent.initialise(json)});</script>  <script src="https://cmp.osano.com/AzyzptTmRlqVd2LRf/eeabc00e-3d69-467a-b823-c8166c73d2b0/osano.js"></script> <link rel="stylesheet" href="https://cookie-consent.ieee.org/ieee-cookie-banner.css" type="text/css"/>  <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="csrf-param" content="authenticity_token" /> <meta name="csrf-token" content="8/oGsXYo0vLBHuIM4KyhdVirw1v9Pl40rpvJIlzXEvLf1oBGJb2bA4f+EzcfjfVgtN5sJZJ0CfR9Nb0JWDIQKw==" /> <meta charset="utf-8"/> <meta name="author" content="IEEE.vTools" /> <meta name="description" content="IEEE vTools, providing tools to the volunteers and staff who support our members." /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Events API : vTools Events</title> <link rel="shortcut icon" type="image/png" href="/assets/vtools_ui_img/vtools/favicon-0463513673a2b9c9cde118c4ad2f33ff77c24c63dc714cbfdcbe5c592ce4bf20.ico" />  <script src="/assets/jquery/vtools_jquery-3a475a9d51006b3897cffc389240925809930e261e3a59215542a249167aaef0.js"></script> <link rel="stylesheet" media="screen" href="/assets/raleway/raleway-872068a515e2d610037a73e91b2f2203f54a5b4c2d626f23efb7bb5122109486.css" /> <link rel="stylesheet" media="screen" href="/assets/vtools/color_themes/dark_red-dcfe135c5fac7ed4c5aab06417d1333c203689ef39f04eaaa9fe0c214f5ca902.css" title="dark_red" /> <link rel="stylesheet" media="screen" href="/assets/vtools-ecf2b9df6727d9205be4ea5700edad6dbd2ad954e1363df7ac966d5777e5888a.css" />  <script src="/assets/raleway/preloader-fbb1a4a60322f016caf997fd2d8782fc51e334a71d9e5fd002ae9f6f0b9b0a4e.js"></script> <script type="text/javascript"> vTools = {}; vTools.AuthenticatedWhenPageLoaded = false; </script> <script src="/assets/vtools_ui-e8d47e97c384483f3e76bdc5e9c74cc0f43c9523b67c26fdbd3a755a5822fba4.js"></script> <link rel="stylesheet" media="screen" href="/assets/api_documentation-f5cda1cd67dc9ed9b15e17048096c1e6c78787535e25e8047fe43995e053c697.css" />  <script async src="https://www.googletagmanager.com/gtag/js?id=G-FJ4RJXQJW2"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-FJ4RJXQJW2'); </script> <script type="text/javascript"> (function() { var op = XMLHttpRequest.prototype.open; XMLHttpRequest.prototype.open = function() { var resp = op.apply(this, arguments); var url = arguments && arguments[1] ? "" + arguments[1] : ""; url = url.toLowerCase(); if (url.includes("ieee.org") || url.includes("localhost") || url.includes("127.0.0.1") || !url.startsWith("http")) { this.setRequestHeader('X-CSRF-Token', $('meta[name=csrf-token]').attr('content')); } return resp; }; }()); </script> </head> <body class=" scrollreveal royal_preloader">  <div id="royal_preloader"></div> <div id="bg-boxed"> <div class="boxed">  <header>  <div class="top-bar"> <div class="container"> <div class="row"> <div class="col-xs-8 col-sm-8 hidden-xs hidden-sm"> <span class="glyphicon glyphicon-home"></span> <a class="basic" href="http://www.ieee.org/" style="margin-left:3px;">IEEE.org</a> <span class="hidden-sm"> | <a class="basic" href="http://ieeexplore.ieee.org">IEEE <em>Xplore</em> Digital Library</a> | <a class="basic" href="http://standards.ieee.org/">IEEE Standards</a> | <a class="basic" href="http://spectrum.ieee.org/">IEEE Spectrum</a> | <a class="basic" href="http://www.ieee.org/sitemap.html">More Sites</a> </span> </div> <div class="col-xs-6 col-sm-6 visible-xs visible-sm"> <a href="http://ieee.org" target="_blank"> <img alt="Visit IEEE.org" style="margin-top:7px;" src="/assets/vtools_ui_img/ieee/ieee-logo-small-47b86b7f8d2e1873f3f8e5104d1c883d44f61e202b0f2dfc8af69840bcfc74f4.jpg" /> </a> </div>   <div class="col-xs-6 col-sm-6 col-md-4 col-lg-4 text-right"> <ul class="topbar-list list-inline" style="border: 0 !important;">   <li id="_vtools_signin_status" style="font-size:1.3em; border: 0 !important;"> <a href="/tego_/authentication/sign_in?_landing=/api/doc">Sign In</a> </li> </ul> </div> </div> </div> </div>   <div class="navbar-wrapper"> <div class="navbar navbar-main" id="fixed-navbar"> <div class="container"> <div class="row"> <div class="col-sm-12 column-header"> <div class="pull-right hidden-xs hidden-sm"> <a href="http://ieee.org" target="_blank"> <img alt="Visit IEEE.org" style="margin-top:7px;" src="/assets/vtools_ui_img/ieee/ieee-logo-small-47b86b7f8d2e1873f3f8e5104d1c883d44f61e202b0f2dfc8af69840bcfc74f4.jpg" /> </a> </div> <div style="white-space: nowrap;"> <a href="http://sites.ieee.org/vtools/" class="navbar-brand" style="padding-top: 15px !important;" target="_blank"> <span style="font-size: 40px; text-transform: none; font-weight: normal;"> <span style="color:black;" class="hidden-xs hidden-sm header_title">IEEE</span> <span class="ieee_primary_blue header_title">vTools</span> </span> </a> <a href="/"> <span class="content-box ieee_dark_lime_bg header_title" style="color:#FFFFFF; display: inline-block; margin:15px 0 0 8px; padding:2px 5px 2px 5px; font-weight:bold;"> EVENTS </span> </a> </div> </div> </div> <nav id="_vtools_app_nav" class="navbar navbar-default"> <div class="container-fluid"> <ul class="nav navbar-nav navbar-right visible-lg" style="float:right; margin-top: 10px; margin-right:0;"> <li class="dropdown dropdown-main" style="font-size:0.8em; white-space:normal; width:220px; text-align:right;"> </li> </ul>  <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#_vtools_app_nav_collapse" aria-expanded="false"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand visible-xs visible-sm" href="#">QuickNav</a> </div>  <div class="collapse navbar-collapse" id="_vtools_app_nav_collapse"> <ul class="nav navbar-nav"> <li class="dropdown dropdown-main" style=""> <a href="http://sites.ieee.org/vtools/" target="_blank" class="dropdown-toggle" data-hover="dropdown" data-toggle="dropdown">vTools<span class="fa fa-angle-down dropdown-arrow"></span></a> <ul class="dropdown-menu dropdown-subhover dropdown-animation animated fadeIn"> <li class=""><a href="http://sites.ieee.org/vtools" target="_blank" class="mn-menu-link">vTools Home</a></li> <li class=""><a href="http://sites.ieee.org/vtools/blog" target="_blank" class="mn-menu-link">vTools Blog</a></li> <li class="theme-border-bottom-heavy"> <a href="http://sites.ieee.org/vtools/training" target="_blank" class="mn-menu-link">vTools Tutorials</a> </li> <li><a href="https://engage.vtools.ieee.org" target="_blank" class="mn-menu-link">Engage</a></li> <li><a href="https://enotice.vtools.ieee.org" target="_blank" class="mn-menu-link">eNotice</a></li> <li><a href="https://events.vtools.ieee.org" target="_blank" class="mn-menu-link">Events</a></li> <li><a href="https://nominations.vtools.ieee.org" target="_blank" class="mn-menu-link">Nominations</a></li> <li><a href="https://officers.vtools.ieee.org" target="_blank" class="mn-menu-link">Officer Reporting</a></li> <li><a href="https://sbr.vtools.ieee.org" target="_blank" class="mn-menu-link">Student Branch Reporting</a></li> <li><a href="https://surveys.vtools.ieee.org" target="_blank" class="mn-menu-link">Surveys</a></li> <li><a href="https://voting.vtools.ieee.org" target="_blank" class="mn-menu-link">Voting</a></li> <li><a href="https://webinabox.vtools.ieee.org" target="_blank" class="mn-menu-link">WebInABox</a></li> <li><a href="https://xtreme.vtools.ieee.org" target="_blank" class="mn-menu-link">Xtreme</a></li> </ul> </li> <li><a href="/events/search"><span>Search</span></a></li><li><a href="/my_events"><span>My Events</span></a></li><li><a href="/tego_/events/administration"><span>Manage Events</span></a></li><li><a href="/api/doc"><span class="panel-primary vtools-main-nav-item color-main">API</span></a></li><li><a href="/about"><span>About</span></a></li><li><a href="/contact"><span>Contact</span></a></li> </ul> </div> </div> </nav> </div> </div> </div>   <div class="header _header_breadbrumb_bar ieee_dark_red_fade1_bg" style="width:100%; height:20px;"> </div> <div class="wedge20_topright_ieee_dark_red_fade1" style="float:right;"></div> </header>   <section class="content-40mg main-content"> <div class="container main-content-body"> <div id="_vtools_session_expired_message" style="display:none;" class="alert alert-warning alert-warning-rw" role="alert"> It appears that your session has timed out. Please <a href="/tego_/authentication/sign_in?_landing=/api/doc">click here to sign in</a> again.<br />NOTE that if there is any unsaved work on this page, it will be lost. </div>   <aside class="col-lg-2 col-md-2 col-sm-3" style="padding-left:0; padding-right:0;"> <nav role="navigation"> <div class="content-box content-box-bordered no-margin" style="padding:10px;"> <span class="ion-flask fa-5x ieee_dark_red"></span> <p class="no-margin" style="padding-top:10px; padding-bottom:10px; font-size:.9em;"> Welcome to<br />the Events API.  </p> </div> <ul class="sidebar-nav list-group no-margin" id="sidebar-nav"> <li class="list-group-item no-padding active"> <a title="API Home" class="tooltip-active" data-toggle="tooltip" data-placement="right" href="/api/doc">API Home</a> </li> <li class="list-group-item "> <a title="Produce a list of categories and subcategories" class="tooltip-active" data-toggle="tooltip" data-placement="right" href="/api/doc/categories">Category/Subcategory List</a> </li> <li class="list-group-item "> <a title="Produce a list of countries and states" class="tooltip-active" data-toggle="tooltip" data-placement="right" href="/api/doc/countries">Country/State List</a> </li> <li class="list-group-item "> <a title="Produce a list of events" class="tooltip-active" data-toggle="tooltip" data-placement="right" href="/api/doc/events">Events List</a> </li> <li class="list-group-item "> <a title="View Events List examples" class="tooltip-active" data-toggle="tooltip" data-placement="right" href="/api/doc/events_examples">Events List Examples</a> </li> <li class="list-group-item "> <a title="View legacy feeds (deprecated)" class="tooltip-active" data-toggle="tooltip" data-placement="right" href="/main/feeds">Legacy Feeds</a> </li> </ul> </nav> </aside>  <section class="col-lg-10 col-md-01 col-sm-9" style="padding-right:0;"> <h2 class="ieee_dark_red">  Events API </h2> <p>The Events API is a set of RESTful web services to allow programmatic interaction with the Events application. It is being developed based on the standard defined by <a target="_blank" href="http://jsonapi.org/">{json:api}</a>, but not strictly nor fully at this point. </p> <h3 class="ieee_dark_red" style="margin-top:30px;">Version Info</h3> <p>The Events API is namespaced by version, to allow evolution while maintaining backwards compatibility. The current version is <mark class="version">v4</mark>. <ul class="list-arrow-2"> <li>A request to the current version will look like: <span style="font-family: monospace;">/RST/events/api/public/<mark class="version">v4</mark>/...</span></li> <li>An example to a legacy version looks like: <span style="font-family: monospace;">/RST/events/api/public/<mark class="version">v1</mark>/...</span></li> </ul> Any features that are not available to certain versions will be noted as such in the documentation with a version flag <mark class="version tooltip-active" data-toggle="tooltip" data-placement="right" title="Version consideration was introduced in v2.">v2</mark>. <br /> <a href="/api/doc/history">Version history tracking</a> <mark class="version tooltip-active" data-toggle="tooltip" data-placement="right" title="Version history tracking was introduced in v4.">v4</mark> can be found here. </p> <h3 class="ieee_dark_red" style="margin-top:30px;">Response Information</h3> <div class="heading pt15"><h4>HTTP Status Codes</h4></div> <p>Response HTTP status codes are still being worked out, and should be considered somewhat volatile. However, to enable client certainty and development, the following assumptions should be true: <ul class="list-arrow-2"> <li>Any 200 status codes can be assumed to have completed successfully</li> <li>Any 400 status codes can be assumed to have failed, due to a client/request issue</li> <li>Any 500 status codes can be assumed to have failed, due to a server issue</li> </ul> </p> <h3 class="ieee_dark_red" style="margin-top:30px;">Standard Parameter Information</h3> <div class="heading pt15"><h4>DateTime Format</h4></div> <p>Recommended format for all date/time parameters is <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>, in UTC time zone (i.e. "2017-11-04T17:43:44,3456Z").</p> <div class="heading pt15"><h4>Limit</h4></div> <p>By default, Events API calls default to a limit of 500 results. Clients can apply a different limit with the 'limit' parameter.</p> <div class="panel panel-default"> <div class="panel-heading"> <h3 class="panel-title snippet-formatted code">?limit=1000</h3> </div> <div class="panel-body"> <a title="Events List API call with custom limit applied" class="tooltip-active" data-toggle="tooltip" data-placement="top" target="_blank" href="/RST/events/api/public/v4/events/list?limit=1000">/RST/events/api/public/v4/events/list?limit=1000</a> </div> </div> <div class="heading pt15"><h4>Span</h4></div> <p>An API call that returns a collection may implement the 'span' parameter to restrict results to only those records that fall within the date/time-span defined in the parameter value. </p> <p> <span style="font-weight:bold;">Important notes:</span> <ul> <li>The value of the 'span' parameter <span style="font-weight:bold;">must always have exactly one '~' character</span>. When specifying only a start date/time, the '~' will follow the date/time value (2017-10-20T11:43:44,12345Z~), and when specifying only an end date/time, the '~' will precede the date/time value (~2017-10-20T11:43:44,12345Z). When specifying both a start and end date/time, the '~' will come between the date/times (2017-10-20T11:43:44,12345Z~2017-11-20T11:43:44,12345Z).</li> <li>The value on either side of the '~' character can be specified as "now" (case-sensitive) in order to indicate that the current date/time should be utilized. <mark class="version tooltip-active" data-toggle="tooltip" data-placement="right" title="Support for 'now' span values was introduced in v2.">v2</mark> </li> <li>When the "now" string is used to indicate the current date/time for a span, there can also be extra information included to modify the value specified: <mark class="version tooltip-active" data-toggle="tooltip" data-placement="right" title="Support for enhanced 'now' span values was introduced in v3.">v3</mark> <ul> <li>Directly following "now", a "+" or "-" character can be included, followed by an integer. This indicates that a certain number of time units should be added or subtracted to the current date/time to arrive at the value to use in querying.</li> <li>Directly following the integer, the time unit that should be applied to the integer can be specified. It must be preceded by a '.' character. <i>The default unit, if none is specified, is "days".</i></li> <li>Examples: <ul> <li>now+15 : Current date/time plus 15 <i>days</i></li> <li>now-90.minutes : Current date/time minus 90 minutes</li> <li>now+1.year : Current date/time plus 1 year</li> <li>now-45.seconds : Current date/time minus 45 seconds</li> <li>now-8.months : Current date/time minus 8 months</li> </ul> </li> </ul> </li> <li>Please refer to the documentation page for the API endpoint to see if it supports the 'span' parameter and, if so, what column the 'span' parameter applies to.</li> </ul> </p> <div class="panel panel-default"> <div class="panel-heading"> <h3 class="panel-title snippet-formatted code">?span=~2017-10-20T11:43:44,12345Z&sort=-start-time</h3> </div> <div class="panel-body"> <a title="Events List API call with span applied" class="tooltip-active" data-toggle="tooltip" data-placement="top" target="_blank" href="/RST/events/api/public/v4/events/list?limit=10&sort=-start-time&span=~2017-10-20T11%3A43%3A44%2C12345Z">/RST/events/api/public/v4/events/list?limit=10&sort=-start-time&span=~2017-10-20T11%3A43%3A44%2C12345Z</a> </div> </div> <div class="heading pt15"><h4>Delta</h4></div> <p>For API calls that return collections, the 'delta' parameter can be used to restrict results to only those records that have been created or updated since the date/time specified in the parameter value.</p> <div class="panel panel-default"> <div class="panel-heading"> <h3 class="panel-title snippet-formatted code">?delta=2017-10-20T11:43:44,12345Z</h3> </div> <div class="panel-body"> <a title="Events List API call with delta applied" class="tooltip-active" data-toggle="tooltip" data-placement="top" target="_blank" href="/RST/events/api/public/v4/events/list?delta=2017-10-20T11%3A43%3A44%2C12345Z&limit=10&sort=-created-on">/RST/events/api/public/v4/events/list?delta=2017-10-20T11%3A43%3A44%2C12345Z&limit=10&sort=-created-on</a> </div> </div> <div class="heading pt15"><h4>Sorting</h4></div> <p>Sorting can be specified for API calls that return collections by specifying the attribute(s) to sort by, comma (',') separated. Descending sort can be indicated by prefixing the attribute with the minus ('-') character.</p> <div class="panel panel-default"> <div class="panel-heading"> <h3 class="panel-title snippet-formatted code">?sort=attribute1,-attribute2</h3> </div> <div class="panel-body"> <a title="Events List API call with sort applied" class="tooltip-active" data-toggle="tooltip" data-placement="top" target="_blank" href="/RST/events/api/public/v4/events/list?limit=10&sort=city%2C-title">/RST/events/api/public/v4/events/list?limit=10&sort=city%2C-title</a> </div> </div> </section> <br style="clear:both;" /> </div> </section>  <footer class="footer-light"> <div class="container"> <div class="row"> <div class="col-sm-12" style="text-align:center;"><a href="https://app.ieee.org/?utm_source=dhtml_footer&utm_medium=hp&utm_campaign=ieee-app2020%20" target="_blank" style="margin-left: auto;margin-right: auto;display: block;width: 728px;padding: 8px;"><img src="https://www.ieee.org//content/dam/ieee-org/ieee/web/org/the-ieee-app-footer-tap-connect-network-share-ad-728x90.jpg" class="img-responsive" alt="IEEE App" title="IEEE App"></a></div> <div class="col-sm-12" style="text-align:left;"> <a href="#" style="float:right; margin-left:20px; margin-right:-20px;" class="scroll-top"><div class="footer-scrolltop-holder"><span class="ion-ios7-arrow-up footer-scrolltop"></span></div></a> <a class="basic" href="/">Home</a>  |  <a class="basic" href="https://site.ieee.org/vtools/feature-requests-and-bug-reports/">Contact & Support</a>  |  <a class="basic" href="http://www.ieee.org/accessibility_statement.html">Accessibility</a>  |  <a class="basic" href="http://www.ieee.org/p9-26.html">Nondiscrimination Policy</a>  |  <a class="basic" href="https://secure.ethicspoint.com/domain/media/en/gui/20410/index.html">IEEE Ethics Reporting</a>  |  <a class="basic" href="https://www.ieee.org/security-privacy.html">Privacy & Opting Out of Cookies</a>  |  <a class="basic" href="http://www.ieee.org/about/feedback_ieee_site.html">Feedback</a> <br /> version 6.18.6 <br /> © Copyright 2013-2024 IEEE – All rights reserved. Use of this Web site signifies your agreement to the <a class="basic" href="http://www.ieee.org/site_terms_conditions.html">IEEE Terms and Conditions</a>.<br /> A not-for-profit organization, IEEE is the world's largest technical professional organization dedicated to advancing technology for the benefit of humanity.<br /> </div> </div> <br /><br /><br /> </div> </footer>  </div> </div> <script src="/assets/raleway/raleway-ab1019808585dce6e6a61409e394fd6bcaa5fdcd0056eee92283a4f2fedb8d11.js"></script> </body> </html>

CINXE.COM

Events API : vTools Events