GET Api/ApplicantCompass/JobInsight/{id}?culture={culture}

Retrieve a job insight by ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

ID

integer

Required

culture

Culture

string

None.

Body Parameters

None.

Response Information

Resource Description

JobInsightResponse
NameDescriptionTypeAdditional information
Id

Job Insight Id

integer

None.

Name

Internal name of the job insight.

string

None.

HasHeader

Flag if the header is shown.

boolean

None.

Header

Job Insight Header

JobInsightHeader

None.

HasTasks

Flag if the tasks are shown.

boolean

None.

TaskIntroduction

Introduction for task section.

string

None.

Tasks

Job Insight Tasks

Collection of JobInsightTask

None.

HasBenefits

Flag if the benefits are shown.

boolean

None.

Benefits

Job Insight Benefits

Collection of JobInsightBenefit

None.

HasTestimonial

Flag if the testimonial is shown.

boolean

None.

TestimonialIntroduction

Introduction for testimonial section.

string

None.

Testimonials

Job Insight Testimonials

Collection of JobInsightTestimonial

None.

HasVideo

Flag if the video is shown.

boolean

None.

VideoIntroduction

Introduction for video section.

string

None.

VideoUrl

URL of the video for the video section.

string

None.

HasProcess

Flag if the process section is shown.

boolean

None.

HasJobs

Flag if the jobs section is shown.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "HasHeader": true,
  "Header": {
    "Title": "sample string 1",
    "Text": "sample string 2",
    "HeaderImageUrl": "sample string 3",
    "HeaderVideoUrl": "sample string 4"
  },
  "HasTasks": true,
  "TaskIntroduction": "sample string 5",
  "Tasks": [
    {
      "Title": "sample string 1",
      "Text": "sample string 2",
      "Image": "QEA="
    },
    {
      "Title": "sample string 1",
      "Text": "sample string 2",
      "Image": "QEA="
    }
  ],
  "HasBenefits": true,
  "Benefits": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Icon": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Icon": "sample string 3"
    }
  ],
  "HasTestimonial": true,
  "TestimonialIntroduction": "sample string 8",
  "Testimonials": [
    {
      "Name": "sample string 1",
      "Position": "sample string 2",
      "Statement": "sample string 3",
      "Text": "sample string 4",
      "Image": "QEA="
    },
    {
      "Name": "sample string 1",
      "Position": "sample string 2",
      "Statement": "sample string 3",
      "Text": "sample string 4",
      "Image": "QEA="
    }
  ],
  "HasVideo": true,
  "VideoIntroduction": "sample string 10",
  "VideoUrl": "sample string 11",
  "HasProcess": true,
  "HasJobs": true
}

application/xml, text/xml

Sample:
<JobInsightResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <Benefits>
    <JobInsightBenefit>
      <Description>sample string 2</Description>
      <Icon>sample string 3</Icon>
      <Name>sample string 1</Name>
    </JobInsightBenefit>
    <JobInsightBenefit>
      <Description>sample string 2</Description>
      <Icon>sample string 3</Icon>
      <Name>sample string 1</Name>
    </JobInsightBenefit>
  </Benefits>
  <HasBenefits>true</HasBenefits>
  <HasHeader>true</HasHeader>
  <HasJobs>true</HasJobs>
  <HasProcess>true</HasProcess>
  <HasTasks>true</HasTasks>
  <HasTestimonial>true</HasTestimonial>
  <HasVideo>true</HasVideo>
  <Header>
    <HeaderImageUrl>sample string 3</HeaderImageUrl>
    <HeaderVideoUrl>sample string 4</HeaderVideoUrl>
    <Text>sample string 2</Text>
    <Title>sample string 1</Title>
  </Header>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <TaskIntroduction>sample string 5</TaskIntroduction>
  <Tasks>
    <JobInsightTask>
      <Image>QEA=</Image>
      <Text>sample string 2</Text>
      <Title>sample string 1</Title>
    </JobInsightTask>
    <JobInsightTask>
      <Image>QEA=</Image>
      <Text>sample string 2</Text>
      <Title>sample string 1</Title>
    </JobInsightTask>
  </Tasks>
  <TestimonialIntroduction>sample string 8</TestimonialIntroduction>
  <Testimonials>
    <JobInsightTestimonial>
      <Image>QEA=</Image>
      <Name>sample string 1</Name>
      <Position>sample string 2</Position>
      <Statement>sample string 3</Statement>
      <Text>sample string 4</Text>
    </JobInsightTestimonial>
    <JobInsightTestimonial>
      <Image>QEA=</Image>
      <Name>sample string 1</Name>
      <Position>sample string 2</Position>
      <Statement>sample string 3</Statement>
      <Text>sample string 4</Text>
    </JobInsightTestimonial>
  </Testimonials>
  <VideoIntroduction>sample string 10</VideoIntroduction>
  <VideoUrl>sample string 11</VideoUrl>
</JobInsightResponse>