Reference Guide

Application Response Data Structure

Full details on the data sent to a server by the Apply Widget plugin. The following tables list and describe the fields. At the bottom, there are sample output responses in JSON and XML.

Application Information

Path

Description

job/id

Unique ID for this job

job/company/name

Company name

job/position/title

Name of the postion

cover-letter

Cover letter provided by the applicant (optional).

questions

The up to three questions you added (optional).

questions/@total

The total attribute contains the number of questions. Is 1, 2, or 3.

questions/question/question

Question text.

questions/question/answer

Question answer. Will either be true (applicant checked the box) or an empty element, signaling false (the applicant did not check the box).

meta

The extra data you provided (optional).

Personal information for the applicant.

This schema is identical to the Member Profile schema from our REST API. Read that for more details about children fields if the sample output below is insufficient documentation.

Path

Description

person/id

Applicant's LinkedIn® ID (Note: This is custom to your specific API key.)

person/first-name

Applicant's first name

person/last-name

Applicant's last name

person/headline

Applicant's LinkedIn® headline

person/location

Applicant's location

person/public-profile-url

Applicant's LinkedIn® public profile url

person/positions

Applicant's three most recent positions

person/skills

Applicant's listed skills

person/educations

Applicant's listed education

person/patents

Applicant's listed patents

person/languages

Applicant's langages

person/publications

Applicant's certifications

person/honors

Applicant's honors

person/recommendations-received

Applicant's most recent recommendation on LinkedI®

person/email-address

Applicant's email address

person/phone-numbers

Applicant's phone number if and as entered as part of the application. This is marked as phone-type "application" to distinguish it from other phone numbers stored on LinkedIn®. Note: This is returned as a nested value to match other profile schema data, so verify that you're properly processing this.

Sample XML Response

<?xml version="1.0" encoding="UTF-8"?>
<job-application>
  <meta>Apply Widget</meta>
  <job>
    <id>5275639</id>
    <company>
      <name>ApplyMetrics</name>
    </company>
    <position>
      <title>Developer Advocate</title>
    </position>
  </job>
  <questions total="2">
    <question>
      <question>Do you have top secret clearance?</question>
      <answer>true</answer>
    </question>
    <question>
      <question>Have you passed the Series 7 Exam?</question>
      <answer/>
    </question>
  </questions>
  <person>
    <id>1</id>
    <first-name>Alfred</first-name>
    <last-name>Hitchcock</last-name>
    <headline>Vice President Marketing</headline>
    <location>
      <name>San Francisco Bay Area</name>
      <country>
        <code>us</code>
      </country>
      <postal-code>94043</postal-code>
    </location>
    <public-profile-url>http://www.linkedin.com/in/synedra</public-profile-url>
    <positions total="3">
      <position>
        <id>11</id>
        <title>Vice President Mergers and Acquisitions</title>
        <summary>Responsible for mergers and acquisitions at the company.</summary>
        <start-date>
          <year>1998</year>
          <month>1</month>
        </start-date>
        <is-current>true</is-current>
        <company>
          <id>1004</id>
          <name>Pfizer</name>
          <size>5001-10,000 employees</size>
          <type>Public Company</type>
          <industry>Biotechnology</industry>
          <ticker>PFI</ticker>
        </company>
      </position>
      <position>
        <id>1</id>
        <title>Vice President Marketing</title>
        <summary>Responsible for the overall marketing strategy.</summary>
        <start-date>
          <year>1997</year>
          <month>5</month>
        </start-date>
        <is-current>true</is-current>
        <company>
          <id>1003</id>
          <name>Genentech</name>
          <size>5001-10,000 employees</size>
          <type>Public Company</type>
          <industry>Biotechnology</industry>
          <ticker>DNA</ticker>
        </company>
      </position>
      <position>
        <id>2</id>
        <title>Director of Marketing - Europe</title>
        <summary>Responsible for the European marketing strategy. Successfully launched 5 products in 12 countries.</summary>
        <start-date>
          <year>1992</year>
          <month>2</month>
        </start-date>
        <end-date>
          <year>1997</year>
          <month>5</month>
        </end-date>
        <is-current>false</is-current>
        <company>
          <id>1003</id>
          <name>Genentech</name>
          <size>5001-10,000 employees</size>
          <type>Public Company</type>
          <industry>Biotechnology</industry>
          <ticker>DNA</ticker>
        </company>
      </position>
    </positions>
    <skills total="2">
      <skill>
        <id>14</id>
        <skill>
          <name>C++</name>
        </skill>
      </skill>
      <skill>
        <id>15</id>
        <skill>
          <name>Java</name>
        </skill>
      </skill>
    </skills>
    <educations total="3">
      <education>
        <id>101</id>
        <school-name>University of Oregon</school-name>
        <activities>Bird Dog Club, Beta Gamma Gamma</activities>
        <degree>Ph.D.</degree>
        <field-of-study>Mathematics</field-of-study>
        <start-date>
          <year>2008</year>
          <month>2</month>
        </start-date>
        <end-date>
          <year>2014</year>
          <month>5</month>
        </end-date>
      </education>
      <education>
        <id>2</id>
        <school-name>Stanford</school-name>
        <activities>Quack Scientist Club, Gamma Gamma Gamma</activities>
        <degree>Ph.D.</degree>
        <field-of-study>Physics</field-of-study>
        <start-date>
          <year>1995</year>
        </start-date>
        <end-date>
          <year>1998</year>
        </end-date>
      </education>
      <education>
        <id>1</id>
        <school-name>Stratfield University, Scotland</school-name>
        <activities>Nerd Club</activities>
        <degree>BSc</degree>
        <start-date>
          <year>1993</year>
        </start-date>
        <end-date>
          <year>1995</year>
        </end-date>
      </education>
    </educations>
    <patents total="1">
      <patent>
        <id>1</id>
        <title>System and Method for Data Entry into a Computing Device</title>
        <date>
          <year>1999</year>
          <month>1</month>
          <day>1</day>
        </date>
      </patent>
    </patents>
    <languages total="3">
      <language>
        <id>11</id>
        <language>
          <name>English</name>
        </language>
      </language>
      <language>
        <id>12</id>
        <language>
          <name>Russian</name>
        </language>
      </language>
      <language>
        <id>13</id>
        <language>
          <name>Spanish</name>
        </language>
      </language>
    </languages>
    <publications total="1">
      <publication>
        <id>3</id>
        <title>Object-oriented analysis and design with applications, third edition, Third edition</title>
        <date>
          <year>2007</year>
          <month>4</month>
          <day>6</day>
        </date>
      </publication>
    </publications>
    <certifications total="1">
      <certification>
        <id>7</id>
        <name>CFA I</name>
      </certification>
    </certifications>
    <honors>Mad Scientist of the Year, 1995 Marketing Bogusness Award, 2003</honors>
    <recommendations-received total="1">
      <recommendation>
        <id>1</id>
        <recommendation-type>
          <code>colleague</code>
        </recommendation-type>
        <recommendation-text>Alfred did an amazing job there...</recommendation-text>
        <recommender>
          <id>2</id>
          <first-name>Bruce</first-name>
          <last-name>Willis</last-name>
        </recommender>
      </recommendation>
    </recommendations-received>
    <email-address>alfred@example.net</email-address>
  </person>
  <cover-letter>To whom it may concern,\r\n\r\nI am very interested in this open position at your company.</cover-letter>
