https://site.BerkeAssessment.com/api/GetReport [GET]

Uses an encrypted report link to return a PDF report for an assessment/job combination that describes job fit, personality traits, and interview methods. This method does not require additional authentication and is intended for use by users without a Berke Assessment user account. Visit the API Settings (Berke login required) page to disable this method.

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.

Parameter Value
Required. Alphanumeric. Case-insenstitive. id values are returned at the end of the jobFit.reportUrl nodes in the API calls to get completed assessment results.

The id value is shown in the example below:
<jobFit job="[jobName_1]" fitPct="0.99" fit="High" sourceJobId="[sourceJobId_1]" reportUrl="https://site.BerkeAssessment.com/GetReport/ABC00EXAMPLEID00XYZ" />

     Cancel
Successful Example Response
Success [200] Successful responses start a PDF file download with a content type of application/pdf.

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
This is the most common error. The id has either been tampered with or modified. Any change (except for case) will invalidate the id value.
The assessment you requested has been deleted or inactivated since the id was generated.
The job fit you requested has been deleted or inactivated since the id was generated.
This unlikely error indicates that the assessment you requested has been re-opened for further data collection since id was generated.
Anonymous report retrieval can be disabled for all users in the API Settings (Berke login required) page.
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 [2024-11-22T20:47:21.0005796Z] to [2024-11-22T20:47:21.6005796Z]." responseCode="429" callDeniedDateTime="2024-11-22T20:47:21.7005796Z" callExpiresOnCompletion="true" countCallsExceeded="3" estimatedMillisecondsToNextAllowedCall="423" firstCallDeniedDateTime="2024-11-22T20:47:21.4005796Z" isDailyLimit="false" maximumCallsPerTimeFrame="120" timeFrameMilliseconds="60000" />

            
{
  "callDeniedDateTime": "2024-11-22T20:47:21.7005796Z",
  "callExpiresOnCompletion": true,
  "countCallsExceeded": 3,
  "estimatedMillisecondsToNextAllowedCall": 423,
  "firstCallDeniedDateTime": "2024-11-22T20:47:21.4005796Z",
  "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 [2024-11-22T20:47:21.0005796Z] to [2024-11-22T20:47:21.6005796Z].",
  "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.
        
    • 
    


        

    		

    

        
            Other Failure Types [!=200]
        
        
                

        
    
            
  • 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 
    •