Make a request »

EventService.GetEventsWithSessions

Gets all events with their sessions. Includes: events registration settings, session registration settings and session parameters. Works with Event 3.0 or newer (Direct method) See code examples


URL Parameters

Http verb: POST
URI: Full url: http://se.api.anpasia.com/event/v2/sessions
URL parameters:
Not used

Body parameters

Body parameters
specification
Optional filters

StartTime String The event start date (Optional)
EndTime String The event end date (Optional)
ExcludeEnabled Boolean Exclude enabled events (Optional)
ExcludeDisabled Boolean Exclude disabled events (Optional)
Body Example

{
    "StartTime": "20160107T000000",
    "EndTime": "20160108T000000",
    "ExcludeEnabled": false,
    "ExcludeDisabled": false
}
<GetEventsWithSessions xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <StartTime>20160107T000000</StartTime>
  <EndTime>20160108T000000</EndTime>
  <ExcludeEnabled>false</ExcludeEnabled>
  <ExcludeDisabled>false</ExcludeDisabled>
</GetEventsWithSessions>
                

Response

Body parameters
returns
Response object that includes events with sessions, status code and status message

Code Int32 The response Code.
Message String The response Message.
Result
The response Result.

EventWithSessions
Events with sessions

Id Int32 Event ID
Name String Event name
Enabled Boolean Whether or not the event is enabled
RegistrationFormUrl String URL to public event registration form
RegistrationSettings
Event registration settings

RegistrationStartTime Boolean Registration start time
RegistrationDeadline Boolean Registration deadline
RegistrationLimit Boolean Registration limit
AllowRegistrationToWaitingList Boolean Allow registration to waiting list
HideFullyBookedClosedSessionsInForm Boolean Hide fully booked/closed sessions in form
AllowRegistrationOfAdditionalGuests Boolean Allow registration of additional guests
RequestGuestDetailsInForm Boolean Request guest details in form
Sessions
Event sessions

Session
Event sessions

Id Int32 Session ID
Title String Session title
StartTime DateTime Session start time
EndTime DateTime Session end time
RegistrationSettings
Session registration settings

RegistrationStartTime Nullable<DateTime> Registration start time
RegistrationDeadline Nullable<DateTime> Registration deadline
RegistrationLimit Nullable<Int32> Registration limit
WaitingList Nullable<Int32> Waiting list (if fully booked)
AdditionalGuests Nullable<Int32> Additional guests
SessionParameters
Session parameters

CalendarReminder String Calendar reminder
MapToLocation String Map to location
SessionCity String Session city
SessionVenue String Session venue
SessionContactName String Session contact name
SessionContactEmail String Session contact email
CustomParameters
Session custom parameters

SessionCustomParameter
Session custom parameter

Name String Parameter name
Value String Parameter value
CanRegisterToSession Boolean Whether or not attendees can register to session based on the following criteria: event is enabled; session end time has not passed; (if activated) session registration start time has passed; (if activated) session registration deadline has not passed; (if activated) session registration limit was not reached; (if activated) session waiting list limit was not reached.
Body Example


