GET v1/Events?TopLevelOnly={TopLevelOnly}&sort={sort}

Retrieves the details for all events, including top levels and sessions and sessions of sessions.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
TopLevelOnly

If true then this will only return top level event information. Otherwise top level and child events will be included

 boolean

Default value is False
sort

A comma delimited list of columns to sort by. Field are sorted in ascending order by default. To have a field sort in descending order, preface it with the minus (-) sign.

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of AllEvents
NameDescriptionTypeAdditional information
id

product id of an event.

 integer

None.
parentProductId

parent product id of an event.

 integer

None.
hasSessions

true, when child sessions are available for particular event.

 boolean

None.
name

Name of an event.

 string

None.
startDate

Startdate of an event.

 date

None.
endDate

EndDate of an event.

 date

None.
requireAvailableSpace

If true, it will not be possible to add a registration for this even if there is no more available space.

 boolean

None.
webName

WebName of an event.

 string

None.
webDescription

A short rich text description of event with html encoding.

 string

None.
webLongDescription

A long rich text description of event with html encoding.

 string

None.
hasComplexPricing

If true, this indicates you must add the product to the cart in order to get an accurate price.

 boolean

None.
defaultPrice

decimal number

None.
defaultMemberPrice

decimal number

None.
nonMemberPrice

decimal number

None.
retailPrice

decimal number

None.
earlyRegistrationDate

date

None.
regularRegistrationDate

date

None.
lateRegistrationDate

date

None.
earlyRegistrationDiscount

Early registration discount, if applied to event.

 decimal number

None.
lateRegistrationFee

Late registration fee/dues, if applied to event.

 decimal number

None.
availableSpace

The available amount of space for an event.

 integer

None.
maxSpace

The maximum amount of space for an event.

 integer

None.
addressLine1

The addressLine1 of this event.

 string

None.
addressLine2

The addressLine2 of this event.

 string

None.
addressCity

The city of this event.

 string

None.
addressStateProvince

The state province of this event.

 string

None.
addressPostalCode

The postal code of this event.

 string

None.
addressCountry

The country of this event

 string

None.
venue

The name of the location where this event is taking place'.

 string

None.
hasScheduledSpeakers

true, when speakers are available for particular event.

 boolean

None.
hasSponsors

true, when sponsers are available for particular event.

 boolean

None.
currencyId

The currency the prices are in.

 integer

None.
currencySymbol

string

None.
productCategory

The product category of product

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": 1,
    "parentProductId": 2,
    "hasSessions": true,
    "name": "sample string 4",
    "startDate": "2024-09-27T22:40:46.8492861+00:00",
    "endDate": "2024-09-27T22:40:46.8492861+00:00",
    "requireAvailableSpace": true,
    "webName": "sample string 8",
    "webDescription": "sample string 9",
    "webLongDescription": "sample string 10",
    "hasComplexPricing": true,
    "defaultPrice": 12.0,
    "defaultMemberPrice": 13.0,
    "nonMemberPrice": 14.0,
    "retailPrice": 15.0,
    "earlyRegistrationDate": "2024-09-27T22:40:46.8492861+00:00",
    "regularRegistrationDate": "2024-09-27T22:40:46.8492861+00:00",
    "lateRegistrationDate": "2024-09-27T22:40:46.8492861+00:00",
    "earlyRegistrationDiscount": 19.0,
    "lateRegistrationFee": 20.0,
    "availableSpace": 21,
    "maxSpace": 22,
    "addressLine1": "sample string 23",
    "addressLine2": "sample string 24",
    "addressCity": "sample string 25",
    "addressStateProvince": "sample string 26",
    "addressPostalCode": "sample string 27",
    "addressCountry": "sample string 28",
    "venue": "sample string 29",
    "hasScheduledSpeakers": true,
    "hasSponsors": true,
    "currencyId": 32,
    "currencySymbol": "sample string 33",
    "productCategory": "sample string 34"
  },
  {
    "id": 1,
    "parentProductId": 2,
    "hasSessions": true,
    "name": "sample string 4",
    "startDate": "2024-09-27T22:40:46.8492861+00:00",
    "endDate": "2024-09-27T22:40:46.8492861+00:00",
    "requireAvailableSpace": true,
    "webName": "sample string 8",
    "webDescription": "sample string 9",
    "webLongDescription": "sample string 10",
    "hasComplexPricing": true,
    "defaultPrice": 12.0,
    "defaultMemberPrice": 13.0,
    "nonMemberPrice": 14.0,
    "retailPrice": 15.0,
    "earlyRegistrationDate": "2024-09-27T22:40:46.8492861+00:00",
    "regularRegistrationDate": "2024-09-27T22:40:46.8492861+00:00",
    "lateRegistrationDate": "2024-09-27T22:40:46.8492861+00:00",
    "earlyRegistrationDiscount": 19.0,
    "lateRegistrationFee": 20.0,
    "availableSpace": 21,
    "maxSpace": 22,
    "addressLine1": "sample string 23",
    "addressLine2": "sample string 24",
    "addressCity": "sample string 25",
    "addressStateProvince": "sample string 26",
    "addressPostalCode": "sample string 27",
    "addressCountry": "sample string 28",
    "venue": "sample string 29",
    "hasScheduledSpeakers": true,
    "hasSponsors": true,
    "currencyId": 32,
    "currencySymbol": "sample string 33",
    "productCategory": "sample string 34"
  }
]

