All-in-one method to create an assessment, send an invitation, and return scores and reports when complete. Operations include:

  • creating a new assessment if the does not exist in your account, and
  • sending an assessment invitation if the assessment is not complete, and
  • returning scores and report links if the assessment is complete.

Each time you call this method, it will send an invitation to the candidate until the assessment is complete. When the assessment is complete, a call to this method will return the candidate's job fit scores and report URL links.

We recommend using this API method for new integrations unless you need the more granular control offered by the CreateAssessment, UpdateAssessment, SendInvitation, GetAssessmentStatus, and GetCompletedAssessment methods.

Parameter Value
Required. 1-50 characters. Case-sensitive. Visit Settings | API:Security to change your API token (Berke login required). Your API token is a server-side authentication value. Do not embed it in client-side Javascript or submit it to Berke via an insecure connection.
Optional. Null or 1-50 characters. Your API Token is mapped to a default user. Use this field to change from the default API user to a specific user. The user must exist in your Berke account and is active. Null defaults to default API user. Visit Settings | API:Security to change your default API user (Berke login required).
 
The user controls the following:
  • Manager Name on all reports comes from user.
  • If OnAssessmentCompleteAction = 2, then the user will automatically receive the participant's assessment report via email.
  • If departments are defined, the user's department will be affiliated with the assessment if sourceDepartmentId is null.
  • All operations and logging are done in the context of the user.
