GET v1/admin/company/{id}/Events/Upcoming?TopLevelOnly={TopLevelOnly}&sort={sort}

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

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 AllAdminEventsDetails
NameDescriptionTypeAdditional information
id

product id of an event.

string

None.

name

product name 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.

startDate

Startdate of an event.

date

None.

venue

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

string

None.

TotalAttendees

Total Attendees of an event.

string

None.

TotalWaitList

Total WaitList of an event.

string

None.

TotalRegistrants

Total Registrants of an event.

string

None.

productCategory

The product category of product

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "webDescription": "sample string 3",
    "webLongDescription": "sample string 4",
    "startDate": "2024-11-06T05:22:42.2931648+00:00",
    "venue": "sample string 6",
    "TotalAttendees": "sample string 7",
    "TotalWaitList": "sample string 8",
    "TotalRegistrants": "sample string 9",
    "productCategory": "sample string 10"
  },
  {
    "id": "sample string 1",
    "name": "sample string 2",
    "webDescription": "sample string 3",
    "webLongDescription": "sample string 4",
    "startDate": "2024-11-06T05:22:42.2931648+00:00",
    "venue": "sample string 6",
    "TotalAttendees": "sample string 7",
    "TotalWaitList": "sample string 8",
    "TotalRegistrants": "sample string 9",
    "productCategory": "sample string 10"
  }
]

text/html

Sample:
[{"id":"sample string 1","name":"sample string 2","webDescription":"sample string 3","webLongDescription":"sample string 4","startDate":"2024-11-06T05:22:42.2931648+00:00","venue":"sample string 6","TotalAttendees":"sample string 7","TotalWaitList":"sample string 8","TotalRegistrants":"sample string 9","productCategory":"sample string 10"},{"id":"sample string 1","name":"sample string 2","webDescription":"sample string 3","webLongDescription":"sample string 4","startDate":"2024-11-06T05:22:42.2931648+00:00","venue":"sample string 6","TotalAttendees":"sample string 7","TotalWaitList":"sample string 8","TotalRegistrants":"sample string 9","productCategory":"sample string 10"}]

application/xml, text/xml

Sample:
<ArrayOfv1_Admin_CompanyEndpointController.AllAdminEventsDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint">
  <v1_Admin_CompanyEndpointController.AllAdminEventsDetails>
    <TotalAttendees>sample string 7</TotalAttendees>
    <TotalRegistrants>sample string 9</TotalRegistrants>
    <TotalWaitList>sample string 8</TotalWaitList>
    <id>sample string 1</id>
    <name>sample string 2</name>
    <productCategory>sample string 10</productCategory>
    <startDate>2024-11-06T05:22:42.2931648+00:00</startDate>
    <venue>sample string 6</venue>
    <webDescription>sample string 3</webDescription>
    <webLongDescription>sample string 4</webLongDescription>
  </v1_Admin_CompanyEndpointController.AllAdminEventsDetails>
  <v1_Admin_CompanyEndpointController.AllAdminEventsDetails>
    <TotalAttendees>sample string 7</TotalAttendees>
    <TotalRegistrants>sample string 9</TotalRegistrants>
    <TotalWaitList>sample string 8</TotalWaitList>
    <id>sample string 1</id>
    <name>sample string 2</name>
    <productCategory>sample string 10</productCategory>
    <startDate>2024-11-06T05:22:42.2931648+00:00</startDate>
    <venue>sample string 6</venue>
    <webDescription>sample string 3</webDescription>
    <webLongDescription>sample string 4</webLongDescription>
  </v1_Admin_CompanyEndpointController.AllAdminEventsDetails>
</ArrayOfv1_Admin_CompanyEndpointController.AllAdminEventsDetails>