Job Category Opcode JCC: Create or Update a Job Category
Job Category Opcode JCC: Create or Update a Job Category
This opcode is used to update a Job Category entry in the specified show, if it exists, or create a new one if it does not. The Category item is identified using either the Description or the ExternalID. If the Category is found using the description or external ID, the Update A Job Category API is called (OpCode JCU). Otherwise, the Add A Job Category API is called (OpCode JCI).
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 20 |
Y |
Should include JCC 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 insert the Job Category into. |
JobCategoryDescription |
Varchar 80 |
N |
The description of this Job Category. |
JobCategoryExternalID |
Varchar 255 |
N |
External ID or code to cross-reference this Job Category entry. |
Return Outputs
See the descriptions of OpCodes JCI and JCU for more information on the return completion results.
Potential Error Codes
See the descriptions of OpCodes JCI and JCU for more information on the potential error codes.