Job Category Opcode JCU: Update a New Job Category

Job Category Opcode JCU: Update a Job Category

This opcode is used to update a Job Category entry in the specified show. The Category item to update may be identified using either the JobCategoryKey, the Description, or the ExternalID. When using the Description, either omit the JobCategoryKey parameter or pass a value of 0. If optional parameters are omitted or passed empty values, the field values will not be updated.

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 JCU 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 that the Job Category exists in.
JobCategoryKey	Integer	N	JobCategoryKey that identifies the entry to update.
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

This API returns the status message OK and the JobCategoryKey upon successful completion.

Text

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

## OpCode=JCU Status=0 Message=OK

JobCategoryKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=JCU&Status=0&Message=OK&JobCategoryKey=123456

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
11	Job Category Not Found!	The Job Category could not be identified using the supplied values for JobCategoryKey, Description, or ExternalID.