text/html

Sample: 
[{"id":1,"parentProductId":2,"hasSessions":true,"name":"sample string 4","startDate":"2024-09-27T22:40:46.8492861+00:00","endDate":"2024-09-27T22:40:46.8492861+00:00","requireAvailableSpace":true,"webName":"sample string 8","webDescription":"sample string 9","webLongDescription":"sample string 10","hasComplexPricing":true,"defaultPrice":12.0,"defaultMemberPrice":13.0,"nonMemberPrice":14.0,"retailPrice":15.0,"earlyRegistrationDate":"2024-09-27T22:40:46.8492861+00:00","regularRegistrationDate":"2024-09-27T22:40:46.8492861+00:00","lateRegistrationDate":"2024-09-27T22:40:46.8492861+00:00","earlyRegistrationDiscount":19.0,"lateRegistrationFee":20.0,"availableSpace":21,"maxSpace":22,"addressLine1":"sample string 23","addressLine2":"sample string 24","addressCity":"sample string 25","addressStateProvince":"sample string 26","addressPostalCode":"sample string 27","addressCountry":"sample string 28","venue":"sample string 29","hasScheduledSpeakers":true,"hasSponsors":true,"currencyId":32,"currencySymbol":"sample string 33","productCategory":"sample string 34"},{"id":1,"parentProductId":2,"hasSessions":true,"name":"sample string 4","startDate":"2024-09-27T22:40:46.8492861+00:00","endDate":"2024-09-27T22:40:46.8492861+00:00","requireAvailableSpace":true,"webName":"sample string 8","webDescription":"sample string 9","webLongDescription":"sample string 10","hasComplexPricing":true,"defaultPrice":12.0,"defaultMemberPrice":13.0,"nonMemberPrice":14.0,"retailPrice":15.0,"earlyRegistrationDate":"2024-09-27T22:40:46.8492861+00:00","regularRegistrationDate":"2024-09-27T22:40:46.8492861+00:00","lateRegistrationDate":"2024-09-27T22:40:46.8492861+00:00","earlyRegistrationDiscount":19.0,"lateRegistrationFee":20.0,"availableSpace":21,"maxSpace":22,"addressLine1":"sample string 23","addressLine2":"sample string 24","addressCity":"sample string 25","addressStateProvince":"sample string 26","addressPostalCode":"sample string 27","addressCountry":"sample string 28","venue":"sample string 29","hasScheduledSpeakers":true,"hasSponsors":true,"currencyId":32,"currencySymbol":"sample string 33","productCategory":"sample string 34"}]

application/xml, text/xml

