service=updateItinerary
Returns an XML payload containing the results of the attendee itinerary data update. The ‘stat’ attribute is used to indicate the success or failure of the request. Extended description of all options are listed below.
Sample Request URL: [EndPoint Url]./?do=cnt.getservice&service=updateItinerary&[Parameter List]
Parameter Options:
*apiKey: Valid API key
*attendeeID: Identifies the attendee record to update. Always required.
itineraryID: Identifies the itinerary record to update; Required when updating a record.
action: used to define update or deletion. Valid options: update, delete; The update option is assumed if the action parameter is not provided.
abstractID: Identifies the abstract record being added, updated or removed
eventID: Identifies the event record being added, updated or removed
exhibitorID: Identifies the exhibitor record being added, updated or removed title. Title of the activity. Limit 300 characters. Required if record is not linked to an event, abstract or exhibitor. If linked to an event, abstract or exhibitor, title is ignored.
description: Description of the event. Limit 500 characters.
startsOn: Date & Time of activity. Format: mm/dd/yyyy hh:mm tt, e.g. 05/01/2011 12:00 PM. Date / Time will be ignored if not a valid format or if passed with an event or abstract which already have a time associated.
endsOn: Date & Time of activity. Format: mm/dd/yyyy hh:mm tt, e.g. 05/01/2011 12:00 PM. Date / Time will be ignored if not a valid format or if passed with an event or abstract which already have a time associated.
title: Title of the event. Limit 300 characters. Title required for personal Activities
currentUser: This can be added to the save but is not required, just updates who saved the data. Not sure if this is needed in the help doc, if it is not provided it defaults to Unknown.
*Indicates required parameters
The results of this call are either success for failure. Both XML payloads are described next.
Sample Success XML Payload:
<?xml version='1.0' encoding='UTF-8'?>
<rst stat='ok' version='1.0'>
<result stat='ok' id='123456' />
</rst>
</xml>
The ‘id’ attribute will contain the updated itinerary record identifier. This value can be ignored on updates but must be stored when adding items in order to perform updates or deletions at a later date.
Sample Failure XML Payload:
<?xml version='1.0' encoding='UTF-8'?>
<rst stat='ok' version='1.0'>
<result stat='fail' msg='see reason nodes'>
<reason>Scheduled items cannot be altered.</reason>
</result>
</rst>
</xml>
Sample Abstract Parameter Lists:
Add: attendeeID=1093&abstractID=10000&startsOn=06/24/2011 12:00 PM&endsOn=06/24/2011 01:00 PM
Add: attendeeID=10930&abstractID=10000
Update: attendeeID=10930&itineraryID=11937&abstractID=10000&startsOn=06/24/2011 12:00 PM&endsOn=06/24/2011 01:00 PM
Delete: attendeeID=10930&itineraryID=11937&abstractID=10000&action=delete
Sample Event Request:
Add: attendeeID=10930&eventID=10000
Delete: attendeeID=10930&itineraryID=11937&eventID=10000&action=delete
Sample Exhibitor Request:
Add: attendeeID=10930&exhibitorID=10000&startsOn=06/24/2011 12:00PM&endsOn=06/24/2011 01:00 PM
Update: attendeeID=10930&itineraryID=11937&exhibitorID=10000&startsOn=06/24/2011 12:00 PM&endsOn=06/24/2011 01:00 PM
Delete: attendeeID=10930&itineraryID=11937&exhibitorID=10000&action=delete
Sample Personal Activity Request:
Add: attendeeID=10930&title=My Personal Activity&startsOn=06/24/2011 12:00 PM&endsOn=06/24/2011 01:00 PM&description=This is a description
Update: attendeeID=10930&itineraryID=11937&title=My Personal Activity&startsOn=06/24/2011 12:00 PM&endsOn=06/24/2011 01:00 PM&description=This is a description
Delete: attendeeID=10930&itineraryID=11937&action=delete