External Jobs API

Notified provides a portal to virtual event integration features that enable partners and show hosts to programmatically interact with the Job Fair features of the Virtual Trade Show (VTS)platform on-demand from their controlled sites and systems.

The Notified Virtual Trade Show External API also provides third-party partners the ability to programmatically automate the creation and synchronization of shared entities and attributes between their systems and the VTS database. This automation is controlled and orchestrated by the caller. The VTS platform does not currently push calls to third-party systems.

Calling the API

The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. 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 call is:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50566
&APIUserAuthCode={YourAuthCode}
&APIUserCredentials={YourCredentials}
&ShowKey={ShowKey}
&FromDateTime={FromDate in YYYY-MM-DD HH:MM:SS format}
&ToDateTime={ToDate in YYYY-MM-DD HH:MM:SS format}
&ActivityTypeFilter={filter code list, in |OPTION|OPTION| format…}
&FilterUserType={0|1|-1 where 0 = attendees, 1 = exhibitors, -1 = both}

Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.

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

OpCodes

API operations to be performed are specified in the OpCode parameter. More than one opcode may be specified, allowing the caller to perform multiple steps in each call. Opcodes are evaluated in order from left to right. Each opcode may require a different set of parameters to be supplied. Parameter values may be shared among multiple opcodes. Following is a list of valid opcodes supported by the API:

OpCode	Description
Job Categories
JCL	Lists the defined Job Categories.
JCI	Add a new Job Category.
JCU	Update a Job Category.
JCD	Delete a Job Category.
JCC	Add or update a Job Category.
Job Postings
JPL	Lists the defined Job Postings.
JPI	Add a new Job Posting.
JPU	Update a Job Posting.
JPD	Delete a Job Posting.
JPC	Add or update a Job Posting.
JPA	Retrieve the list of Applicants for specified Job Posting(s).
JPV	Retrieve the list of Viewers for specified Job Posting(s).

The specific parameters accepted and return output for each opcode are documented individually, including potential errors that may occur specific to each opcode.

Example API Call

The following example call retrieves the list of job postings currently defined for the show with the ShowKey of 99347:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50560&APIUserAuthCode=JX11452B&APIUserCredentials=DEMO01&OpCodeList=JPL&OutputFormat=X&ShowKey=99347
Before the API begins processing opcodes, certain credential and parameter validations are made. If any of these top-level validations fail, none of the opcodes will be processed. Below is a listing of potential top-level validation errors:

Potential Error Codes

OpCode	Description	Reason
50000	Invalid API Credentials Supplied!	The credentials supplied do not match any authorized API accounts.
50000	API Access Has Been Deactivated!	The specified API account is marked inactive.
50000	Invalid Show Key Specified!	The ShowKey parameter does not match any valid shows for this account.
50000	Invalid Or Missing OpCode(s) Specified!	Either the OpCode parameter is empty or missing.
-10	Invalid OpCode Specified!	The specified OpCode is invalid.

Retrieving Results From The API

The API can return results in several formats, allowing the developer to choose what is most easily consumed. The formats are text-based, HTTP URL-encoded, and XML. Results contain a header, indicating the overall success of the call, including textual diagnostic, the number of opcodes successfully processed, and the number of opcodes that resulted in an error. Each opcode then outputs a recap section of its execution, indicating the opcode, processing result, and textual diagnostic. Error codes of 0 indicate success (no error).

In addition to the opcode recap, data elements are output for certain opcodes indicating the return values of the operation. The format of the results depends on the result format requested. For URL-encoded, these are listed as a string of HTTP parameter names and values. They are listed as a header line for text, followed by a values line, each field separated by commas. For XML, they are listed as child nodes of the opcode response. Example output is included for each opcode in the respective opcode’s documentation.