Type Ahead

SkyHive’s TypeAhead API allows you to provide users with a streamlined approach to manual profile population. With this API, you can:

  • Supply predictive, normalized choices for skills, job titles, educational institutions, etc. for manual population after the user’s resume is parsed by the Parsers API, or if the user skips resume parsing.

TypeAhead API Methods

You can enable predictive search using these methods:

  • Use skills to provide predictive search for skills by title
  • Use jobTitle to provide predictive search for jobs by title
  • Use institution to provide predictive search for educational institutions by name
  • Use hobby to provide predictive search for hobbies by title
  • Use degree to provide predictive search for degree type by title
  • Use certification to provide predictive serve for certifications by name

Use Cases

The following use case covers a possible application of the TypeAhead API:

Skills

Securityauth
Request
query Parameters
query
required
string
limit
integer <int32>
Default: 5
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/typeahead/skills
Request samples

Job Title

Securityauth
Request
query Parameters
query
required
string
limit
integer <int32>
Default: 5
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/typeahead/jobtitle
Request samples

Institution

Securityauth
Request
query Parameters
query
required
string
limit
integer <int32>
Default: 5
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/typeahead/institution
Request samples

Hobby

Securityauth
Request
query Parameters
query
required
string
limit
integer <int32>
Default: 5
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/typeahead/hobby
Request samples

Degree

Securityauth
Request
query Parameters
query
required
string
limit
integer <int32>
Default: 5
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/typeahead/degree
Request samples

Certification

Securityauth
Request
query Parameters
query
required
string
limit
integer <int32>
Default: 5
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/typeahead/certification
Request samples