Application Service

api.careerbuilder.com

Service Info

http://api.careerbuilder.com/v1/application/blank?

Retrieves a representation of the information required to apply to a job. GET requests only.

This will essentially return a list of questions and possible answers. Most jobs will require nothing more than name, email and resume. However, since employers decide what information is required to apply, the number and nature of questions will vary from job to job. The sample output shows a worst-case scenario.

Instead of using CareerBuilder to manage their applications, some employers will specify a URL where candidates may apply to the job. In these cases, the list of questions will be empty. You should direct candidates to the URL specified in the ApplyURL element of the response.

Parameters

  • &DeveloperKey=
    • Required
  • &JobDID=
    • Required, string
    • Can accept a single value only.
    • The JobDID is a unique identifier received in every Job Search Result item.
  • &SiteID=
    • Optional, string
    • Some of our existing partners use this param for tracking purposes. If you don't already know what this is, don't worry about it.
  • &CoBrand=
    • Optional, string
    • Some of our existing partners use this param for tracking purposes. If you don't already know what this is, don't worry about it.

Sample Output

<?xml version="1.0" encoding="UTF-8" ?>
<ResponseBlankApplication>
  <Errors />
  <TimeResponseSent>9/26/2007 4:21:38 PM</TimeResponseSent>
  <TimeElapsed>0.0937494</TimeElapsed>
  <BlankApplication>
    <ApplicationSubmitServiceURL>http://api.careerbuilder.com/v1/applicatio...
    <ApplyURL>http://www.careerbuilder.com/jobseeker/jobs/redirectaol...
    <JobDID>J8A2RM68F1DL4WZ25LJ</JobDID>
    <JobTitle>Customer Account Specialist - Consumer Finance - Lancaster, O...
    <TotalQuestions>11</TotalQuestions>
    <TotalRequiredQuestions>8</TotalRequiredQuestions>
    <Questions>
      <Question>
        <QuestionID>ApplicantName</QuestionID>
        <QuestionType>Basic</QuestionType>
        <IsRequired>true</IsRequired>
        <ExpectedResponseFormat>Text 50</ExpectedResponseFormat>
        <QuestionText>Your name</QuestionText>
      </Question>
      <Question>
        <QuestionID>ApplicantEmail</QuestionID>
        <QuestionType>Basic</QuestionType>
        <IsRequired>true</IsRequired>
        <ExpectedResponseFormat>Text 50</ExpectedResponseFormat>
        <QuestionText>Your email</QuestionText>
      </Question>
      <Question>
        <QuestionID>Resume</QuestionID>
        <QuestionType>Basic</QuestionType>
        <IsRequired>true</IsRequired>
        <ExpectedResponseFormat>Text 5000</ExpectedResponseFormat>
        <QuestionText>Your resume</QuestionText>
      </Question>
      <Question>
        <QuestionID>CoverLetter</QuestionID>
        <QuestionType>Basic</QuestionType>
        <IsRequired>false</IsRequired>
        <ExpectedResponseFormat>Text 5000</ExpectedResponseFormat>
        <QuestionText>Your cover letter</QuestionText>
      </Question>
      <Question>
        <QuestionID>MeetsRequirements</QuestionID>
        <QuestionType>JobSpecific</QuestionType>
        <IsRequired>true</IsRequired>
        <QuestionText>Do you meet all the requirements specified by the empl...
        <Answers>
          <Answer>
            <QuestionID>MeetsRequirements</QuestionID>
            <AnswerID>Yes</AnswerID>
            <AnswerText>Yes</AnswerText>
          </Answer>
          <Answer>
            <QuestionID>MeetsRequirements</QuestionID>
            <AnswerID>No</AnswerID>
            <AnswerText>No</AnswerText>
          </Answer>
        </Answers>
      </Question>
      <Question>
        <QuestionID>104498</QuestionID>
        <QuestionType>Screener</QuestionType>
        <IsRequired>true</IsRequired>
        <ExpectedResponseFormat>AnswerID</ExpectedResponseFormat>
        <QuestionText>Do you currently live in the local area?</QuestionText>
        <Answers>
          <Answer>
            <QuestionID>104498</QuestionID>
            <AnswerID>263315</AnswerID>
            <AnswerText>Yes</AnswerText>
          </Answer>
          <Answer>
            <QuestionID>104498</QuestionID>
            <AnswerID>263316</AnswerID>
            <AnswerText>No</AnswerText>
          </Answer>
        </Answers>
      </Question>
      <Question>
        <QuestionID>107812</QuestionID>
        <QuestionType>Screener</QuestionType>
        <IsRequired>true</IsRequired>
        <ExpectedResponseFormat>AnswerID</ExpectedResponseFormat>
        <QuestionText>Are you bilingual in English/Spanish?</QuestionText>
        <Answers>
          <Answer>
            <QuestionID>107812</QuestionID>
            <AnswerID>270969</AnswerID>
            <AnswerText>Yes</AnswerText>
          </Answer>
          <Answer>
            <QuestionID>107812</QuestionID>
            <AnswerID>270970</AnswerID>
            <AnswerText>No</AnswerText>
          </Answer>
        </Answers>
      </Question>      
  </BlankApplication>
</ResponseBlankApplication>

Service Info

http://api.careerbuilder.com/v1/application/submit

Processes application data. POST requests only.

If you are using CareerBuilder API in software or services available to the public, your software or service must not submit applications on a user's behalf without the user's explicit direction.

