Job Posting Opcode JPA: Retrieve Applicant Information for Job Posting

Job Posting Opcode JPA: Retrieve Applicant Information for Job Posting

This opcode is used to retrieve applicant information for one or more job postings. Exhibitor, Booth, Category, and Specific Job Posting filters may be specified to limit the results.

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 JPA 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 Postings.

ExhibitorKey

Integer

N

ExhibitorKey filter for Job Postings.

ExhibitorName

Varchar 80

N

Exhibitor Name filter for Job Postings.

ExhibitorExternalID

Varchar 255

N

Exhibitor ExternalID filter for Job Postings.

BoothKey

Integer

N

BoothKey filter for Job Postings.

BoothName

Varchar 128

N

Booth Name filter for Job Postings.

BoothExternalID

Varchar 255

N

Booth ExternalID filter for Job Postings.

JobCategoryKey

Integer

N

JobCategoryKey filter for the Job Postings.

JobCategoryDescription

Varchar 80

N

Job Category Description filter for the Job Postings.

JobCategoryExternalID

Varchar 255

N

Job Category ExternalID filter for the Job Postings.

JobPostingKey

Integer

N

The key value of the Job Posting to retrieve applicants.

JobTitle

Varchar 100

N

The title of the Job Posting to retrieve applicants for.

JobCode

Varchar 255

N

The Job Code of the Job Posting to retrieve applicants.

Return Outputs

 

This API returns a result set of grouping information upon successful completion. The result set is structured as follows:

Column

Type/Size

JobTitle

Varchar 255

JobPostingKey

Integer

JobCode

varchar 255

JobCategoryDescription

Varchar 80

JobCategoryKey

Integer

JobCategoryExternalID

Varchar 255

ExhibitorName

Varchar 80

ExhibitorKey

Integer

ExhibitorExternalID

Varchar 255

ApplicantName

Varchar 80

ApplicantEmail

Varchar 255

AppliedDateTime

Datetime YYYY-MM-DD HH:MI:SS format

SubmissionComments

Varchar 1000

ReviewerComments

Varchar 2GB

ReviewerRating

Integer

AcceptanceStatus

Integer

AcceptanceComments

Varchar 500

LastUpdatedBy

Varchar 80

LastReviewedBy

Varchar 80

LastUpdatedDateTime

Datetime YYYY-MM-DD HH:MI:SS format

LastViewedDateTime

Datetime YYYY-MM-DD HH:MI:SS format

 

Potential Error Codes

There are no potential error codes for this API call.