Required, 1-50 characters. SourceCandidateId is not case-sensitive. Identifies the participant in the customer's ATS/HRIS/EPM/etc. This value must be unique for each candidate. Once set, use the UpdateAssessment method to change SourceCandidateId. This value can be seen in the Berke Assessment site by clicking the Optional Settings button on the Update Assessment User page. Do not use Social Security Numbers, bank IDs or other highly sensitive personally-identifiable information in the SourceCandidateId field. Berke recommends a badge ID, HRIS ID, ATS ID, etc.
Required. Must be a well-formed email address. The participant will receive assessment invitations and reminders at this address. Note that email address is not used as an ID of any sort and does not have to be unique.
Required the first time you call PerformAssessment for a given SourceCandidateId, optional thereafter. 1-100 characters. If passed on subsequent calls for a given SourceCandidateId, the First Name will be updated.
Required the first time you call PerformAssessment for a given SourceCandidateId, optional thereafter. 1-100 characters. If passed on subsequent calls for a given SourceCandidateId, the Last Name will be updated.
Optional. Null or 1-50 characters. SourceJobId is not case-sensitive. This value is only recorded the first time you call PerformAssessment for a given SourceCandidateId; changing SourceJobId on subsequent calls will create an error response. If SourceJobId is provided, it must be previously assigned to a job via the Settings link's API | Job Assignments (Berke login required) option. Null will use the default company-level job (Berke login required). The most important outcome of this value is the data captured by the assessment. For example, a job that only captures personality data cannot be used to generate match scores for jobs that require talent measures. You can retrieve your sourceJobId values with the GetJobs method.
Optional. Null or 1-50 characters. SourceDepartmentId is not case-sensitive. Assigns the assessment to a specific department. If provided, value must be previously assigned to a department the Departments (Berke login required) page or via the API. Null defaults to the department assigned to the current API user. The department must be enabled to receive a new assessment. If passed on subsequent calls for a given SourceCandidateId, the SourceDepartmentId will be updated.
Optional. Null or 1-100 characters. Used when sending assessment invitations. If null, the full name of the participant's hiring manager will be used.
Optional. Null or 1-100 characters. Used when sending assessment invitations. If provided, must be a well-formed email address. If null, the email address of the participant's hiring manager will be used.
Optional. Null or 1-500 characters. This value will be included in email invitations and assessment reminder messages sent to the participant. If null, the default invitation message specified in the Personalization | Assessment settings page (Berke login required) will be used. HTML markup is prohibited. To avoid spam blockers, do not use exclamation points or PHRASES IN CAPS.
Optional. Null or up to 150 characters. If provided, the candidate will be GET/302 redirected to the URL immediately when his/her assessment is complete. The URL must be absolute, well-formed, and be prefixed with HTTP or HTTPS. If the candidate re-opens his or her assessment after completion, the assessment will continue to redirect to the URL, so you must account for the possibility of multiple visits to the target URL. If passed on subsequent calls for a given SourceCandidateId, the OnAssessmentCompleteRedirectToUrl will be updated. Tell Me More
Optional. Null, 1 [do nothing], 2 [email Hiring Manager Reports to hiring manager], 4 [email Participant Report to participant], 5 [email report to comma-separated list of addresses]. Defaults to 1 [do nothing]. This value controls what happens after an assessment is complete. If 1, then no further action occurs. If 2, the assessment's default report is emailed to the hiring manager (set by the username parameter). If 4, the Participant Report is emailed to the participant. If the participant does not have an email associated with his/her assessment, the mail operation will be cancelled. If 5 [email report to comma-separated list of addresses], emailReportToList field must also be populated with at least one address. Operations cannot be combined -passing in 6 will not perform 2 and 4. If passed on subsequent calls for a given SourceCandidateId, the OnAssessmentCompleteAction will be updated.
Optional. Null or 1-250 characters. If provided, must contain a comma-separated list of one or more well-formed email addresses. The list is required if onAssessmentCompleteAction = 5. If AssessmentCompleteAction is not 5, then the list will be ignored. If passed on subsequent calls for a given SourceCandidateId, the EmailReportToList will be updated.
Optional. Defaults to first value in list if not supplied. This value sets format in which to return the results of the method. All formats return the same data and hierarchical layout.
<?xml version="1.0" encoding="utf-16"?>
<berkeResponse status="ok" responseCode="200">
  <assessmentStatus sourceCandidateId="[sourceCandidateId]" status="[status]" statusId="0" jobFitScoresAvailable="true" firstName="[firstName]" lastName="[lastName]" formalTitle="[formalTitle]" invitationCode="[invitationCode]" assessmentUrl="https://example.assessment.url/[invitationCode]" percentComplete="0" createdOnUtc="1545228051.155" startedOnUtc="1545228051.155" completedOnUtc="1545228051.155" startCount="0" emailAddress="[endReminder@Here.com]" remindUntilUtc="1546437651.155" onAssessmentCompleteRedirectToUrl="[https://yourDomainHere.com]?code=[invitationCode]&amp;id=[sha512Hash]" />
  <jobFitList>
    <jobFit job="[jobName_1]" fitPct="0.99" fitId="3" fit="High" isPrimaryJob="true" sourceJobId="[sourceJobId_1]" reportUrl="https://example.assessment.url/rpt/K82GE6AZYE63XVRSG6BRJDFUHH" fitComputedOnUtc="1545228051.1545174" />
    <jobFit job="[jobName_2]" fitPct="0.65" fitId="2" fit="Medium" isPrimaryJob="false" sourceJobId="[sourceJobId_2]" reportUrl="https://example.assessment.url/rpt/SS9CANXGD32BDPG5NM2PEG3HW5" fitComputedOnUtc="1545228051.1545174" />
    <jobFit job="[jobName_3]" fitPct="0.32" fitId="1" fit="Low" isPrimaryJob="false" sourceJobId="[sourceJobId_3]" reportUrl="https://example.assessment.url/rpt/54K8JB64CCWPJ6XJC2QTDS9FPW" fitComputedOnUtc="1545228051.1545174" />
    <jobFit job="[jobName_4]" fitPct="-1" fitId="4" fit="Match Disabled In Job" isPrimaryJob="false" sourceJobId="[sourceJobId_4]" reportUrl="https://example.assessment.url/rpt/63HTU8SF655RF7YXULWB3S7YWW" fitComputedOnUtc="1545228051.1545174" />
    <jobFit job="[jobName_5]" fitPct="-1" fitId="5" fit="Not Enough Assessment Data" isPrimaryJob="false" sourceJobId="[sourceJobId_5]" reportUrl="" fitComputedOnUtc="1545228051.1545174" />
  </jobFitList>