</job-application>

Sample JSON Output

{
   "coverLetter":"To whom it may concern,\r\n\r\nI am very interested in this open position at your company.  I believe my skills and work experience make me an ideal candidate for this role.  I look forward to speaking with you soon about this position.  Thank you for your consideration.\r\n\r\nBest regards,\r\n\r\nApplicant name",
   "person":{
    "headline":"Vice President Marketing",
    "skills":{
     "values":[
      {
         "id":14,
         "skill":{
          "name":"C++"
         }
      },
      {
         "id":15,
         "skill":{
          "name":"Java"
         }
      }
     ],
     "_total":2
    },
    "lastName":"Hitchcock",
    "honors":"Mad Scientist of the Year, 1995 Marketing Bogusness Award, 2003",
    "location":{
     "postalCode":"94043",
     "name":"San Francisco Bay Area",
     "country":{
      "code":"us"
     }
    },
    "emailAddress":"alfred@linkedin.com",
    "id":"1",
    "publicProfileUrl":"http://www.linkedin.com/in/adamnash",
    "positions":{
     "values":[
      {
         "summary":"Responsible for mergers and acquisitions at the company.",
         "id":11,
         "startDate":{
          "month":1,
          "year":1998
         },
         "title":"Vice President Mergers and Acquisitions",
         "company":{
          "id":1004,
          "ticker":"PFE",
          "name":"Pfizer",
          "industry":"Pharmaceuticals",
          "type":"Public Company"
         },
         "isCurrent":true
      },
      {
         "summary":"Responsible for the overall marketing strategy.",
         "id":1,
         "startDate":{
          "month":5,
          "year":1997
         },
         "title":"Vice President Marketing",
         "company":{
          "id":1003,
          "ticker":"DNA",
          "name":"Genentech",
          "industry":"Biotechnology",
          "type":"Public Company",
          "size":"5001-10,000 employees"
         },
         "isCurrent":true
      },
      {
         "summary":"Responsible for the European marketing strategy. Successfully launched 5 products in 12 countries.",
         "id":2,
         "startDate":{
          "month":2,
          "year":1992
         },
         "title":"Director of Marketing - Europe",
         "company":{
          "id":1003,
          "ticker":"DNA",
          "name":"Genentech",
          "industry":"Biotechnology",
          "type":"Public Company",
          "size":"5001-10,000 employees"
         },
         "endDate":{
          "month":5,
          "year":1997
         },
         "isCurrent":false
      }
     ],
     "_total":3
    },
    "languages":{
     "values":[
      {
         "id":11,
         "language":{
          "name":"English"
         }
      },
      {
         "id":12,
         "language":{
          "name":"Russian"
         }
      },
      {
         "id":13,
         "language":{
          "name":"Spanish"
         }
      }
     ],
     "_total":3
    },
    "publications":{
     "values":[
      {
         "id":3,
         "title":"Object-oriented analysis and design with applications, third edition, Third edition",
         "date":{
          "month":4,
          "year":2007,
          "day":6
         }
      }
     ],
     "_total":1
    },
    "certifications":{
     "values":[
      {
         "id":7,
         "name":"CFA I"
      }
     ],
     "_total":1
    },
    "recommendationsReceived":{
     "values":[
      {
         "id":1,
         "recommendationType":{
          "code":"colleague"
         },
         "recommender":{
          "id":"2",
          "lastName":"Willis",
          "firstName":"Bruce"
         },
         "recommendationText":"Alfred did an amazing job there..."
      }
     ],
     "_total":1
    },
    "educations":{
     "values":[
      {
         "id":101,
         "startDate":{
          "month":2,
          "year":2008
         },
         "fieldOfStudy":"Mathematics",
         "degree":"Ph.D.",
         "schoolName":"University of Oregon",
         "endDate":{
          "month":5,
          "year":2014
         },
         "activities":"Bird Dog Club, Beta Gamma Gamma"
      },
      {
         "id":2,
         "startDate":{
          "year":1995
         },
         "fieldOfStudy":"Physics",
         "degree":"Ph.D.",
         "schoolName":"Stanford",
         "endDate":{
          "year":1998
         },
         "activities":"Quack Scientist Club, Gamma Gamma Gamma"
      },
      {
         "id":1,
         "startDate":{
          "year":1993
         },
         "degree":"BSc",
         "schoolName":"Stratfield University, Scotland",
         "endDate":{
          "year":1995
         },
         "activities":"Nerd Club"
      }
     ],
     "_total":3
    },
    "firstName":"Alfred",
    "patents":{
     "values":[
      {
         "id":1,
         "title":"System and Method for Data Entry into a Computing Device",
         "date":{
          "month":1,
          "year":1999,
          "day":1
         }
      }
     ],
     "_total":1
    }
   },
   "questions":{
     "_total":2,
     "values":[
      {
       "answer":"",
       "question":"Do you have top secret clearance?"
      },
      {
       "answer":"true",
       "question":"Have you passed the Series 7 Exam?"
      }
     ]
   },
   "job":{
    "position":{
     "title":"CEO for manufacturing and supply sector"
    },
    "id":"1100",
    "company":{
     "name":"Nokia"
    }
   },
   "meta":"Apply Widget"
}

