Job Category Opcode JCD: Delete a Job Category

This opcode is used to delete a Job Category entry in the specified show. The Category item to delete may be identified using either the JobCategoryKey, Description, or ExternalID. When using the Description, either omit the JobCategoryKey parameter or pass a value of 0. Job Categories may not be deleted if job postings exist for the specified category.

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 JCD 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 delete the Job Category from.
JobCategoryKey	Integer	N	JobCategoryKey that identifies the entry to delete.
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=JCD Status=0 Message=OK

JobCategoryKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=JCD&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.
15	Job Category Is In Use And Cannot Be Deleted!	Job Postings exists for this Job Category.