Sample: 
<ArrayOfv1_Events_EventsEndpointController.AllEvents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Events_EventsEndpoint">
  <v1_Events_EventsEndpointController.AllEvents>
    <addressCity>sample string 25</addressCity>
    <addressCountry>sample string 28</addressCountry>
    <addressLine1>sample string 23</addressLine1>
    <addressLine2>sample string 24</addressLine2>
    <addressPostalCode>sample string 27</addressPostalCode>
    <addressStateProvince>sample string 26</addressStateProvince>
    <availableSpace>21</availableSpace>
    <currencyId>32</currencyId>
    <currencySymbol>sample string 33</currencySymbol>
    <defaultMemberPrice>13</defaultMemberPrice>
    <defaultPrice>12</defaultPrice>
    <earlyRegistrationDate>2024-09-27T22:40:46.8492861+00:00</earlyRegistrationDate>
    <earlyRegistrationDiscount>19</earlyRegistrationDiscount>
    <endDate>2024-09-27T22:40:46.8492861+00:00</endDate>
    <hasComplexPricing>true</hasComplexPricing>
    <hasScheduledSpeakers>true</hasScheduledSpeakers>
    <hasSessions>true</hasSessions>
    <hasSponsors>true</hasSponsors>
    <id>1</id>
    <lateRegistrationDate>2024-09-27T22:40:46.8492861+00:00</lateRegistrationDate>
    <lateRegistrationFee>20</lateRegistrationFee>
    <maxSpace>22</maxSpace>
    <name>sample string 4</name>
    <nonMemberPrice>14</nonMemberPrice>
    <parentProductId>2</parentProductId>
    <productCategory>sample string 34</productCategory>
    <regularRegistrationDate>2024-09-27T22:40:46.8492861+00:00</regularRegistrationDate>
    <requireAvailableSpace>true</requireAvailableSpace>
    <retailPrice>15</retailPrice>
    <startDate>2024-09-27T22:40:46.8492861+00:00</startDate>
    <venue>sample string 29</venue>
    <webDescription>sample string 9</webDescription>
    <webLongDescription>sample string 10</webLongDescription>
    <webName>sample string 8</webName>
  </v1_Events_EventsEndpointController.AllEvents>
  <v1_Events_EventsEndpointController.AllEvents>
    <addressCity>sample string 25</addressCity>
    <addressCountry>sample string 28</addressCountry>
    <addressLine1>sample string 23</addressLine1>
    <addressLine2>sample string 24</addressLine2>
    <addressPostalCode>sample string 27</addressPostalCode>
    <addressStateProvince>sample string 26</addressStateProvince>
    <availableSpace>21</availableSpace>
    <currencyId>32</currencyId>
    <currencySymbol>sample string 33</currencySymbol>
    <defaultMemberPrice>13</defaultMemberPrice>
    <defaultPrice>12</defaultPrice>
    <earlyRegistrationDate>2024-09-27T22:40:46.8492861+00:00</earlyRegistrationDate>
    <earlyRegistrationDiscount>19</earlyRegistrationDiscount>
    <endDate>2024-09-27T22:40:46.8492861+00:00</endDate>
    <hasComplexPricing>true</hasComplexPricing>
    <hasScheduledSpeakers>true</hasScheduledSpeakers>
    <hasSessions>true</hasSessions>
    <hasSponsors>true</hasSponsors>
    <id>1</id>
    <lateRegistrationDate>2024-09-27T22:40:46.8492861+00:00</lateRegistrationDate>
    <lateRegistrationFee>20</lateRegistrationFee>
    <maxSpace>22</maxSpace>
    <name>sample string 4</name>
    <nonMemberPrice>14</nonMemberPrice>
    <parentProductId>2</parentProductId>
    <productCategory>sample string 34</productCategory>
    <regularRegistrationDate>2024-09-27T22:40:46.8492861+00:00</regularRegistrationDate>
    <requireAvailableSpace>true</requireAvailableSpace>
    <retailPrice>15</retailPrice>
    <startDate>2024-09-27T22:40:46.8492861+00:00</startDate>
    <venue>sample string 29</venue>
    <webDescription>sample string 9</webDescription>
    <webLongDescription>sample string 10</webLongDescription>
    <webName>sample string 8</webName>
  </v1_Events_EventsEndpointController.AllEvents>
</ArrayOfv1_Events_EventsEndpointController.AllEvents>