Response Formats

The RegOnline API currently supports the following response formats:

SOAP/XML
When making a request to the RegOnline API using SOAP, the response returned will also be in SOAP/XML format. The following is an example of the data returned from the GetEvents method.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
      <soap:Body>
            <GetEventsResponse xmlns="https://www.regonline.com/api">
                  <GetEventsResult>
                        <Success>true</Success>
                        <Data>
                              <APIEvent>
                                    <ID>555555</ID>
                                    <CustomerID>222333</CustomerID>
                                    <Status>Testing</Status>
                                    <Title>Testing Event</Title>
                                    <StartDate xsi:nil="true" />
                                    <EndDate xsi:nil="true" />
                                    <ActiveDate xsi:nil="true" />
                                    <ClientEventID />
                                    <TypeID>9</TypeID>
                                    <City />
                                    <State />
                                    <Country />
                                    <PostalCode />
                                    <LocationName />
                                    <LocationRoom />
                                    <LocationPhone />
                                    <LocationBuilding />
                                    <LocationAddress1 />
                                    <LocationAddress2 />
                                    <TimeZone>GMT</TimeZone>
                                    <CurrencyCode>EUR</CurrencyCode>
                                    <Keywords />
                                    <AddDate>2009-07-09T10:30:57.783</AddDate>
                                    <AddBy>demo1</AddBy>
                                    <ModDate>2011-04-22T09:57:23.373</ModDate>
                                    <ModBy>Admin</ModBy>
                                    <Channel>Running</Channel>
                                    <IsWaitlisted>false</IsWaitlisted>
                                    <Culture>English (United Kingdom)</Culture>
                                    <MediaType>Other</MediaType>
                                    <IsActive>false</IsActive>
                                    <IsOnSite>false</IsOnSite>
                                    <Latitude xsi:nil="true" />
                                    <Longitude xsi:nil="true" />
                                    <TotalRevenue xsi:nil="true" />
                                    <TotalRegistrations xsi:nil="true" />
                                    <TotalCancels xsi:nil="true" />
                                    <TotalSubstitutions xsi:nil="true" />
                                    <TargetAttendance xsi:nil="true" />
                                    <TotalIncompletes xsi:nil="true" />
                              </APIEvent>                              
                        </Data>
                  </GetEventsResult>
            </GetEventsResponse>
      </soap:Body>
</soap:Envelope>

JSON
Requests from Javascript via JSONP will result in a response format of JSON. The following is an example of the data returned from the GetEvents method.

{
   "__type":"ActiveEvents.Core.API.Event",
   "ID":555555,
   "CustomerID":222122,
   "Status":"Active",
   "Title":"Hawaii Cruise 2011",
   "StartDate":"/Date(1312610400000)/",
   "EndDate":"/Date(1313215200000)/",
   "ActiveDate":"/Date(1281724010337)/",
   "ClientEventID":"",
   "TypeID":1,
   "Type":null,
   "City":"",
   "State":"Hawaii",
   "Country":"",
   "PostalCode":"",
   "LocationName":"Pride of America",
   "LocationRoom":"7 Night Island Cruise",
   "LocationPhone":"",
   "LocationBuilding":"",
   "LocationAddress1":"",
   "LocationAddress2":"",
   "TimeZone":"Eastern Time",
   "Capacity":null,
   "CurrencyCode":"USD",
   "Keywords":"",
   "AddDate":"/Date(1280830499827)/",
   "AddBy":"Admin",
   "ModDate":"/Date(1311952520550)/",
   "ModBy":"tslater",
   "Channel":"Professional & Continuing Education",
   "IsWaitlisted":false,
   "Culture":"English (United States)",
   "MediaType":"Other",
   "IsActive":true,
   "IsOnSite":false,
   "Latitude":null,
   "Longitude":null,
   "TotalRevenue":null,
   "TotalRevenueFormatted":"",
   "TotalRegistrations":null,
   "TotalCancels":null,
   "TotalSubstitutions":null,
   "TargetAttendance":null,
   "TotalIncompletes":null
}
Posted: August 2nd, 2011

RegOnline by Lanyon is the easy-to-use, affordable online registration and event management software. Turn your next conference, meeting, trade show into a huge success. Event management solutions include online registration forms, event websites, badges, event marketing, credit card processing and so much more. Sign up today for a free trial.

TRUSTe online privacy certification Lanyon Solutions, Inc.
717 North Harwood
Dallas, Texas 75201
email: info@lanyon.com | Toll Free: 1-888-351-9948

 

© Copyright 2017 | RegOnline by Lanyon | All Rights Reserved