For reference, here are tables containing all the Apply plugin input parameters.

Basic Data

Name

Required

Default

Value

Example

data-jobId

no

none

string for partner to uniquely identify job

data-jobId="ENG-12345"

data-jobTitle

yes

none

String describing job title

data-jobTitle="Principal Data Engineer"

data-email

no, unless no data-url

none

String for receiving email address

data-email="careers@xyzcompany.com"

data-url

no, unless no data-email

none

String for URL to post data payload

data-url="http://api.xyzcompany.com/rest/postJobs"

data-urlFormat

no

json

String controlling whether to post data in “xml” or “json” format

data-urlFormat="xml"

data-onclick

no

none

Javascript function on the same page as the plugin. This will be called when the user has been clicked on the plugin, passing a data structure matching the triggered's plugin settings.

data-onclick="applyClick"

data-callback

no

none

Javascript function on the same page as the plugin. This will be called when the user has successfully submitted the application, passing a data structure matching the triggered's plugin settings.

data-callback="applySuccess"

data-dropboxapikey

no

none

API Key for dropbox. Required if you want to provide the option to upload resume from Dropbox. See supporting documentation for more details

data-dropboxapikey="l0ur5ksksjstjsu9"

data-filepickerapikey

no

none

API Key for filepicker.Required if you want to provide the option to upload resume from Google Drive. See supporting documentation for more details

data-filepickerapikey="12gddjj922n4k23asq"

data-location

no

none

Use this field if you want the application score to consider applications from the country stated (in lower case values as defined by ISO 3166-1 alpha-2 standard). See supporting documentation for more details

data-location="ie"

data-industry

no

none

Use this field if you want the application score to consider industries stated. See supporting documentation for more details

data-industry="Internet"

Error Codes

Error Code

Like Cause

Suggested Action

100 cannot access apikeys Likely major backend issue. Please contact support@applymetrics.com
101 API Key contract not active The API key specified is not linked to a paying account. Go to applymetrics.com and check the API key registered on your account.
102 proxy error Check your api key/secret
103 callback error Check your callback url
104 limit reached (max 3 pages allowed on free plan) Upgrade your plan