Job Category Opcode JCL: List Job Categories

This opcode is used to retrieve the list of Job Categories defined for the specified show.

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!50560&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&ShowKey={ShowKey}&{Additional, opcode-specific parameters in name=value format…}

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.

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 2000	Y	Should include JCL 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 to list Job Categories for.

Return Outputs

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

Column	Type/Size
Description	Varchar 80
JobCategoryKey	Integer
ExternalID	Varchar 255

Potential Error Codes

There are no potential error codes for this API call.