</berkeResponse>
{
  "assessmentStatus": {
    "sourceCandidateId": "[sourceCandidateId]",
    "status": "[status]",
    "statusId": 0,
    "jobFitScoresAvailable": true,
    "firstName": "[firstName]",
    "lastName": "[lastName]",
    "formalTitle": "[formalTitle]",
    "invitationCode": "[invitationCode]",
    "assessmentUrl": "https://example.assessment.url/[invitationCode]",
    "percentComplete": 0,
    "createdOnUtc": 1545228051.17,
    "startedOnUtc": 1545228051.17,
    "completedOnUtc": 1545228051.17,
    "startCount": 0,
    "emailAddress": "[endReminder@Here.com]",
    "remindUntilUtc": 1546437651.17,
    "onAssessmentCompleteRedirectToUrl": "[https://yourDomainHere.com]?code=[invitationCode]&id=[sha512Hash]"
  },
  "jobFit": [
    {
      "job": "[jobName_1]",
      "fitPct": 0.99,
      "fitId": 3,
      "fit": "High",
      "isPrimaryJob": true,
      "sourceJobId": "[sourceJobId_1]",
      "reportUrl": "https://example.assessment.url/rpt/K82GE6AZYE63XVRSG6BRJDFUHH",
      "fitComputedOnUtc": 1545228051.1701446
    },
    {
      "job": "[jobName_2]",
      "fitPct": 0.65,
      "fitId": 2,
      "fit": "Medium",
      "isPrimaryJob": false,
      "sourceJobId": "[sourceJobId_2]",
      "reportUrl": "https://example.assessment.url/rpt/SS9CANXGD32BDPG5NM2PEG3HW5",
      "fitComputedOnUtc": 1545228051.1701446
    },
    {
      "job": "[jobName_3]",
      "fitPct": 0.32,
      "fitId": 1,
      "fit": "Low",
      "isPrimaryJob": false,
      "sourceJobId": "[sourceJobId_3]",
      "reportUrl": "https://example.assessment.url/rpt/54K8JB64CCWPJ6XJC2QTDS9FPW",
      "fitComputedOnUtc": 1545228051.1701446
    },
    {
      "job": "[jobName_4]",
      "fitPct": -1.0,
      "fitId": 4,
      "fit": "Match Disabled In Job",
      "isPrimaryJob": false,
      "sourceJobId": "[sourceJobId_4]",
      "reportUrl": "https://example.assessment.url/rpt/63HTU8SF655RF7YXULWB3S7YWW",
      "fitComputedOnUtc": 1545228051.1701446
    },
    {
      "job": "[jobName_5]",
      "fitPct": -1.0,
      "fitId": 5,
      "fit": "Not Enough Assessment Data",
      "isPrimaryJob": false,
      "sourceJobId": "[sourceJobId_5]",
      "reportUrl": "",
      "fitComputedOnUtc": 1545228051.1701446
    }
  ],
  "status": "ok",
  "response": null,
  "responseCode": "200"
}
<?xml version="1.0" encoding="utf-16"?>
<berkeResponse status="[!=ok]" response="[Error Message], [Parameter]=[[ParameterValue]]" responseCode="[!=200]" />
{
  "status": "[!=ok]",
  "response": "[Error Message], [Parameter]=[[ParameterValue]]",
  "responseCode": "[!=200]"
}
Successful Example Response

                
  • The assessmentStatus node includes the following attributes:
    • The sourceCandidateId attribute is the unique ID you supplied when creating the candidate's assessment.
    • The status attribute is a label that describes whether an assessment is not started, in progress (but not necessarily in progress in real time), or complete.
    • The status Id attribute is the value you should use to determine whether an assessment is complete. Do not use percent complete or the status label. statusId will be one of the following values:
      • 5 = Not Started
      • 1 = In Progress
      • 2 = Complete
    • The jobFitScoresAvailable attribute is a boolean value that indicates whether the candidate's assessment is complete and the scores/report links are ready.
    • The firstName and lastName attributes are the values set by the candidate when taking the assessment.
    • The invitationCode attribute is the unique serial number that starts the assessment for a participant. You will note that it is also found at the end of the assessmentUrl invitationCode. The value is separated in the event you want participants to manually start the assessment. To manually start, participants go to the assessment site and manually key the invitation code. To avoid transcription errors, we recommend using the assessmentUrl instead. Manual starts are typically used when a participant does not have an email address, if the assessment invitation is being printed instead of mailed, or if the assessment is delivered in a proctored environment.
    • The assesmentUrl is a direct deep link to the assessment site that will automatically launch the assessment when presented to a participant. This is the recommended method for starting the assessment. You will note that the url ends with the invitationCode attribute. This attribute will be empty after the assessment is completed.
    • The percentComplete attribute is a value between 0 and 100 that describes how far along the participant is in the assessment process. Completion percentage is measured by average time to complete the sections in the assessment, rather than simply by dividing the number of sections in the assessment.
    • The createdOnUtc attribute describes the UTC date and time when the assessment was created. The value is expressed in Unix time .
    • The startedOnUtc attribute describes the UTC date and time when the assessment was started. This value will be empty if the assessment has not been started. The value is expressed in Unix time.
    • The completedOnUtc attribute describes the UTC date and time when the assessment was completed. This value will be empty if the assessment has not been started or is in progress. The value is expressed in Unix time .
    • The startCount attribute shows the number of times the participant has started the assessment. This value can indicate a technical problem or a participant who is deliberately restarting to attempt to improve his or her results. We recommend asking users whether they need technical assistance if the start count is above 3.
    • If populated, the emailAddress attribute will be used to occasionally remind the participant to complete the assessment until the reminder expires (see remindUntilUtc attribute). If emailAddress is null, reminders will not be sent.
    • The remindUntilUtc attribute describes the UTC date and time through which the participant will receive occasional reminders to complete the assessment. The value is expressed in Unix time. If the value is 0, the value is in the past, or emailAddress is empty/invalid, then reminders will not be sent. If reminders have expired, you can restart the reminder by calling the UpdateAssessment method and setting the newCompleteWithinDays value.
    • The onAssessmentCompleteRedirectToUrl attribute shows the URL to which the candidate will be directed when the assessment is complete. If null, the standard Berke completion page will be shown.
  • There are jobFit nodes for each active Berke job in your account. If the candidate's assessment is complete, it will include fit scores and report links.
    Attributes of each jobFit node include:
    • job is the name of a job.
    • fitPct describes numerically how highly the participant matches the job. This value will be -1 for jobs where matching is disabled, unavailable due to a lack of necessary data to perform a job fit, or because the assessment is not complete.
    • fitId describes how well the participant matches the job. Values include:
      • 0 = Not calculated yet, assessment is incomplete
      • 3 = High fit (67-100)
      • 2 = Medium fit (34-66)
      • 1 = Low fit (0-33)
      • 5 = Not enough data, more assessment sections are required
      • 4 = Job is not configured for fit scoring
    • fit is a label describing how well the participant matches the job. If the job is not configured for matching or the participant did not take enough assessment sections to compute a match, that information will be noted here as well.
    • isPrimaryJob is a boolean value that indicates whether the job is assigned to the assessment or if this is a score for another job in your account. Berke scores both the primary job and all additional jobs in your account for all candidates. If you only need the candidate's primary job, ignore all scores where isPrimaryJob=false.
    • sourceJobId maps the Berke Job to a job in your ATS/HRIS/EPM/etc. system. Use the job assignment feature (Berke login required) in the Berke Assessment site to set the value. sourceJobId values are either empty or unique.
    • reportUrl is URL an unauthenticated, non-Berke user can use to download a report for an assessment/job fit combination. This URL requires no authentication beyond the encrypted hash at the end. The purpose is to enable simple email distribution of the report to users without a Berke Assessment management account. You can disable unauthenticated report access via your API Settings (Berke login required). If disabled, all report retrieval must be done via the authenticated GetReportForJob method API method call or from the Berke Assessment site. You do not need to immediately retrieve the job reports. Job reports can be requested any time. Note! If your API key changes, all anonymous report links generated with that API key will become invalid. Therefore, do not store these links for long periods of time. They are only appropriate for emailing report links to a non-Berke user. For long-term report integration, use the GetReportForJob method to programatically downloads the reports you request.
    • fitComputedOn describes the UTC date and time when the match value was computed. If you are recording scores in your system, you can use this value to determine whether to update your score data. The value is expressed in Unix time .

