GET api/EventSetup?APIKey={APIKey}&ClientId={ClientId}&EventCode={EventCode}&IncludePrices={IncludePrices}&IncludeSponsors={IncludeSponsors}&MeetingCustomColumns={MeetingCustomColumns}&RegistrationCustomColumns={RegistrationCustomColumns}&SessionCustomColumns={SessionCustomColumns}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
Required |
|
ClientId | string |
Required |
|
EventCode | string |
Required |
|
IncludePrices | boolean |
Required |
|
IncludeSponsors | boolean |
Default value is False |
|
MeetingCustomColumns | string |
Default value is |
|
RegistrationCustomColumns | string |
Default value is |
|
SessionCustomColumns | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
EventRequestName | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
Required |
|
ClientId | string |
Required |
|
Id | globally unique identifier |
None. |
|
MeetingSetupId | globally unique identifier |
None. |
|
Code | string |
Required |
|
Name | string |
Required |
|
Description | string |
Required |
|
StartDate | date |
Required |
|
EndDate | date |
Required |
|
RegistrationStartDate | date |
None. |
|
RegistrationEndDate | date |
None. |
|
Capacity | integer |
Required |
|
WebSiteUrl | string |
None. |
|
PublishToWeb | boolean |
None. |
|
WebRole | string |
None. |
|
Topic | string |
None. |
|
Closed | boolean |
None. |
|
Location | Location |
None. |
|
Custom | Custom |
None. |
|
RelatedEntity | RelatedEntity |
None. |
|
Registrations | Registrations |
Required |
|
Sessions | Sessions |
None. |
|
Sponsors | Sponsors |
None. |
Response Formats
application/json, text/json
Sample:
{ "APIKey": "sample string 1", "ClientId": "sample string 2", "Id": "ac1f5be4-bc5f-4998-b493-08acc7fbed33", "MeetingSetupId": "c10ba014-39da-456a-b00f-f24bc7d4b120", "Code": "sample string 5", "Name": "sample string 6", "Description": "sample string 7", "StartDate": "2025-03-15T05:10:42.7094783+00:00", "EndDate": "2025-03-15T05:10:42.7094783+00:00", "RegistrationStartDate": "2025-03-15T05:10:42.7094783+00:00", "RegistrationEndDate": "2025-03-15T05:10:42.7094783+00:00", "Capacity": 12, "WebSiteUrl": "sample string 13", "PublishToWeb": true, "WebRole": "sample string 15", "Topic": "sample string 16", "Closed": true, "Location": { "Id": "ba549302-3256-4696-9ec6-05a2001107d9", "Name": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "PostalCode": "sample string 7", "Country": "sample string 8", "Phone": "sample string 9", "WebURL": "sample string 10" }, "Custom": { "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] }, "RelatedEntity": { "EntityList": [ { "LogicalName": "sample string 1", "Id": "0aa0c966-9f15-4055-b269-15cb77490aff", "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] }, { "LogicalName": "sample string 1", "Id": "0aa0c966-9f15-4055-b269-15cb77490aff", "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] } ] }, "Registrations": { "Registration": [ { "Id": "9e8c7f68-62e5-4cb8-8dab-c390a1f90c9d", "Code": "sample string 2", "Name": "sample string 3", "MemberPrice": 4.0, "NonMemberPrice": 5.0, "MembersOnly": true, "IsPackage": true, "RegistrationClosed": true, "Custom": { "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] }, "Prices": { "Price": [ { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 }, { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 } ] } }, { "Id": "9e8c7f68-62e5-4cb8-8dab-c390a1f90c9d", "Code": "sample string 2", "Name": "sample string 3", "MemberPrice": 4.0, "NonMemberPrice": 5.0, "MembersOnly": true, "IsPackage": true, "RegistrationClosed": true, "Custom": { "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] }, "Prices": { "Price": [ { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 }, { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 } ] } } ] }, "Sessions": { "Session": [ { "Id": "75514342-6594-42c9-9df3-a0fabce956b5", "Code": "sample string 2", "Name": "sample string 3", "Description": "sample string 4", "StartDate": "2025-03-15T05:10:42.7094783+00:00", "EndDate": "2025-03-15T05:10:42.7094783+00:00", "Capacity": 7, "MemberPrice": 8.0, "NonMemberPrice": 9.0, "MembersOnly": true, "SessionType": "sample string 11", "SessionClosed": true, "CourseId": "7ced746a-6167-4fbd-9c86-c71312c72169", "Custom": { "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] }, "Prices": { "Price": [ { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 }, { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 } ] }, "Speakers": [ { "Name": "sample string 1", "JobTitle": "sample string 2", "Image": "sample string 3", "ParentCustomer": "sample string 4" }, { "Name": "sample string 1", "JobTitle": "sample string 2", "Image": "sample string 3", "ParentCustomer": "sample string 4" } ] }, { "Id": "75514342-6594-42c9-9df3-a0fabce956b5", "Code": "sample string 2", "Name": "sample string 3", "Description": "sample string 4", "StartDate": "2025-03-15T05:10:42.7094783+00:00", "EndDate": "2025-03-15T05:10:42.7094783+00:00", "Capacity": 7, "MemberPrice": 8.0, "NonMemberPrice": 9.0, "MembersOnly": true, "SessionType": "sample string 11", "SessionClosed": true, "CourseId": "7ced746a-6167-4fbd-9c86-c71312c72169", "Custom": { "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] }, "Prices": { "Price": [ { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 }, { "Name": "sample string 1", "Valueminimum": 2.0, "Valuemaximum": 3.0, "Startdate": "2025-03-15T05:10:42.7094783+00:00", "Enddate": "2025-03-15T05:10:42.7094783+00:00", "Pricepercent": 6.0 } ] }, "Speakers": [ { "Name": "sample string 1", "JobTitle": "sample string 2", "Image": "sample string 3", "ParentCustomer": "sample string 4" }, { "Name": "sample string 1", "JobTitle": "sample string 2", "Image": "sample string 3", "ParentCustomer": "sample string 4" } ] } ] }, "Sponsors": { "Sponsor": [ { "Id": "24bead35-904a-49b2-9ef3-01db14fed282", "Name": "sample string 2", "Description": "sample string 3", "LogoURL": "sample string 4", "WebSiteURL": "sample string 5" }, { "Id": "24bead35-904a-49b2-9ef3-01db14fed282", "Name": "sample string 2", "Description": "sample string 3", "LogoURL": "sample string 4", "WebSiteURL": "sample string 5" } ] } }
application/xml, text/xml
Sample:
<EventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Event"> <APIKey>sample string 1</APIKey> <Capacity>12</Capacity> <ClientId>sample string 2</ClientId> <Closed>true</Closed> <Code>sample string 5</Code> <Custom> <Attribute xmlns:d3p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d3p1:Attribute> <d3p1:FormattedValue>sample string 3</d3p1:FormattedValue> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Type>text</d3p1:Type> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Attribute> <d3p1:Attribute> <d3p1:FormattedValue>sample string 3</d3p1:FormattedValue> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Type>text</d3p1:Type> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Attribute> </Attribute> </Custom> <Description>sample string 7</Description> <EndDate>2025-03-15T05:10:42.7094783+00:00</EndDate> <Id>ac1f5be4-bc5f-4998-b493-08acc7fbed33</Id> <Location> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <City>sample string 5</City> <Country>sample string 8</Country> <Id>ba549302-3256-4696-9ec6-05a2001107d9</Id> <Name>sample string 2</Name> <Phone>sample string 9</Phone> <PostalCode>sample string 7</PostalCode> <State>sample string 6</State> <WebURL>sample string 10</WebURL> </Location> <MeetingSetupId>c10ba014-39da-456a-b00f-f24bc7d4b120</MeetingSetupId> <Name>sample string 6</Name> <PublishToWeb>true</PublishToWeb> <RegistrationEndDate>2025-03-15T05:10:42.7094783+00:00</RegistrationEndDate> <RegistrationStartDate>2025-03-15T05:10:42.7094783+00:00</RegistrationStartDate> <Registrations> <Registration> <Registration> <Code>sample string 2</Code> <Custom> <Attribute xmlns:d6p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> </Attribute> </Custom> <Id>9e8c7f68-62e5-4cb8-8dab-c390a1f90c9d</Id> <IsPackage>true</IsPackage> <MemberPrice>4</MemberPrice> <MembersOnly>true</MembersOnly> <Name>sample string 3</Name> <NonMemberPrice>5</NonMemberPrice> <Prices> <Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> </Price> </Prices> <RegistrationClosed>true</RegistrationClosed> </Registration> <Registration> <Code>sample string 2</Code> <Custom> <Attribute xmlns:d6p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> </Attribute> </Custom> <Id>9e8c7f68-62e5-4cb8-8dab-c390a1f90c9d</Id> <IsPackage>true</IsPackage> <MemberPrice>4</MemberPrice> <MembersOnly>true</MembersOnly> <Name>sample string 3</Name> <NonMemberPrice>5</NonMemberPrice> <Prices> <Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> </Price> </Prices> <RegistrationClosed>true</RegistrationClosed> </Registration> </Registration> </Registrations> <RelatedEntity> <EntityList> <EntityList> <Attribute xmlns:d5p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d5p1:Attribute> <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Type>text</d5p1:Type> <d5p1:Value>sample string 2</d5p1:Value> </d5p1:Attribute> <d5p1:Attribute> <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Type>text</d5p1:Type> <d5p1:Value>sample string 2</d5p1:Value> </d5p1:Attribute> </Attribute> <Id>0aa0c966-9f15-4055-b269-15cb77490aff</Id> <LogicalName>sample string 1</LogicalName> </EntityList> <EntityList> <Attribute xmlns:d5p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d5p1:Attribute> <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Type>text</d5p1:Type> <d5p1:Value>sample string 2</d5p1:Value> </d5p1:Attribute> <d5p1:Attribute> <d5p1:FormattedValue>sample string 3</d5p1:FormattedValue> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Type>text</d5p1:Type> <d5p1:Value>sample string 2</d5p1:Value> </d5p1:Attribute> </Attribute> <Id>0aa0c966-9f15-4055-b269-15cb77490aff</Id> <LogicalName>sample string 1</LogicalName> </EntityList> </EntityList> </RelatedEntity> <Sessions> <Session> <Session> <Capacity>7</Capacity> <Code>sample string 2</Code> <CourseId>7ced746a-6167-4fbd-9c86-c71312c72169</CourseId> <Custom> <Attribute xmlns:d6p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> </Attribute> </Custom> <Description>sample string 4</Description> <EndDate>2025-03-15T05:10:42.7094783+00:00</EndDate> <Id>75514342-6594-42c9-9df3-a0fabce956b5</Id> <MemberPrice>8</MemberPrice> <MembersOnly>true</MembersOnly> <Name>sample string 3</Name> <NonMemberPrice>9</NonMemberPrice> <Prices> <Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> </Price> </Prices> <SessionClosed>true</SessionClosed> <SessionType>sample string 11</SessionType> <Speakers> <Speaker> <Image>sample string 3</Image> <JobTitle>sample string 2</JobTitle> <Name>sample string 1</Name> <ParentCustomer>sample string 4</ParentCustomer> </Speaker> <Speaker> <Image>sample string 3</Image> <JobTitle>sample string 2</JobTitle> <Name>sample string 1</Name> <ParentCustomer>sample string 4</ParentCustomer> </Speaker> </Speakers> <StartDate>2025-03-15T05:10:42.7094783+00:00</StartDate> </Session> <Session> <Capacity>7</Capacity> <Code>sample string 2</Code> <CourseId>7ced746a-6167-4fbd-9c86-c71312c72169</CourseId> <Custom> <Attribute xmlns:d6p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> <d6p1:Attribute> <d6p1:FormattedValue>sample string 3</d6p1:FormattedValue> <d6p1:Key>sample string 1</d6p1:Key> <d6p1:Type>text</d6p1:Type> <d6p1:Value>sample string 2</d6p1:Value> </d6p1:Attribute> </Attribute> </Custom> <Description>sample string 4</Description> <EndDate>2025-03-15T05:10:42.7094783+00:00</EndDate> <Id>75514342-6594-42c9-9df3-a0fabce956b5</Id> <MemberPrice>8</MemberPrice> <MembersOnly>true</MembersOnly> <Name>sample string 3</Name> <NonMemberPrice>9</NonMemberPrice> <Prices> <Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> <Price> <Enddate>2025-03-15T05:10:42.7094783+00:00</Enddate> <Name>sample string 1</Name> <Pricepercent>6</Pricepercent> <Startdate>2025-03-15T05:10:42.7094783+00:00</Startdate> <Valuemaximum>3</Valuemaximum> <Valueminimum>2</Valueminimum> </Price> </Price> </Prices> <SessionClosed>true</SessionClosed> <SessionType>sample string 11</SessionType> <Speakers> <Speaker> <Image>sample string 3</Image> <JobTitle>sample string 2</JobTitle> <Name>sample string 1</Name> <ParentCustomer>sample string 4</ParentCustomer> </Speaker> <Speaker> <Image>sample string 3</Image> <JobTitle>sample string 2</JobTitle> <Name>sample string 1</Name> <ParentCustomer>sample string 4</ParentCustomer> </Speaker> </Speakers> <StartDate>2025-03-15T05:10:42.7094783+00:00</StartDate> </Session> </Session> </Sessions> <Sponsors> <Sponsor> <Sponsor> <Description>sample string 3</Description> <Id>24bead35-904a-49b2-9ef3-01db14fed282</Id> <LogoURL>sample string 4</LogoURL> <Name>sample string 2</Name> <WebSiteURL>sample string 5</WebSiteURL> </Sponsor> <Sponsor> <Description>sample string 3</Description> <Id>24bead35-904a-49b2-9ef3-01db14fed282</Id> <LogoURL>sample string 4</LogoURL> <Name>sample string 2</Name> <WebSiteURL>sample string 5</WebSiteURL> </Sponsor> </Sponsor> </Sponsors> <StartDate>2025-03-15T05:10:42.7094783+00:00</StartDate> <Topic>sample string 16</Topic> <WebRole>sample string 15</WebRole> <WebSiteUrl>sample string 13</WebSiteUrl> </EventRequest>