Reference for http://apisandbox.inapub.co.uk/api.svc/events/name/{NAME}/postcode/{CODE}/{RADIUS}/?page={PG}&appID={APPID}
Given an event name, a postcode and a search radius in miles returns a page of events, returned as XML by default.
Url: http://apisandbox.inapub.co.uk/api.svc/events/name/{NAME}/postcode/{CODE}/{RADIUS}/?page={PG}&appID={APPID}
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<Events xmlns="http://schemas.datacontract.org/2004/07/EventilityAPI.DataContracts"> <EventList> <Event> <Details> <Capacity>2147483647</Capacity> <EventImageId>2147483647</EventImageId> <EventVenues> <EventVenueList> <EventVenues.EventVenue> <EventId>2147483647</EventId> <Latitude>1.26743233E+15</Latitude> <Longitude>1.26743233E+15</Longitude> <StartDateTime>1999-05-31T11:20:00</StartDateTime> <VenueId>2147483647</VenueId> <VenueName>String content</VenueName> </EventVenues.EventVenue> <EventVenues.EventVenue> <EventId>2147483647</EventId> <Latitude>1.26743233E+15</Latitude> <Longitude>1.26743233E+15</Longitude> <StartDateTime>1999-05-31T11:20:00</StartDateTime> <VenueId>2147483647</VenueId> <VenueName>String content</VenueName> </EventVenues.EventVenue> </EventVenueList> <TotalVenueCount>2147483647</TotalVenueCount> </EventVenues> <IsPublic>true</IsPublic> <Notes>String content</Notes> <Tags>String content</Tags> </Details> <EventEndDateTime>1999-05-31T11:20:00</EventEndDateTime> <EventId>2147483647</EventId> <EventPrice>String content</EventPrice> <EventRecurrence> <DayOfMonth>2147483647</DayOfMonth> <DayOfWeek>UseDayOfMonth</DayOfWeek> <Frequency>Weekly</Frequency> <RecurEvery>2147483647</RecurEvery> <Recurrence>First</Recurrence> </EventRecurrence> <EventStartDateTime>1999-05-31T11:20:00</EventStartDateTime> <EventTitle>String content</EventTitle> <VenueLatitude>1.26743237E+15</VenueLatitude> <VenueLongitude>1.26743237E+15</VenueLongitude> </Event> <Event> <Details> <Capacity>2147483647</Capacity> <EventImageId>2147483647</EventImageId> <EventVenues> <EventVenueList> <EventVenues.EventVenue> <EventId>2147483647</EventId> <Latitude>1.26743233E+15</Latitude> <Longitude>1.26743233E+15</Longitude> <StartDateTime>1999-05-31T11:20:00</StartDateTime> <VenueId>2147483647</VenueId> <VenueName>String content</VenueName> </EventVenues.EventVenue> <EventVenues.EventVenue> <EventId>2147483647</EventId> <Latitude>1.26743233E+15</Latitude> <Longitude>1.26743233E+15</Longitude> <StartDateTime>1999-05-31T11:20:00</StartDateTime> <VenueId>2147483647</VenueId> <VenueName>String content</VenueName> </EventVenues.EventVenue> </EventVenueList> <TotalVenueCount>2147483647</TotalVenueCount> </EventVenues> <IsPublic>true</IsPublic> <Notes>String content</Notes> <Tags>String content</Tags> </Details> <EventEndDateTime>1999-05-31T11:20:00</EventEndDateTime> <EventId>2147483647</EventId> <EventPrice>String content</EventPrice> <EventRecurrence> <DayOfMonth>2147483647</DayOfMonth> <DayOfWeek>UseDayOfMonth</DayOfWeek> <Frequency>Weekly</Frequency> <RecurEvery>2147483647</RecurEvery> <Recurrence>First</Recurrence> </EventRecurrence> <EventStartDateTime>1999-05-31T11:20:00</EventStartDateTime> <EventTitle>String content</EventTitle> <VenueLatitude>1.26743237E+15</VenueLatitude> <VenueLongitude>1.26743237E+15</VenueLongitude> </Event> </EventList> <TotalEventCount>2147483647</TotalEventCount> </Events>
The following is an example response Json body:
{ "EventList":[{ "Details":{ "Capacity":2147483647, "EventImageId":2147483647, "EventVenues":{ "EventVenueList":[{ "EventId":2147483647, "Latitude":1.26743233E+15, "Longitude":1.26743233E+15, "StartDateTime":"\/Date(928146000000+0100)\/", "VenueId":2147483647, "VenueName":"String content" }], "TotalVenueCount":2147483647 }, "IsPublic":true, "Notes":"String content", "Tags":"String content" }, "EventEndDateTime":"\/Date(928146000000+0100)\/", "EventId":2147483647, "EventPrice":"String content", "EventRecurrence":{ "DayOfMonth":2147483647, "DayOfWeek":0, "Frequency":0, "RecurEvery":2147483647, "Recurrence":0 }, "EventStartDateTime":"\/Date(928146000000+0100)\/", "EventTitle":"String content", "VenueLatitude":1.26743237E+15, "VenueLongitude":1.26743237E+15 }], "TotalEventCount":2147483647 }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/EventilityAPI.DataContracts" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/EventilityAPI.DataContracts" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:complexType name="Events"> <xs:sequence> <xs:element minOccurs="0" name="EventList" nillable="true" type="tns:ArrayOfEvent" /> <xs:element minOccurs="0" name="TotalEventCount" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="Events" nillable="true" type="tns:Events" /> <xs:complexType name="ArrayOfEvent"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Event" nillable="true" type="tns:Event" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfEvent" nillable="true" type="tns:ArrayOfEvent" /> <xs:complexType name="Event"> <xs:sequence> <xs:element minOccurs="0" name="Details" nillable="true" type="tns:Event.EventDetails" /> <xs:element minOccurs="0" name="EventEndDateTime" type="xs:dateTime" /> <xs:element minOccurs="0" name="EventId" type="xs:int" /> <xs:element minOccurs="0" name="EventPrice" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="EventRecurrence" nillable="true" type="tns:EventRecurrence" /> <xs:element minOccurs="0" name="EventStartDateTime" type="xs:dateTime" /> <xs:element minOccurs="0" name="EventTitle" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="VenueLatitude" type="xs:float" /> <xs:element minOccurs="0" name="VenueLongitude" type="xs:float" /> </xs:sequence> </xs:complexType> <xs:element name="Event" nillable="true" type="tns:Event" /> <xs:complexType name="Event.EventDetails"> <xs:sequence> <xs:element minOccurs="0" name="Capacity" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="EventImageId" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="EventVenues" nillable="true" type="tns:EventVenues" /> <xs:element minOccurs="0" name="IsPublic" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="Notes" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Tags" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Event.EventDetails" nillable="true" type="tns:Event.EventDetails" /> <xs:complexType name="EventVenues"> <xs:sequence> <xs:element minOccurs="0" name="EventVenueList" nillable="true" type="tns:ArrayOfEventVenues.EventVenue" /> <xs:element minOccurs="0" name="TotalVenueCount" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="EventVenues" nillable="true" type="tns:EventVenues" /> <xs:complexType name="ArrayOfEventVenues.EventVenue"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="EventVenues.EventVenue" nillable="true" type="tns:EventVenues.EventVenue" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfEventVenues.EventVenue" nillable="true" type="tns:ArrayOfEventVenues.EventVenue" /> <xs:complexType name="EventVenues.EventVenue"> <xs:sequence> <xs:element minOccurs="0" name="EventId" type="xs:int" /> <xs:element minOccurs="0" name="Latitude" nillable="true" type="xs:double" /> <xs:element minOccurs="0" name="Longitude" nillable="true" type="xs:double" /> <xs:element minOccurs="0" name="StartDateTime" type="xs:dateTime" /> <xs:element minOccurs="0" name="VenueId" type="xs:int" /> <xs:element minOccurs="0" name="VenueName" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="EventVenues.EventVenue" nillable="true" type="tns:EventVenues.EventVenue" /> <xs:complexType name="EventRecurrence"> <xs:sequence> <xs:element minOccurs="0" name="DayOfMonth" type="xs:int" /> <xs:element minOccurs="0" name="DayOfWeek" type="tns:EventRecurrence.DayOfWeekEnum" /> <xs:element minOccurs="0" name="Frequency" type="tns:EventRecurrence.FrequencyEnum" /> <xs:element minOccurs="0" name="RecurEvery" type="xs:int" /> <xs:element minOccurs="0" name="Recurrence" type="tns:EventRecurrence.RecurrenceEnum" /> </xs:sequence> </xs:complexType> <xs:element name="EventRecurrence" nillable="true" type="tns:EventRecurrence" /> <xs:simpleType name="EventRecurrence.DayOfWeekEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="UseDayOfMonth" /> <xs:enumeration value="Sunday" /> <xs:enumeration value="Monday" /> <xs:enumeration value="Tuesday" /> <xs:enumeration value="Wednesday" /> <xs:enumeration value="Thursday" /> <xs:enumeration value="Friday" /> <xs:enumeration value="Saturday" /> <xs:enumeration value="Day" /> <xs:enumeration value="Weekday" /> <xs:enumeration value="Weekend_Day" /> </xs:restriction> </xs:simpleType> <xs:element name="EventRecurrence.DayOfWeekEnum" nillable="true" type="tns:EventRecurrence.DayOfWeekEnum" /> <xs:simpleType name="EventRecurrence.FrequencyEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="Weekly"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Monthly"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="EventRecurrence.FrequencyEnum" nillable="true" type="tns:EventRecurrence.FrequencyEnum" /> <xs:simpleType name="EventRecurrence.RecurrenceEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="First"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Second"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Third"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Fourth"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Last"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="EventRecurrence.RecurrenceEnum" nillable="true" type="tns:EventRecurrence.RecurrenceEnum" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>