Job Category Opcode JPI: Add a New Job Posting

This opcode is used to insert a new Job Posting entry into the specified show. The Job Title must be unique within the specified exhibitor/booth combination and not already exist. The Show User associated with the Confirmation From Show User must already exist in the system and may be identified by either specifying the ConfirmationFromShowUserKey, ConfirmationFromShowUserEMailAddress or by ConfirmationFromShowUserExternalID. If Confirmation From Show User is omitted, the system will attempt to use the Exhibitor Contact or Booth Administrator. If this Job Posting is to be associated with a booth, that booth may be identified by passing the BoothKey, BoothName, or BoothExternalID.

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 JPI 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 an 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

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

Text

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

## OpCode=JPI Status=0 Message=OK

JobPostingKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=JPI&Status=0&Message=OK&JobPostingKey=123456

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
21	Job Title may not be blank!	Either the Job Title was omitted or blank.
22	Job Description may not be blank!	Either the Job Description was omitted or blank.
23	Invalid Job Category value specified!	Either the JobCategoryKey was invalid, or the Job Category could not be found based on the values supplied for JobCategoryDescription and JobCategoryExternalID.
24	Invalid Exhibitor value specified!	Either the ExhibitorKey was invalid, or the Exhibitor could not be found based on the values supplied for ExhibitorName and ExhibitorExternalID.
25	Invalid Confirmation From User Key value specified!	Either the ConfirmationFromShowUserKey was invalid, or the Confirmation From Show User could not be found based on the values supplied for ConfirmationFromShowUserEMailAddress and ConfirmationFromShowUserExternalID.
26	Invalid Booth Key value specified!	The BoothKey parameter was invalid.
27	Invalid Confirmation Type value specified!	The ConfirmationType value was not 0,1 or 2.
28	Invalid Confirmation Option value specified!	The ConfirmationOption value was not 0,1 or 2.
29	Invalid Requires Citizenship value specified!	The RequiresCitizenship value was not 1, 2, or 3.
30	Invalid Job Type value specified!	The JobType value was not 1, 2, or 3.