Scribd
Upload
143 views

RezScore API Documentation

The document summarizes the RezScore API guide. The API allows users to analyze resume data through actions like grading a resume, viewing resume contents, and checking skill demand trends. The API uses a hash key for authentication and returns output in XML format. It provides resume scores, language analysis, improvement advice, and error codes for issues.

Uploaded by

yayapointlesslogin
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
143 views

RezScore API Documentation

The document summarizes the RezScore API guide. The API allows users to analyze resume data through actions like grading a resume, viewing resume contents, and checking skill demand trends. The API uses a hash key for authentication and returns output in XML format. It provides resume scores, language analysis, improvement advice, and error codes for issues.

Uploaded by

yayapointlesslogin
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

RezScore API Guide

Last Updated 10/26/2011


Congratulations on utilizing RezScore's API. With the RezScore API, you can quickly and easily unpack the powerful data locked inside a resume. This document contains everything you need to get started.

1.0 API Access


Every post you make to the RezScore API will take the following form: http://rezscore.com/a/HASH/ACTION You must include your API hash, (which was provided to you separately), with every call you place to our API. Every API call can be made by passing input data as POST variables and will output data in XML format. Sample output is available by using the API hash demo.

2.0 Actions
The following actions are available with your API access plan. 2.1 Grade The grade action returns the RezScore grade along with supplemental information. You can perform API calls by posting the following data to http://rezscore.com/a/HASH/grade

Input Field
resume

wants_resume_help wants_job_help

Restrictions
Required Optional

Type

Binary or text 1 or 0 1 or 0

Description

Optional

The contents of the resume you want graded. Set to 1 if the user wants to be contacted by RezScore about resume help. Set to 1 if the user wants to be contacted by RezScore about relevant jobs.

Output is returned as XML which includes the following nodes. Score: Contains the grade, percentile this grade falls into, and scores for the brevity, impact, and depth. Language: Contains words and a score for their relative strength. Advice: If appropriate, includes short and long descriptions of tips for improvement. Input: Returns details about the file that was uploaded. Extended: More variables than we know what to do with!

Sample output is available from http://rezscore.com/a/demo/grade 2.2 View Retrieve the original contents of any resume you uploaded using the grade method, in various formatting. To make a call using this method, simply paste the appropriate URL returned from the text section of your call to the grade method. 2.3 Skill Syndicate up-to-the minute data on the job market for various skills. No POST necessary. If you want to see details about MySQL, for instance, simply visit: http://rezscore.com/a/HASH/skill/MySQL, or replace MySQL with any url-encoded term you'd like to query. For sample output, visit http://rezscore.com/a/demo/skill/API . All numbers returned are percents. A supply value of 1.5 means 1.5% of resumes contain this skill. A demand value of 49 means 49% of job postings require this skill.

3.0 Errors
Errors are returned as an XML output, including an error code and description. Existing error codes include the following (though more may be added as issues develop): 100-199: System Error 100: UNRECOVERABLE ERROR -- An unknown internal error occurred.

200-299: Authentication Error 200: UNKNOWN AUTHENTICATION ERROR Generic error authenticating your account, contact your RezScore representative. 201: INVALID USER The hash you passed did not validate. 202: INVALID CALL The action you attempted to call does not exist or is not provisioned for your account. 203: RATE LIMIT EXCEEDED You have exceeded the rate limit for your account.

300-399: Parsing Error 300: UNKNOWN PARSING ERROR We could not parse the resume you posted. 301: NO RESUME POSTED You did not post a resume. 302: UNSUPPORTED FILETYPE OR EMPTY FILE You provided a filetype that was not supported or devoid of content.

You might also like