Handing Errors

All API requests include two extended HTTP headers in the response:

  • X-Response-Code
    Contains the HTTP status code (400, 200, etc.) and a Berke status code.
    The format is [Http Status Code].[Berke Status Code].
  • X-Response-Message
    Contains a message describing the X-Response-Code header.

If your request was successful, X-Response-Code will be 200.0. If the Berke response code is 1000 or greater, then an error occurred. For example, 403.1003 tells you that there was a HTTP 403 error (Forbidden). The 1003 Berke status code tells you the API key is invalid.

When an error occurs, further information can be found in the X-Response-Message header. For example, X-Response-Message will return API key '[API.Key.Sent.To.Berke]' is invalid or inactive if the API key was not authenticated.

The most common errors returned for this method are listed below.

Status Code Failed Example Responses

                
Most API exceptions are due to invalid parameters. Review the notes below each parameter as well as the output and HTTP response code from the error message. If all values are appropriate, the failure is likely authentication-related. Authentication failure types include, but are not limited to,:
  • Too many failed calls
  • Maximum per minute or per day API calls reached
  • API call made via insecure connection
  • Invalid API key
  • API is not enabled for target company
  • API is disabled for all companies (typically during maintenance)
  • Company is inactive or expired
  • Invalid username
  • User is inactive or expired
  • Unknown sourceJobId - check your API job assignments in the primary Berke customer site
  • Invalid assessment complete action
)
sourceDepartmentId was not found.
)
Department (sourceDepartmentId) to which this assessment is assigned is not enabled. Assessments in disabled departments cannot be created, modified, or accessed via the API.
Most API exceptions are due to invalid parameters. Review the notes below each parameter as well as the output and HTTP response code from the error message. If all values are appropriate, the failure is likely authentication-related. Authentication failure types include, but are not limited to,:
  • Too many failed calls
  • Maximum per minute or per day API calls reached
  • API call made via insecure connection
  • Invalid API key
  • API is not enabled for target company
  • API is disabled for all companies (typically during maintenance)
  • Company is inactive or expired
  • Invalid username
  • User is inactive or expired
  • Unknown sourceJobId - check your API job assignments in the primary Berke customer site
  • Invalid assessment complete action

        
