Event Dates OpCode EDL: List Dates for an Event

Event Dates OpCode EDL: List Dates for an Event

This opcode is used to list the defined dates for an existing event in the specified show. The Event to list dates may be identified by specifying the EventKey, EventCode, or EventDescription.

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 EDL to invoke this function.

OutputFormat

Char 1

N

T for text, H for HTTP URL-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 list dates for.

EventCode

Varchar 255

N

The event code to list dates for.

EventDescription

Varchar 355

N

The description of the event to list dates for.

Return Outputs

 

This API returns a result set of date information upon successful completion. The result set is structured as follows:

Column

Type/Size

EventDatesKey

Integer

FromDateTime

Datetime YYYY-MM-DD HH:MI:SS format

ToDateTime

Datetime YYYY-MM-DD HH:MI:SS format

DateType

Integer
Where
1 = EarlyBird Registration,

2 = Open Registration

3 = Preview Dates

4 = Show Dates

5 = After Show Access Dates

6 = Data Portal Access Dates

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.