def getEventSearchResults(self,searchText=None,categoryID=None,locationID=None,speakerID=None,
startsOnDate=None,startsOnTime=None,statusFlag=None):
'''getEventSearchResults
Returns an XML payload containing an event listing. This data set returned is smaller than the
getEvents request and intend for listing results. Use the result in combination with the getEvent call to
pull addition information on a specific event.
Sample Request URL: http://.../?do=cnt.getservice&service=getEventSearchResults
Parameter Options:
:param searchText: Text string used to perform a general search of the events. This parameter is used to find
matches in the title, description, objectives or speaker names.
:param categoryID: Numeric value containing a valid category. Use the 'getSearchOptions' call to obtain a
valid list of categories
:param locationID: Numeric value containing a valid location. Use the 'getSearchOptions' call to obtain a
valid list of locations
:param speakerID: Numeric value containing a valid speaker. Use the 'getSearchOptions' call to obtain the
list of possible speakers.
:param startsOnDate: Date value containing a valid date. Use the 'getSearchOptions' call to obtain a valid list
of dates.
:param startsOnTime: Time value in 12 hour format. E.g. 6:30PM
:param statusFlag: Valid values: 1-Active; 0-Inactive; -1-All; Used to indicate if the event is active or
inactive. Generally inactive events are events that have been cancelled or removed by the client.
'''
url = "%s/?do=cnt.getservice&service=getEventSearchResults" %(self.api.base)
args = {"searchText":searchText,
"categoryID":categoryID,
"locationID":locationID,
"speakerID":speakerID,
"startsOnDate":startsOnDate,
"startsOnTime":startsOnTime,
"statusFlag":statusFlag}
result = self.get_result(url,args)
return parse_items(result,"event")
def getAttendeesFormResponses(self,formID,startInitial=None,endInitial=None):
'''getAttendeesFormResponses
Returns an XML payload containing a full listing of attendee contact data and form responses for the
specified form. For each attendee a 'formResponses' node returned in the XML payload. This service
is only allowed to be run between 11 PM EST and 5 AM EST.
Sample Request URL: http://.../?do=cnt.getservice&service=getAttendeesFormResponse
Parameter Options:
:param *formID: Numeric value; Identifies the form for which to retrieve responses.
:param attendeeID: Numeric value; Identifies the attendee record to update.
:param startInitial: 1 character used to indicate the starting initial of the last name range to include. E.g. A
:param endInitial: 1 character used to indicate the starting initial of the last name range to include. If the
'startInitial' is provided but no 'endInitial' is provided the system uses the 'startInitial' as the
'endInitial'. E.g. B
'''
# Note to developer - this endpoint has not been tested, was reported wrong in docs
# https://github.com/vsoch/ohbm/issues/3
url = "%s/?do=cnt.getservice&service=getAttendeesItineraryData" %(self.api.base)
# Initials should probably always be uppercase
if startInitial != None:
startInitial = capitalize(startInitial)
if endInitial != None:
endInitial = capitalize(endInitial)
args = {"formID":formID,
"startInitial":startInitial,
"endInitial":endInitial}
result = self.get_result(url,args)
return parse_items(result,'attendee')
def getAttendeesItineraryData(self,attendeeID=None,startInitial=None,endInitial=None,insertedInLastHoursSpan=None):
'''getAttendeesItineraryData
Returns an XML payload containing a full listing of all attendee itinerary data. For each attendee their
itinerary will be returned in the XML payload. This service is only allowed to be run between 11 PM
EST and 5 AM EST. Note: For clients using the Attendee Itinerary Update service, only itinerary
items with the attributes='ReadWrite' can be modified.
Sample Request URL: http://.../?do=cnt.getservice&service=getAttendeesItineraryData
Parameter Options:
:param attendeeID: Numeric value; Identifies the attendee record to update.
:param startInitial: 1 character used to indicate the starting initial of the last name range to include. E.g. A
:param endInitial: 1 character used to indicate the starting initial of the last name range to include. If the
'startInitial' is provided but no 'endInitial' is provided the system uses the 'startInitial' as the
'endInitial'. E.g. B
:param insertedInLastHoursSpan: Used to indicate the number of hour of newly inserted records to include.
The default is 24. This must be a valid integer between 1 and 26,280.
'''
url = "%s/?do=cnt.getservice&service=getAttendeesItineraryData" %(self.api.base)
# Initials should probably always be uppercase
if startInitial != None:
startInitial = capitalize(startInitial)
if endInitial != None:
endInitial = capitalize(endInitial)
args = {"attendeeID":attendeeID,
"startInitial":startInitial,
"endInitial":endInitial,
"insertedInLastHoursSpan":insertedInLastHoursSpan}
result = self.get_result(url,args)
return parse_items(result,'attendee')
def getSpeakers(self,isScheduledFor,includeActiveStatus,formIDs,modifiedOnAfter,modifiedOnBefore):
'''getSpeakers
Returns an XML payload containing a full listing of all speaker data. Speakers are defined as attendees
whom are participating in the meeting in a specific capacity. E.g. Presenting in a session or
Moderating a session or Presenting a Poster. This service also returns the schedule for each speaker.
This includes all itinerary items that are 'active' (can be changed via includeActiveStatus parameter),
and 'public'.
Sample Request URL: http://.../?do=cnt.getservice&service=getSpeakers
Parameter Options:
:param isScheduledFor: Numeric value of (1,2 or 3) - This filters the speakers returned by schedule type:
Valid values; 1 = For Event, 2 = For Abstract, 3 = For Event OR Abstract. Note that this parameter
only affects whether or not a speaker record is included in the results set. It does not change the
itinerary items that are returned in each speaker's schedule block. For example, if isScheduledFor=2,
Any speaker who is linked to at least 1 Abstract will be shown. Any 'active', and 'public' itinerary
items that are linked to an Event will still be shown in the schedule for this speaker.
:param includeActiveStatus: Numeric value of (0,1, or 99) - Determines if active, inactive, or ALL itinerary
items are shown in the <schedule> block.
:param formIDs: Comma delimited list of form ids
:param modifiedOnAfter: Valid date string. Using this filter will return speakers who have updated contact
information, schedule, or form responses after/on this date.
:param modifiedOnBefore: Valid date string. Using this filter will return speakers who have updated contact
information, schedule, or form responses before/on this date.
'''
url = "%s/?do=cnt.getservice&service=getSpeakers" %(self.api.base)
args = {"isScheduledFor":isScheduledFor,
"includeActiveStatus":includeActiveStatus,
"formIDs":formIDs,
"modifiedOnAfter":modifiedOnAfter,
"modifiedOnBefore":modifiedOnBefore}
result = self.get_result(url,args)
return parse_items(result,'speaker')
def getAttendeesRegData(self,attendeeID=None,startInitial=None,endInitial=None,formID=None):
'''getAttendeesRegData
Returns an XML payload containing a full listing of all attendee purchases. For each attendee their
purchase or order history will be returned in the XML payload. This service is only allowed to be run
between 11 PM EST and 5 AM EST .
Sample Request URL: http://.../?do=cnt.getservice&service=getAttendeesRegData
Parameter Options:
:param attendeeID: Numeric value, Identifies the attendee record to update.
:param startInitial: 1 character used to indicate the starting initial of the last name range to include. E.g. A
:param endInitial: 1 character used to indicate the starting initial of the last name range to include. If the
'startInitial' is provided but no 'endInitial' is provided the system uses the 'startInitial' as the
'endInitial'. E.g. B
:param formID: Numeric value of a demographic form
'''
url = "%s/?do=cnt.getservice&service=getAttendeesRegData" %(self.api.base)
# Initials should probably always be uppercase
if startInitial != None:
startInitial = capitalize(startInitial)
if endInitial != None:
endInitial = capitalize(endInitial)
args = {"attendeeID":attendeeID,
"startInitial":startInitial,
"endInitial":endInitial,
"formID":formID}
result = self.get_result(url,args)
return parse_items(result,'attendee')
def getAbstracts(self,
categoryID=None,
speakerID=None,
abstractTypeID=None,
acceptedFlag=None):
'''getAbstracts
Returns an XML payload containing a full listing of all abstract data. Abstract data consists primarily
of the title, abstract number, purpose, materials & methods, results & conclusions.
Sample Request URL: http://.../?do=cnt.getservice&service=getAbstracts
Parameter Options:
:param categoryID: Numeric value containing a valid category. Use the 'getSearchOptions' call to obtain a
valid list of categories
:param speakerID: Numeric value containing a valid speaker. Use the 'getSearchOptions' call to obtain the
list of possible speakers.
:param abstractTypeID: Numeric value containing a valid abstract type. Use the 'getSearchOptions' call to
obtain the list of possible abstract types.
:param acceptedFlag: Boolean value (0 or 1). Default is 1.
'''
url = "%s/?do=cnt.getservice&service=getAbstracts" % (self.api.base)
args = {
"categoryID": categoryID,
"speakerID": speakerID,
"abstractTypeID": abstractTypeID,
"acceptedFlag": acceptedFlag
}
result = self.get_result(url, args)
return parse_items(result, 'abstract')
def getAbstractSearchResults(self,
searchText,
categoryID=None,
speakerID=None,
abstractTypeID=None):
'''getAbstractSearchResults
Returns an XML payload containing an abstract listing. This data set returned is smaller than the
getAbstracts request and intend for listing results. Use the result in combination with the getAbstract
call to pull addition information on a specific abstract.
Sample Request URL: http://.../?do=cnt.getservice&service=getAbstractSearchResults
Parameter Options:
:param *searchText: Text string used to perform a general search of the events. This parameter is used to find
matches in the title, description, objectives or speaker names.
:param categoryID: Numeric value containing a valid category. Use the 'getSearchOptions' call to obtain a
valid list of categories
:param speakerID: Numeric value containing a valid speaker. Use the 'getSearchOptions' call to obtain the
list of possible speakers.
:param abstractTypeID: Numeric value containing a valid abstract type. Use the 'getSearchOptions' call to
obtain the list of possible abstract types. acceptedFlag: Boolean value (0 or 1). Default is 1.
'''
url = "%s/?do=cnt.getservice&service=getAbstractSearchResults" % (
self.api.base)
args = {
"searchText": searchText,
"categoryID": categoryID,
"speakerID": speakerID,
"abstractTypeID": abstractTypeID
}
result = self.get_result(url, args)
return parse_items(result, 'abstract')
def getEvents(self,statusFlag=None,publicUseFlag=None,approvedFlag=None,
categoryID=None,plannerID=None,startsOnDate=None):
'''Returns an XML payload containing a full listing of all event or session data. Event or session data
consists primarily of the name, date, time description and location of events. Note: the tag,
AI_ATTENDEEID, may be used within data elements and serves as a placeholder to be replaced by a
valid attendee ID. This method is only available in its entirety between 7PM and 7AM. Between 7AM and 7PM the
method will at most 5 event entries.
:param statusFlag: Valid values: 1-Active; 0-Inactive; -1-All; Used to indicate if the event is active or
inactive. Generally inactive events are events that have been cancelled or removed by the client.
:param publicUseFlag: Valid values: 1=Public; 0=Private; -1=All; Used to determine the types of events to
include. Public events are viewable to the general population. Private events are events clients are
witholding from the general viewing public
:param approvedFlag: Valid values: 1=Approved; 0=Not Approved; -1=Both; Used to determine the types of
events to include. Note that a site setting can be used to use approvedFlag=1 by default. However,
passing the parameter via the url will override the site setting parameter.
:param categoryID: Numeric value; Use the 'getCategories' REST call to pull a list of valid categories.
:param plannerID: Numeric value containing a valid planner.
:param startsOnDate: Date value containing a valid date. Use the 'getSearchOptions' call to obtain a valid list
of dates.
'''
url = "%s/?do=cnt.getservice&service=getEvents" %(self.api.base)
args = {"statusFlag":statusFlag,
"publicUseFlag":publicUseFlag,
"approvedFlag":approvedFlag,
"categoryID":categoryID,
"plannerID":plannerID,
"startsOnDate":startsOnDate}
result = self.get_result(url,args)
return parse_items(result,"event")
def getAbstractSearchResults(self,searchText,categoryID=None,speakerID=None,abstractTypeID=None):
'''getAbstractSearchResults
Returns an XML payload containing an abstract listing. This data set returned is smaller than the
getAbstracts request and intend for listing results. Use the result in combination with the getAbstract
call to pull addition information on a specific abstract.
Sample Request URL: http://.../?do=cnt.getservice&service=getAbstractSearchResults
Parameter Options:
:param *searchText: Text string used to perform a general search of the events. This parameter is used to find
matches in the title, description, objectives or speaker names.
:param categoryID: Numeric value containing a valid category. Use the 'getSearchOptions' call to obtain a
valid list of categories
:param speakerID: Numeric value containing a valid speaker. Use the 'getSearchOptions' call to obtain the
list of possible speakers.
:param abstractTypeID: Numeric value containing a valid abstract type. Use the 'getSearchOptions' call to
obtain the list of possible abstract types. acceptedFlag: Boolean value (0 or 1). Default is 1.
'''
url = "%s/?do=cnt.getservice&service=getAbstractSearchResults" %(self.api.base)
args = {"searchText":searchText,
"categoryID":categoryID,
"speakerID":speakerID,
"abstractTypeID":abstractTypeID}
result = self.get_result(url,args)
return parse_items(result,'abstract')
def getLocations(self):
'''getLocations
Returns an XML payload containing a full listing of location and room data.
Sample Request URL: http://.../?do=cnt.getservice&service=getLocations
'''
url = "%s/?do=cnt.getservice&service=getLocations" %(self.api.base)
result = self.get_result(url)
return parse_items(result,'location')
def getMeetingTimes(self):
'''getMeetingTimes
Returns an XML payload containing a listing of all active meeting times/time ranges.
Sample Request URL: http://.../?do=cnt.getservice&service=getMeetingTimes
'''
url = "%s/?do=cnt.getservice&service=getMeetingTimes" %(self.api.base)
result = self.get_result(url)
return parse_items(result,'meetingTime')
def getLocations(self):
'''getLocations
Returns an XML payload containing a full listing of location and room data.
Sample Request URL: http://.../?do=cnt.getservice&service=getLocations
'''
url = "%s/?do=cnt.getservice&service=getLocations" % (self.api.base)
result = self.get_result(url)
return parse_items(result, 'location')
def getMeetingTimes(self):
'''getMeetingTimes
Returns an XML payload containing a listing of all active meeting times/time ranges.
Sample Request URL: http://.../?do=cnt.getservice&service=getMeetingTimes
'''
url = "%s/?do=cnt.getservice&service=getMeetingTimes" % (self.api.base)
result = self.get_result(url)
return parse_items(result, 'meetingTime')
def getScheduledRoles(self,eventType=None):
'''getScheduledRoles
Returns an XML payload containing roles used by Events or Abstracts. Role data will contain the role
name, type, and public label.
Sample Request URL: http://.../?do=cnt.getservice&service=getScheduledRoles
:param eventType: Integer valid values: 1= Event, 2=Abstract
If not provided the system defaults to sending Event roles.
'''
url = "%s/?do=cnt.getservice&service=getScheduledRoles" %(self.api.base)
args = {"type":eventType}
result = self.get_result(url,args)
return parse_items(result,'role')
def getExhibitors(self):
'''service=getExhibitors
Returns an XML payload containing a full listing of all exhibitor data. Exhibitor data consists
primarily of the company name, address and contact information.
Sample Request URL: http://.../?do=cnt.getservice&service=getExhibitors
Parameter Options:
:param apiKey: Valid API key
'''
url = "%s/?do=cnt.getservice&service=getExhibitors" %(self.api.base)
result = self.get_result(url)
return parse_items(result,'exhibitor')
def getExhibitors(self):
'''service=getExhibitors
Returns an XML payload containing a full listing of all exhibitor data. Exhibitor data consists
primarily of the company name, address and contact information.
Sample Request URL: http://.../?do=cnt.getservice&service=getExhibitors
Parameter Options:
:param apiKey: Valid API key
'''
url = "%s/?do=cnt.getservice&service=getExhibitors" %(self.api.base)
result = self.get_result(url)
return parse_items(result,'exhibitor')
def getRegistrationTypes(self):
'''getRegistrationTypes
Returns an XML payload containing registration type data. Registration type data will contain the
registration type name, code, description, and evaluation links. Note: The tag, AI_ATTENDEEID, may
be used within data elements and serves as a placeholder to be replaced by a valid attendee ID. The tag,
AI_EVENTID, may be used within data elements and serves as a placeholder to be replaced by a valid
event ID.
Sample Request URL: http://.../?do=cnt.getservice&service=getRegistrationTypes
'''
url = "%s/?do=cnt.getservice&service=getRegistrationTypes" %(self.api.base)
result = self.get_result(url)
return parse_items(result,'registrationType')
def getRegistrationTypes(self):
'''getRegistrationTypes
Returns an XML payload containing registration type data. Registration type data will contain the
registration type name, code, description, and evaluation links. Note: The tag, AI_ATTENDEEID, may
be used within data elements and serves as a placeholder to be replaced by a valid attendee ID. The tag,
AI_EVENTID, may be used within data elements and serves as a placeholder to be replaced by a valid
event ID.
Sample Request URL: http://.../?do=cnt.getservice&service=getRegistrationTypes
'''
url = "%s/?do=cnt.getservice&service=getRegistrationTypes" % (
self.api.base)
result = self.get_result(url)
return parse_items(result, 'registrationType')
def getScheduledRoles(self, eventType=None):
'''getScheduledRoles
Returns an XML payload containing roles used by Events or Abstracts. Role data will contain the role
name, type, and public label.
Sample Request URL: http://.../?do=cnt.getservice&service=getScheduledRoles
:param eventType: Integer valid values: 1= Event, 2=Abstract
If not provided the system defaults to sending Event roles.
'''
url = "%s/?do=cnt.getservice&service=getScheduledRoles" % (
self.api.base)
args = {"type": eventType}
result = self.get_result(url, args)
return parse_items(result, 'role')
def getPublicFields(self,eventType=None):
'''getPublicFields
Returns an XML payload containing public fields for one of the following: Event, Exhibitor, Abstract,
Speaker. Field data will contain the field ID and public label.
Sample Request URL: http://.../?do=cnt.getservice&service=getPublicFields
Parameter Options:
:param eventType: Integer valid values: 1= Event, 2=Exhibitor, 3=Abstract & 4=Speaker
If not provided the system defaults to sending Event fields.
'''
url = "%s/?do=cnt.getservice&service=getPublicFields" %(self.api.base)
args = {"type":eventType}
result = self.get_result(url,args)
return parse_items(result,'field')
def getPublicFields(self, eventType=None):
'''getPublicFields
Returns an XML payload containing public fields for one of the following: Event, Exhibitor, Abstract,
Speaker. Field data will contain the field ID and public label.
Sample Request URL: http://.../?do=cnt.getservice&service=getPublicFields
Parameter Options:
:param eventType: Integer valid values: 1= Event, 2=Exhibitor, 3=Abstract & 4=Speaker
If not provided the system defaults to sending Event fields.
'''
url = "%s/?do=cnt.getservice&service=getPublicFields" % (self.api.base)
args = {"type": eventType}
result = self.get_result(url, args)
return parse_items(result, 'field')
def getEventTypes(self, eventType=None):
'''getEventTypes
Returns an XML payload containing a listing of event types. Event type data contains the type name
and roles that may be assigned to an event of this type.
Sample Request URL: http://.../?do=cnt.getservice&service=getEventTypes
Parameter Options:
:param eventType: Integer valid values: 1= Event, 2=Abstract
If not provided the system defaults to sending Event roles.
'''
url = "%s/?do=cnt.getservice&service=getEventTypes" % (self.api.base)
args = {"type": eventType}
result = self.get_result(url, args)
return parse_items(result, 'eventType')
def getEventTypes(self,eventType=None):
'''getEventTypes
Returns an XML payload containing a listing of event types. Event type data contains the type name
and roles that may be assigned to an event of this type.
Sample Request URL: http://.../?do=cnt.getservice&service=getEventTypes
Parameter Options:
:param eventType: Integer valid values: 1= Event, 2=Abstract
If not provided the system defaults to sending Event roles.
'''
url = "%s/?do=cnt.getservice&service=getEventTypes" %(self.api.base)
args = {"type":eventType}
result = self.get_result(url,args)
return parse_items(result,'eventType')
def getEventsCreditsSummary(self,
statusFlag=None,
publicUseFlag=None,
approvedFlag=None,
categoryID=None,
plannerID=None,
startsOnDate=None):
'''getEventsCreditsSummary
Returns an XML payload containing a full listing of event or session credit data. Event or session data
consists primarily of the name, date, time description and location of events. Credit data primarily
consists of the total credits claimed and people who have claimed those credits. Note: The tag,
AI_ATTENDEEID, may be used within data elements and serves as a placeholder to be replaced by a
valid attendee ID.
This method is only available in its entirety between 7PM and 7AM. Between 7AM and 7PM the
method will at most 5 event entries.
Sample Request URL: http://.../?do=cnt.getservice&service=getEventsCreditsSummary
Parameter Options:
:param statusFlag: Valid values: 1-Active; 0-Inactive; -1-All; Used to indicate if the event is active or
inactive. Generally inactive events are events that have been cancelled or removed by the client.
:param publicUseFlag: Valid values: 1=Public; 0=Private; -1=All; Used to determine the types of events to
include. Public events are viewable to the general population. Private events are events clients are
withholding from the general viewing public
:param approvedFlag: Valid values: 1=Approved; 0=Not Approved; -1=Both; Used to determine the types of
events to include. Note that a site setting can be used to use approvedFlag=1 by default. However,
passing the parameter via the url will override the site setting parameter.
:param categoryID: Numeric value; Use the 'getCategories' REST call to pull a list of valid categories.
:param plannerID: Numeric value containing a valid planner.
:param startsOnDate: Date value containing a valid date. Use the 'getSearchOptions' call to obtain a valid list
of dates.
'''
url = "%s/?do=cnt.getservice&service=getEventsCreditsSummary" % (
self.api.base)
args = {
"statusFlag": statusFlag,
"publicUseFlag": publicUseFlag,
"approvedFlag": approvedFlag,
"categoryID": categoryID,
"plannerID": plannerID,
"startsOnDate": startsOnDate
}
result = self.get_result(url, args)
return parse_items(result, "event")
def getEventSearchResults(self,
searchText=None,
categoryID=None,
locationID=None,
speakerID=None,
startsOnDate=None,
startsOnTime=None,
statusFlag=None):
'''getEventSearchResults
Returns an XML payload containing an event listing. This data set returned is smaller than the
getEvents request and intend for listing results. Use the result in combination with the getEvent call to
pull addition information on a specific event.
Sample Request URL: http://.../?do=cnt.getservice&service=getEventSearchResults
Parameter Options:
:param searchText: Text string used to perform a general search of the events. This parameter is used to find
matches in the title, description, objectives or speaker names.
:param categoryID: Numeric value containing a valid category. Use the 'getSearchOptions' call to obtain a
valid list of categories
:param locationID: Numeric value containing a valid location. Use the 'getSearchOptions' call to obtain a
valid list of locations
:param speakerID: Numeric value containing a valid speaker. Use the 'getSearchOptions' call to obtain the
list of possible speakers.
:param startsOnDate: Date value containing a valid date. Use the 'getSearchOptions' call to obtain a valid list
of dates.
:param startsOnTime: Time value in 12 hour format. E.g. 6:30PM
:param statusFlag: Valid values: 1-Active; 0-Inactive; -1-All; Used to indicate if the event is active or
inactive. Generally inactive events are events that have been cancelled or removed by the client.
'''
url = "%s/?do=cnt.getservice&service=getEventSearchResults" % (
self.api.base)
args = {
"searchText": searchText,
"categoryID": categoryID,
"locationID": locationID,
"speakerID": speakerID,
"startsOnDate": startsOnDate,
"startsOnTime": startsOnTime,
"statusFlag": statusFlag
}
result = self.get_result(url, args)
return parse_items(result, "event")
def getAttendeesItineraryData(self,
attendeeID=None,
startInitial=None,
endInitial=None,
insertedInLastHoursSpan=None):
'''getAttendeesItineraryData
Returns an XML payload containing a full listing of all attendee itinerary data. For each attendee their
itinerary will be returned in the XML payload. This service is only allowed to be run between 11 PM
EST and 5 AM EST. Note: For clients using the Attendee Itinerary Update service, only itinerary
items with the attributes='ReadWrite' can be modified.
Sample Request URL: http://.../?do=cnt.getservice&service=getAttendeesItineraryData
Parameter Options:
:param attendeeID: Numeric value; Identifies the attendee record to update.
:param startInitial: 1 character used to indicate the starting initial of the last name range to include. E.g. A
:param endInitial: 1 character used to indicate the starting initial of the last name range to include. If the
'startInitial' is provided but no 'endInitial' is provided the system uses the 'startInitial' as the
'endInitial'. E.g. B
:param insertedInLastHoursSpan: Used to indicate the number of hour of newly inserted records to include.
The default is 24. This must be a valid integer between 1 and 26,280.
'''
url = "%s/?do=cnt.getservice&service=getAttendeesItineraryData" % (
self.api.base)
# Initials should probably always be uppercase
if startInitial != None:
startInitial = capitalize(startInitial)
if endInitial != None:
endInitial = capitalize(endInitial)
args = {
"attendeeID": attendeeID,
"startInitial": startInitial,
"endInitial": endInitial,
"insertedInLastHoursSpan": insertedInLastHoursSpan
}
result = self.get_result(url, args)
return parse_items(result, 'attendee')
def getAbstracts(self,categoryID=None,speakerID=None,abstractTypeID=None,acceptedFlag=None):
'''getAbstracts
Returns an XML payload containing a full listing of all abstract data. Abstract data consists primarily
of the title, abstract number, purpose, materials & methods, results & conclusions.
Sample Request URL: http://.../?do=cnt.getservice&service=getAbstracts
Parameter Options:
:param categoryID: Numeric value containing a valid category. Use the 'getSearchOptions' call to obtain a
valid list of categories
:param speakerID: Numeric value containing a valid speaker. Use the 'getSearchOptions' call to obtain the
list of possible speakers.
:param abstractTypeID: Numeric value containing a valid abstract type. Use the 'getSearchOptions' call to
obtain the list of possible abstract types.
:param acceptedFlag: Boolean value (0 or 1). Default is 1.
'''
url = "%s/?do=cnt.getservice&service=getAbstracts" %(self.api.base)
args = {"categoryID":categoryID,
"speakerID":speakerID,
"abstractTypeID":abstractTypeID,
"acceptedFlag":acceptedFlag}
result = self.get_result(url,args)
return parse_items(result,'abstract')
def getAttendeesFormResponses(self,
formID,
startInitial=None,
endInitial=None):
'''getAttendeesFormResponses
Returns an XML payload containing a full listing of attendee contact data and form responses for the
specified form. For each attendee a 'formResponses' node returned in the XML payload. This service
is only allowed to be run between 11 PM EST and 5 AM EST.
Sample Request URL: http://.../?do=cnt.getservice&service=getAttendeesFormResponse
Parameter Options:
:param *formID: Numeric value; Identifies the form for which to retrieve responses.
:param attendeeID: Numeric value; Identifies the attendee record to update.
:param startInitial: 1 character used to indicate the starting initial of the last name range to include. E.g. A
:param endInitial: 1 character used to indicate the starting initial of the last name range to include. If the
'startInitial' is provided but no 'endInitial' is provided the system uses the 'startInitial' as the
'endInitial'. E.g. B
'''
# Note to developer - this endpoint has not been tested, was reported wrong in docs
# https://github.com/vsoch/ohbm/issues/3
url = "%s/?do=cnt.getservice&service=getAttendeesItineraryData" % (
self.api.base)
# Initials should probably always be uppercase
if startInitial != None:
startInitial = capitalize(startInitial)
if endInitial != None:
endInitial = capitalize(endInitial)
args = {
"formID": formID,
"startInitial": startInitial,
"endInitial": endInitial
}
result = self.get_result(url, args)
return parse_items(result, 'attendee')
def getAttendeesRegData(self,
attendeeID=None,
startInitial=None,
endInitial=None,
formID=None):
'''getAttendeesRegData
Returns an XML payload containing a full listing of all attendee purchases. For each attendee their
purchase or order history will be returned in the XML payload. This service is only allowed to be run
between 11 PM EST and 5 AM EST .
Sample Request URL: http://.../?do=cnt.getservice&service=getAttendeesRegData
Parameter Options:
:param attendeeID: Numeric value, Identifies the attendee record to update.
:param startInitial: 1 character used to indicate the starting initial of the last name range to include. E.g. A
:param endInitial: 1 character used to indicate the starting initial of the last name range to include. If the
'startInitial' is provided but no 'endInitial' is provided the system uses the 'startInitial' as the
'endInitial'. E.g. B
:param formID: Numeric value of a demographic form
'''
url = "%s/?do=cnt.getservice&service=getAttendeesRegData" % (
self.api.base)
# Initials should probably always be uppercase
if startInitial != None:
startInitial = capitalize(startInitial)
if endInitial != None:
endInitial = capitalize(endInitial)
args = {
"attendeeID": attendeeID,
"startInitial": startInitial,
"endInitial": endInitial,
"formID": formID
}
result = self.get_result(url, args)
return parse_items(result, 'attendee')
def getSpeakers(self, isScheduledFor, includeActiveStatus, formIDs,
modifiedOnAfter, modifiedOnBefore):
'''getSpeakers
Returns an XML payload containing a full listing of all speaker data. Speakers are defined as attendees
whom are participating in the meeting in a specific capacity. E.g. Presenting in a session or
Moderating a session or Presenting a Poster. This service also returns the schedule for each speaker.
This includes all itinerary items that are 'active' (can be changed via includeActiveStatus parameter),
and 'public'.
Sample Request URL: http://.../?do=cnt.getservice&service=getSpeakers
Parameter Options:
:param isScheduledFor: Numeric value of (1,2 or 3) - This filters the speakers returned by schedule type:
Valid values; 1 = For Event, 2 = For Abstract, 3 = For Event OR Abstract. Note that this parameter
only affects whether or not a speaker record is included in the results set. It does not change the
itinerary items that are returned in each speaker's schedule block. For example, if isScheduledFor=2,
Any speaker who is linked to at least 1 Abstract will be shown. Any 'active', and 'public' itinerary
items that are linked to an Event will still be shown in the schedule for this speaker.
:param includeActiveStatus: Numeric value of (0,1, or 99) - Determines if active, inactive, or ALL itinerary
items are shown in the <schedule> block.
:param formIDs: Comma delimited list of form ids
:param modifiedOnAfter: Valid date string. Using this filter will return speakers who have updated contact
information, schedule, or form responses after/on this date.
:param modifiedOnBefore: Valid date string. Using this filter will return speakers who have updated contact
information, schedule, or form responses before/on this date.
'''
url = "%s/?do=cnt.getservice&service=getSpeakers" % (self.api.base)
args = {
"isScheduledFor": isScheduledFor,
"includeActiveStatus": includeActiveStatus,
"formIDs": formIDs,
"modifiedOnAfter": modifiedOnAfter,
"modifiedOnBefore": modifiedOnBefore
}
result = self.get_result(url, args)
return parse_items(result, 'speaker')