The service request must consist of an XML document, or XML fragment, containing:

  • Your Developer Key.
  • The DID of the job to apply to.
  • A list responses. A response must consist of a questionID and response text. Responses don't have to be in any particular order.
  • Whether or not this is application is for testing purposes only (optional boolean, defaults to False)
  • Your SiteID (optional)
  • Your CoBrand code (optional)
  • A resume
    • This resume will be in one of two formats
    • A response for the Resume QuestionID
    • A resume node containing both a ResumeFileName node and a ResumeData node
      • ResumeFileName contains the name of the file
      • ResumeData contains the base64 encoded contents of the file
      • Using the resume node to submit the resume will keep the formatting present in the file.
      We currently support the following formats: .docx .doc .rtf .txt .pdf

Sample Input with resume question answered

<?xml version="1.0" encoding="UTF-8" ?>
<RequestApplication>  
  <DeveloperKey>XXXXXXXXXXXXXXXXXXX</DeveloperKey>
  <JobDID>J8A2RM68F1DL4WZ25LJ</JobDID>  
  <Test>false</Test>
  <SiteID />
  <CoBrand />
  <Responses>
    <Response>
      <QuestionID>ApplicantName</QuestionID>
      <ResponseText>Judy JobSeeker</ResponseText>
    </Response>
    <Response>
      <QuestionID>ApplicantEmail</QuestionID>
      <ResponseText>Judy.JobSeeker@bogusemail.com</ResponseText>
    </Response>
    <Response>
      <QuestionID>Resume</QuestionID>
      <ResponseText>Judy JobSeeker 1234 Sample Street Norcross, GA 3009...</ResponseText>
    </Response>
    <Response>
      <QuestionID>Meets Requirements</QuestionID>
      <ResponseText>Yes</ResponseText>
    </Response>
    <Response>
      <QuestionID>104498</QuestionID>
      <ResponseText>263315</ResponseText>
    </Response>
    <Response>
      <QuestionID>107812</QuestionID>
      <ResponseText>270970</ResponseText>
    </Response>
  </Responses>
</RequestApplication>

Sample Input with resume node

<?xml version="1.0" encoding="UTF-8" ?>
<RequestApplication>  
  <DeveloperKey>XXXXXXXXXXXXXXXXXXX</DeveloperKey>
  <JobDID>J8A2RM68F1DL4WZ25LJ</JobDID>  
  <Test>false</Test>
  <SiteID />
  <CoBrand />
  <Resume>
    <ResumeFileName>FileName</ResumeFileName>
    <ResumeData>base64 encoded file contents</ResumeData>
  </Resume>
  <Responses>
    <Response>
      <QuestionID>ApplicantName</QuestionID>
      <ResponseText>Judy JobSeeker</ResponseText>
    </Response>
    <Response>
      <QuestionID>ApplicantEmail</QuestionID>
      <ResponseText>Judy.JobSeeker@bogusemail.com</ResponseText>
    </Response>
    <Response>
      <QuestionID>Meets Requirements</QuestionID>
      <ResponseText>Yes</ResponseText>
    </Response>
    <Response>
      <QuestionID>104498</QuestionID>
      <ResponseText>263315</ResponseText>
    </Response>
    <Response>
      <QuestionID>107812</QuestionID>
      <ResponseText>270970</ResponseText>
    </Response>
  </Responses>
</RequestApplication>

XSD for input

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="RequestApplication">
  <xs:complexType>
    <xs:all>
      <xs:element name="DeveloperKey" type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:element name="JobDID" type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:element name="Test" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
      <xs:element name="SiteID" type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="CoBrand" type="xs:string" minOccurs="0" maxOccurs="1"/>
      <xs:element name="Resume" minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:all>
            <xs:element name="ResumeFileName" type="xs:string"  minOccurs="1" maxOccurs="1"/>
            <xs:element name="ResumeData" type="xs:base64Binary"  minOccurs="1" maxOccurs="1"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element name="Responses"  minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="Response"  minOccurs="1" maxOccurs="unbounded">
              <xs:complexType>
                <xs:all>
                  <xs:element name="QuestionID" type="xs:string" minOccurs="1" maxOccurs="1"/>
                  <xs:element name="ResponseText" type="xs:string" minOccurs="1" maxOccurs="1"/>
                </xs:all>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:all>
  </xs:complexType>
</xs:element>

</xs:schema>

Sample Output

<?xml version="1.0" encoding="UTF-8" ?>
<ResponseApplication>  
  <Errors /> 
  <TimeResponseSent>9/26/2007 5:03:59 PM</TimeResponseSent>
  <TimeElapsed>3.7034457</TimeElapsed>
  <ApplicationStatus>Complete</ApplicationStatus>
</ResponseApplication>

Service Info

http://api.careerbuilder.com/v1/application/form?

Displays a very simple application form, based on the info received from application/blank. It provides some basic error handling and validation. When the submit button is clicked, the application/form method will package the user's reponses and send them off to application/submit for processing.

If you are using CareerBuilder API in software or services available to the public, your software or service must not submit applications on a user's behalf without the user's explicit direction.

Parameters

  • &DeveloperKey=
    • Required
  • &JobDID=
    • Required, string
    • Can accept a single value only.
    • The JobDID is a unique identifier received in every Job Search Result item.

Sample Screenshot

Screenshot of a sample form.