{
    "Code": 1,
    "Message": "Succesfully retrieved events with their sessions",
    "Result": [
        {
            "Enabled": true,
            "Id": 4341,
            "Name": "Some event",
            "RegistrationFormUrl": "https:\/\/anpdm.com\/public\/event\/RegistrationForm\/43475D467147445F4271",
            "RegistrationSettings": {
                "AllowRegistrationOfAdditionalGuests": false,
                "AllowRegistrationToWaitingList": true,
                "HideFullyBookedClosedSessionsInForm": false,
                "RegistrationDeadline": true,
                "RegistrationLimit": true,
                "RegistrationStartTime": true,
                "RequestGuestDetailsInForm": false
            },
            "Sessions": [
                {
                    "CanRegisterToSession": false,
                    "EndTime": "\/Date(1448942400000+0800)\/",
                    "Id": 345234,
                    "RegistrationSettings": {
                        "AdditionalGuests": null,
                        "RegistrationDeadline": "\/Date(1447948800000+0800)\/",
                        "RegistrationLimit": 50,
                        "RegistrationStartTime": "\/Date(1446307200000+0800)\/",
                        "WaitingList": 10
                    },
                    "SessionParameters": {
                        "CalendarReminder": "Some event's morning session",
                        "CustomParameters": [
                            {
                                "Name": "DressCode",
                                "Value": "Smart casual"
                            }
                        ],
                        "MapToLocation": "Apsis, Stormgatan 11, Malmö, Sweden",
                        "SessionCity": "Malmö",
                        "SessionContactEmail": "someone@somewhere.com",
                        "SessionContactName": "Someone",
                        "SessionVenue": ""
                    },
                    "StartTime": "\/Date(1448931600000+0800)\/",
                    "Title": "Morning session"
                },
                {
                    "CanRegisterToSession": false,
                    "EndTime": "\/Date(1448956800000+0800)\/",
                    "Id": 323452,
                    "RegistrationSettings": {
                        "AdditionalGuests": null,
                        "RegistrationDeadline": "\/Date(1447948800000+0800)\/",
                        "RegistrationLimit": 75,
                        "RegistrationStartTime": "\/Date(1446307200000+0800)\/",
                        "WaitingList": 10
                    },
                    "SessionParameters": {
                        "CalendarReminder": "Some event's afternoon session",
                        "CustomParameters": [
                             
                        ],
                        "MapToLocation": "Apsis, Stormgatan 11, Malmö, Sweden",
                        "SessionCity": "Malmö",
                        "SessionContactEmail": "someone@somewhere.com",
                        "SessionContactName": "Someone",
                        "SessionVenue": ""
                    },
                    "StartTime": "\/Date(1448946000000+0800)\/",
                    "Title": "Afternoon session"
                }
            ]
        },
        {
            "Enabled": true,
            "Id": 4341,
            "Name": "Some event",
            "RegistrationFormUrl": "https:\/\/anpdm.com\/public\/event\/RegistrationForm\/43475D467147445F4271",
            "RegistrationSettings": {
                "AllowRegistrationOfAdditionalGuests": false,
                "AllowRegistrationToWaitingList": true,
                "HideFullyBookedClosedSessionsInForm": false,
                "RegistrationDeadline": true,
                "RegistrationLimit": true,
                "RegistrationStartTime": true,
                "RequestGuestDetailsInForm": false
            },
            "Sessions": [
                {
                    "CanRegisterToSession": false,
                    "EndTime": "\/Date(1448942400000+0800)\/",
                    "Id": 345234,
                    "RegistrationSettings": {
                        "AdditionalGuests": null,
                        "RegistrationDeadline": "\/Date(1447948800000+0800)\/",
                        "RegistrationLimit": 50,
                        "RegistrationStartTime": "\/Date(1446307200000+0800)\/",
                        "WaitingList": 10
                    },
                    "SessionParameters": {
                        "CalendarReminder": "Some event's morning session",
                        "CustomParameters": [
                            {
                                "Name": "DressCode",
                                "Value": "Smart casual"
                            }
                        ],
                        "MapToLocation": "Apsis, Stormgatan 11, Malmö, Sweden",
                        "SessionCity": "Malmö",
                        "SessionContactEmail": "someone@somewhere.com",
                        "SessionContactName": "Someone",
                        "SessionVenue": ""
                    },
                    "StartTime": "\/Date(1448931600000+0800)\/",
                    "Title": "Morning session"
                },
                {
                    "CanRegisterToSession": false,
                    "EndTime": "\/Date(1448956800000+0800)\/",
                    "Id": 323452,
                    "RegistrationSettings": {
                        "AdditionalGuests": null,
                        "RegistrationDeadline": "\/Date(1447948800000+0800)\/",
                        "RegistrationLimit": 75,
                        "RegistrationStartTime": "\/Date(1446307200000+0800)\/",
                        "WaitingList": 10
                    },
                    "SessionParameters": {
                        "CalendarReminder": "Some event's afternoon session",
                        "CustomParameters": [
                             
                        ],
                        "MapToLocation": "Apsis, Stormgatan 11, Malmö, Sweden",
                        "SessionCity": "Malmö",
                        "SessionContactEmail": "someone@somewhere.com",
                        "SessionContactName": "Someone",
                        "SessionVenue": ""
                    },
                    "StartTime": "\/Date(1448946000000+0800)\/",
                    "Title": "Afternoon session"
                }
            ]
        }
    ]
}
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>1</Code>
  <Message>Succesfully retrieved events with their sessions</Message>
  <Result>
    <EventWithSessions>
      <Enabled>true</Enabled>
      <Id>4341</Id>
      <Name>Some event</Name>
      <RegistrationFormUrl>https://anpdm.com/public/event/RegistrationForm/43475D467147445F4271</RegistrationFormUrl>
      <RegistrationSettings>
        <AllowRegistrationOfAdditionalGuests>false</AllowRegistrationOfAdditionalGuests>
        <AllowRegistrationToWaitingList>true</AllowRegistrationToWaitingList>
        <HideFullyBookedClosedSessionsInForm>false</HideFullyBookedClosedSessionsInForm>
        <RegistrationDeadline>true</RegistrationDeadline>
        <RegistrationLimit>true</RegistrationLimit>
        <RegistrationStartTime>true</RegistrationStartTime>
        <RequestGuestDetailsInForm>false</RequestGuestDetailsInForm>
      </RegistrationSettings>
      <Sessions>
        <Session>
          <CanRegisterToSession>false</CanRegisterToSession>
          <EndTime>2015-12-01T12:00:00</EndTime>
          <Id>345234</Id>
          <RegistrationSettings>
            <AdditionalGuests i:nil="true" />
            <RegistrationDeadline>2015-11-20T00:00:00</RegistrationDeadline>
            <RegistrationLimit>50</RegistrationLimit>
            <RegistrationStartTime>2015-11-01T00:00:00</RegistrationStartTime>
            <WaitingList>10</WaitingList>
          </RegistrationSettings>
          <SessionParameters>
            <CalendarReminder>Some event's morning session</CalendarReminder>
            <CustomParameters>
              <SessionCustomParameter>
                <Name>DressCode</Name>
                <Value>Smart casual</Value>
              </SessionCustomParameter>
            </CustomParameters>
            <MapToLocation>Apsis, Stormgatan 11, Malmö, Sweden</MapToLocation>
            <SessionCity>Malmö</SessionCity>
            <SessionContactEmail>someone@somewhere.com</SessionContactEmail>
            <SessionContactName>Someone</SessionContactName>
            <SessionVenue />
          </SessionParameters>
          <StartTime>2015-12-01T09:00:00</StartTime>
          <Title>Morning session</Title>
        </Session>
        <Session>
          <CanRegisterToSession>false</CanRegisterToSession>
          <EndTime>2015-12-01T16:00:00</EndTime>
          <Id>323452</Id>
          <RegistrationSettings>
            <AdditionalGuests i:nil="true" />
            <RegistrationDeadline>2015-11-20T00:00:00</RegistrationDeadline>
            <RegistrationLimit>75</RegistrationLimit>
            <RegistrationStartTime>2015-11-01T00:00:00</RegistrationStartTime>
            <WaitingList>10</WaitingList>
          </RegistrationSettings>
          <SessionParameters>
            <CalendarReminder>Some event's afternoon session</CalendarReminder>
            <CustomParameters />
            <MapToLocation>Apsis, Stormgatan 11, Malmö, Sweden</MapToLocation>
            <SessionCity>Malmö</SessionCity>
            <SessionContactEmail>someone@somewhere.com</SessionContactEmail>
            <SessionContactName>Someone</SessionContactName>
            <SessionVenue />
          </SessionParameters>
          <StartTime>2015-12-01T13:00:00</StartTime>
          <Title>Afternoon session</Title>
        </Session>
      </Sessions>
    </EventWithSessions>
    <EventWithSessions>
      <Enabled>true</Enabled>
      <Id>4341</Id>
      <Name>Some event</Name>
      <RegistrationFormUrl>https://anpdm.com/public/event/RegistrationForm/43475D467147445F4271</RegistrationFormUrl>
      <RegistrationSettings>
        <AllowRegistrationOfAdditionalGuests>false</AllowRegistrationOfAdditionalGuests>
        <AllowRegistrationToWaitingList>true</AllowRegistrationToWaitingList>
        <HideFullyBookedClosedSessionsInForm>false</HideFullyBookedClosedSessionsInForm>
        <RegistrationDeadline>true</RegistrationDeadline>
        <RegistrationLimit>true</RegistrationLimit>
        <RegistrationStartTime>true</RegistrationStartTime>
        <RequestGuestDetailsInForm>false</RequestGuestDetailsInForm>
      </RegistrationSettings>
      <Sessions>
        <Session>
          <CanRegisterToSession>false</CanRegisterToSession>
          <EndTime>2015-12-01T12:00:00</EndTime>
          <Id>345234</Id>
          <RegistrationSettings>
            <AdditionalGuests i:nil="true" />
            <RegistrationDeadline>2015-11-20T00:00:00</RegistrationDeadline>
            <RegistrationLimit>50</RegistrationLimit>
            <RegistrationStartTime>2015-11-01T00:00:00</RegistrationStartTime>
            <WaitingList>10</WaitingList>
          </RegistrationSettings>
          <SessionParameters>
            <CalendarReminder>Some event's morning session</CalendarReminder>
            <CustomParameters>
              <SessionCustomParameter>
                <Name>DressCode</Name>
                <Value>Smart casual</Value>
              </SessionCustomParameter>
            </CustomParameters>
            <MapToLocation>Apsis, Stormgatan 11, Malmö, Sweden</MapToLocation>
            <SessionCity>Malmö</SessionCity>
            <SessionContactEmail>someone@somewhere.com</SessionContactEmail>
            <SessionContactName>Someone</SessionContactName>
            <SessionVenue />
          </SessionParameters>
          <StartTime>2015-12-01T09:00:00</StartTime>
          <Title>Morning session</Title>
        </Session>
        <Session>
          <CanRegisterToSession>false</CanRegisterToSession>
          <EndTime>2015-12-01T16:00:00</EndTime>
          <Id>323452</Id>
          <RegistrationSettings>
            <AdditionalGuests i:nil="true" />
            <RegistrationDeadline>2015-11-20T00:00:00</RegistrationDeadline>
            <RegistrationLimit>75</RegistrationLimit>
            <RegistrationStartTime>2015-11-01T00:00:00</RegistrationStartTime>
            <WaitingList>10</WaitingList>
          </RegistrationSettings>
          <SessionParameters>
            <CalendarReminder>Some event's afternoon session</CalendarReminder>
            <CustomParameters />
            <MapToLocation>Apsis, Stormgatan 11, Malmö, Sweden</MapToLocation>
            <SessionCity>Malmö</SessionCity>
            <SessionContactEmail>someone@somewhere.com</SessionContactEmail>
            <SessionContactName>Someone</SessionContactName>
            <SessionVenue />
          </SessionParameters>
          <StartTime>2015-12-01T13:00:00</StartTime>
          <Title>Afternoon session</Title>
        </Session>
      </Sessions>
    </EventWithSessions>
  </Result>
</Response>
                

Help

Code examples


curl -i -X POST
-H 'Content-type: application/json'
-H 'Accept: application/json' 
-H 'Authorization: basic $api_key_64baseformat'
-d '{
    "StartTime": "20160107T000000",
    "EndTime": "20160108T000000",
    "ExcludeEnabled": false,
    "ExcludeDisabled": false
}'
url http://se.api.anpasia.com/event/v2/sessions