Job Posting Opcode JPC: Create or Update a Job Posting
Job Posting Opcode JPC: Create or Update a Job Posting
This opcode is used to update a Job Posting entry in the specified show, if it exists, or create a new one if it does not. The Job Posting item is identified using either the Job Title or the ExternalID, in combination with the Exhibitor values. If the Job Posting is found using the title or external ID, the Update A Job Posting API is called (OpCode JPU). Otherwise, the Add A Job Posting API is called (OpCode JPI).
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 JPC 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 Posting into. |
ExhibitorKey |
Integer |
N |
ExhibitorKey to create the Job Posting for. If this is not supplied, then ExhibitorName or ExhibitorExternalID must be specified. |
ExhibitorName |
Varchar 80 |
N |
Exhibitor Name to create the Job Posting for. |
ExhibitorExternalID |
Varchar 255 |
N |
Exhibitor ExternalID to create the Job Posting for. |
BoothKey |
Integer |
N |
BoothKey to create the Job Posting for. |
BoothName |
Varchar 128 |
N |
Booth Name to create the Job Posting for. |
BoothExternalID |
Varchar 255 |
N |
Booth ExternalID to create the Job Posting for. |
JobCategoryKey |
Integer |
N |
JobCategoryKey to create the Job Posting under. If this is not supplied, then JobCategoryDescription or JobCategoryExternalID must be specified. |
JobCategoryDescription |
Varchar 80 |
N |
Job Category Description to create the Job Posting under. |
JobCategoryExternalID |
Varchar 255 |
N |
Job Category ExternalID to create the Job Posting under. |
JobTitle |
Varchar 100 |
Y |
The title of this Job Posting. |
JobCode |
Varchar 255 |
N |
The Job Code, if any. |
Active |
Bit (0/1) |
Y |
Flag indicating whether this Job Posting is active. |
JobDescription |
Varchar 2GB |
Y |
Description of this Job. |
IsTravelRequired |
Varchar 40 |
Y |
Description of travel requirements. |
CanTelecommute |
Bit (0/1) |
N |
Flag indicating whether hires can telecommute. |
AllowJobRating |
Bit (0/1) |
N |
Flag indicating whether viewers can rate this job posting. |
WillSponsorH1B |
Bit (0/1) |
N |
Flag indicating whether the employer will sponsor H1B applicants. |
HideJobContact |
Bit (0/1) |
N |
Flag indicating whether the Job Contact person will be hidden from the job posting. |
RequiresCitizenship |
Integer (1, 2, 3) |
N |
Specify 1 for citizen (default), 2 for a permanent resident, or 3 for not required. |
Salary |
Varchar 30 |
N |
Salary description. |
JobType |
Integer (1, 2, 3) |
N |
Specify 1 for full-time (default), 2 for part-time, or 3 for contract. |
JobLevel |
Varchar 30 |
N |
Job Level description. |
Experience |
Varchar 30 |
N |
Description of experience requirements. |
Education |
Varchar 30 |
N |
Description of education requirements. |
JobLocation |
Varchar 80 |
N |
Location of job. |
ConfirmationFromShowUserKey |
Integer |
N |
The Show User Key identifies the user in the system that is the Job Contact. |
ConfirmationFromShowUserEMailAddress |
Varchar 255 |
N |
The email address that identifies the user in the system is the Job Contact. |
ConfirmationFromShowUserExternalID |
Varchar 255 |
N |
External ID that identifies the user in the system that is the Job Contact. |
ConfirmationType |
Integer (0, 1, 2) |
N |
Specify 0 for no confirmation (default), 1 for send vCard, or 2 for send in-show email. |
ConfirmationOption |
Integer (0, 1) |
N |
Specify 0 for none (default) or 1 for send applicant confirmation contact’s vCard. |
CustomApplicantMessagePage |
Varchar 2GB |
N |
Message text to be sent to applicants as part of the confirmation. |
HideApplyButton |
Bit (0/1) |
N |
Flag indicating whether to hide the Apply button for this job. |
Return Outputs
See the descriptions of OpCodes JPI and JPU for more information on the return completion results.
Potential Error Codes
See the descriptions of OpCodes JPI and JPU for more information on the potential error codes.