POST Api/ApplicantCompass/InterestProfiles/ForInterests

Retrieve the 3 best matching interest profiles for an applicant interest profile.

Request Information

URI Parameters

None.

Body Parameters

Interests

ApplicantInterestParameter
NameDescriptionTypeAdditional information
Filters

Answers for filter questions.

Collection of ApplicantInterestFilterAnswer

None.

Questions

Answers for relevance questions.

Collection of ApplicantInterestQuestionAnswer

None.

Request Formats

application/json, text/json

Sample:
{
  "Filters": [
    {
      "FilterId": 1,
      "AnswerId": 2
    },
    {
      "FilterId": 1,
      "AnswerId": 2
    }
  ],
  "Questions": [
    {
      "QuestionId": 1,
      "Answer": 2.1
    },
    {
      "QuestionId": 1,
      "Answer": 2.1
    }
  ]
}

application/xml, text/xml

Sample:
<ApplicantInterestParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <Filters>
    <ApplicantInterestFilterAnswer>
      <AnswerId>2</AnswerId>
      <FilterId>1</FilterId>
    </ApplicantInterestFilterAnswer>
    <ApplicantInterestFilterAnswer>
      <AnswerId>2</AnswerId>
      <FilterId>1</FilterId>
    </ApplicantInterestFilterAnswer>
  </Filters>
  <Questions>
    <ApplicantInterestQuestionAnswer>
      <Answer>2.1</Answer>
      <QuestionId>1</QuestionId>
    </ApplicantInterestQuestionAnswer>
    <ApplicantInterestQuestionAnswer>
      <Answer>2.1</Answer>
      <QuestionId>1</QuestionId>
    </ApplicantInterestQuestionAnswer>
  </Questions>
</ApplicantInterestParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Interest Profiles

Collection of InterestProfileResponse
NameDescriptionTypeAdditional information
Id

ID of the interest profile.

integer

None.

SpeculativeJobId

ID of the speculative job.

integer

None.

JobInsightId

ID of the job insight.

integer

None.

JobIds

IDs of published jobs associated with the interest profile.

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "SpeculativeJobId": 2,
    "JobInsightId": 3,
    "JobIds": [
      1,
      2
    ]
  },
  {
    "Id": 1,
    "SpeculativeJobId": 2,
    "JobInsightId": 3,
    "JobIds": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfInterestProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <InterestProfileResponse>
    <Id>1</Id>
    <JobIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </JobIds>
    <JobInsightId>3</JobInsightId>
    <SpeculativeJobId>2</SpeculativeJobId>
  </InterestProfileResponse>
  <InterestProfileResponse>
    <Id>1</Id>
    <JobIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </JobIds>
    <JobInsightId>3</JobInsightId>
    <SpeculativeJobId>2</SpeculativeJobId>
  </InterestProfileResponse>
</ArrayOfInterestProfileResponse>