Event Dates OpCode EDU: Updates Dates for an Event

Event Dates OpCode EDU: Updates Dates for an Event

This opcode is used to update an existing date range for an existing event in the specified show. The Event to update dates for may be identified by specifying the EventKey, EventCode, or EventDescription. Note that dates are to be specified in the following 24-hour format: YYYY-MM-DD HH:MI:SS

Example: 2009-12-31 14:30:00

When a date range is assigned with this opcode for a standalone XPOCAST, this API will also assign the following Show-level date ranges: Registration, Live, After-show access, and Data Portal access; as well as the following Event-level date range: OnDemand.

Calling the API

The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation (except for file uploading which requires a multi-part form post). Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.

The format of the API call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50540&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&ShowKey={ShowKey}&{Additional, opcode-specific parameters in name=value format…}

Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50540. All other parameters may appear in any sequence order.

API Parameter

Type/Size

Req.

Comment

APIUserAuthCode

Varchar 80

Y

Your API authorization code as supplied by Notified.

APIUserCredentials

Varchar 80

Y

Your API user credentials as supplied by Notified.

OpCodeList

Varchar 20

Y

Should include EDU to invoke this function.

OutputFormat

Char 1

N

T for text, H for HTTP UR:-encoded, or X for XML. Defaults to T.

ShowKey

Integer

Y

The ShowKey that the Event belongs to.

EventKey

Integer

N

The event key to update dates to.

EventCode

Varchar 255

N

The event code to update dates to.

EventDescription

Varchar 355

N

The description of the event to update dates to.

EventDatesKey

Integer

Y

The Event Dates Key to update the date range for.

EventDatesFromDateTime

Datetime

N

Beginning date/time of the range. Must be in YYYY-MM-DD HH:MI:SS format.

EventDatesToDateTime

Datetime

N

Ending date/time of the range. Must be in YYYY-MM-DD HH:MI:SS format.

 

Return Outputs

 

This API returns the status message OK upon successful completion.

Text


### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0

## OpCode=EDU Status=0 Message=OK

 

HTTP URL-encoded


APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=EDU&Status=0&Message=OK

 

XML


<?xml version="1.0" encoding="utf-8" ?>

<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >

<OpCodeResult OpCode="EDU" Status="0" Message="OK" />

</APIResults>

 

 

Potential Error Codes

 

Error

Message

Reason

51

Event Not Found!

The function could not find a matching event entry based on the values supplied in EventKey, EventCode, and EventDescription.

52

Event Date Not Found!

The entry specified by EventDatesKey is invalid.

53

Event Date Entry Already Exists!

A date range already exists and may not be duplicated. Date ranges may overlap, but may not be identical.