Job Posting Opcode JPI: Delete a Job Posting
Job Posting Opcode JPI: Delete a Job Posting
This opcode is used to delete a Job Posting entry in the specified show. The Job Posting to delete may be identified by JobPostingKey or JobCode or JobTitle.
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 JPD 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 of the Job Posting. |
ExhibitorKey |
Integer |
N |
ExhibitorKey for this Job Posting. If this is not supplied, then ExhibitorName or ExhibitorExternalID must be specified if JobPostingKey is not used. |
ExhibitorName |
Varchar 80 |
N |
Exhibitor Name for the Job Posting. |
ExhibitorExternalID |
Varchar 255 |
N |
Exhibitor ExternalID for the Job Posting. |
BoothKey |
Integer |
N |
BoothKey of the Job Posting. |
BoothName |
Varchar 128 |
N |
Booth Name of the Job Posting. |
BoothExternalID |
Varchar 255 |
N |
Booth ExternalID of the Job Posting. |
JobPostingKey |
Integer |
N |
The key value of the Job Posting to delete. If not supplied, JobCode or JobTitle and Exhibitor info must be supplied. |
JobTitle |
Varchar 100 |
N |
The title of this Job Posting. |
JobCode |
Varchar 255 |
N |
The Job Code, if any. |
Return Outputs
This API returns the status message OK and the JobPostingKey upon successful completion.
Text
### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0
## OpCode=JPD Status=0 Message=OK
JobPostingKey
123456
HTTP URL-encoded
APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=JPD&Status=0&Message=OK&JobPostingKey=123456
XML
<?xml version="1.0" encoding="utf-8" ?>
<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >
<OpCodeResult OpCode="JPD" Status="0" Message="OK" >
<ResultRow>
<JobPostingKey>123456</JobPostingKey>
</ResultRow>
</OpCodeResult>
</APIResults>
Potential Error Codes
Error |
Message |
Reason |
---|---|---|
31 |
Job Posting Not Found! |
Either the JobPostingKey was invalid or not supplied. If not supplied, the Job Posting could not be found based on Exhibitor information and JobCode or JobTitle. |