<?xml version="1.0" encoding="utf-16"?>
<berkeResponse status="[!=ok]" response="[API Method] API method requests exceeded burst limit of 120 occurrences within 60000 milliseconds. Excess requests occurred 3 times from [2018-12-19T14:00:50.4857735Z] to [2018-12-19T14:00:51.0857735Z]." responseCode="429" callDeniedDateTime="2018-12-19T14:00:51.1857735Z" callExpiresOnCompletion="true" countCallsExceeded="3" estimatedMillisecondsToNextAllowedCall="423" firstCallDeniedDateTime="2018-12-19T14:00:50.8857735Z" isDailyLimit="false" maximumCallsPerTimeFrame="120" timeFrameMilliseconds="60000" />
{
  "callDeniedDateTime": "2018-12-19T14:00:51.1857735Z",
  "callExpiresOnCompletion": true,
  "countCallsExceeded": 3,
  "estimatedMillisecondsToNextAllowedCall": 423,
  "firstCallDeniedDateTime": "2018-12-19T14:00:50.8857735Z",
  "isDailyLimit": false,
  "maximumCallsPerTimeFrame": 120,
  "timeFrameMilliseconds": 60000,
  "status": "[!=ok]",
  "response": "[API Method] API method requests exceeded burst limit of 120 occurrences within 60000 milliseconds. Excess requests occurred 3 times from [2018-12-19T14:00:50.4857735Z] to [2018-12-19T14:00:51.0857735Z].",
  "responseCode": "429"
}
API requests exceeded the maximum allowed per time-frame or the maximum allowed at any point in time.

API throttle limits are set per-company. Please login and return to this area to see your company's specific throttle configuration.

Your application can use the following API method response information to determine its course of action when HTTP status code 429 is returned by an API method call:

  • callDeniedDateTime: The date and time that the API method call was denied execution.
  • callExpiresUponCompletion: If this value is true then too many simultaneous calls occurred to a particular group of API methods. If this value is false then too many requests occurred for a particular time frame (daily or short-term).
  • countCallsExceeded: The count of calls that exceeded the maximum number of allowed API calls for the time frame.
  • estimatedMillisecondsToNextAllowedCall: The estimated number of milliseconds, from the callDeniedDateTime, before an API call will be allowed to execute. If callExpiresUponCompletion is true then this value will be zero as the time is dependent on numerous factors. If callExpiresUponCompletion is false then this value indicates the amount of time your application(s) should wait before attempting to make the same API method call. If a daily API call limit has been exceeded the this value indicates the amount of time your application(s) should wait before calling any API method.
  • firstCallDeniedDateTime: The date and time that the first call, of potentially many calls, was denied for the time frame. For example, if an application was denied ten calls within a time frame then firstCallDeniedDateTime indicates date and time that the first of the ten calls was denied.
  • isDailyLimit: If this value is true then the response indicates that the maximum number of API methods calls for the current day has been exceeded. If this value is false then the response indicates that the maximum number of API method calls for a time frame, other than daily, has been exceeded.
  • maximumCallsPerTimeFrame: Indicates the maximum number of times an API method can be called for daily, short-term or simultaneous call limits.
  • timeFrameMilliseconds: Indicates the number of milliseconds in which maximumCallsPerTimeFrame API method calls is allowed.