v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Add Talent Education History

Adds information about the education history to the profile of the specified talent record. This information is displayed on the Education tab of the talent profile page.

post/v1/talent/{talentId}/talent-education-history

Path parameters

talentIdstring required

The identifier of the talent for whom the education history should be added.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

idinteger

The identifier for the talent education history record.

talentIdinteger required

The identifier for the talent.

fromstring

The start date. This is an open-format text field containing the year, and possibly month of the date. For example, 2012, 9/12, 09-2012.

tostring

The date of completion. This is an open-format text field containing the year, and possibly month of the date. For example, 2016, 5/16, 05-2016.

schoolstring

The name of the educational institution.

schoolTypestring required

The type of school attended. Valid values are 'Highschool', 'Secondary', 'Trade', 'Community', 'College' and 'University'.

degreestring

The name of the obtained degree.

degreeTypestring required

The type of the degree obtained. Valid values are 'Secondary', 'High School or Equivalent', 'Some High School or Equivalent', 'HND/HNC or Equivalent', 'Vocational', 'Certification', 'Some College', 'Associates', 'Bachelors', 'Some Post-Graduate', 'Masters', 'Doctorate', 'Postdoctorate', 'Professional', 'Post Professional', 'Intermediate Graduate', 'Special Education', 'GED' and 'International'.

fieldstring

The field of studies.

gpastring

The Grade Point Average.

citystring

The city where the school is located.

statestring

The state/province or region where the school is located in open-format text.

countrystring

The country where the school is located in open-format text.

notesstring

Additional notes on the talent's education history.

Example request

{
  "id": 1397,
  "talentId": 19884,
  "from": "9/2012",
  "to": "5/2016",
  "school": "Kansas University",
  "schoolType": "College",
  "degree": "Bachelor's of Liberal Arts",
  "degreeType": "Bachelors",
  "field": "English",
  "gpa": "3.56",
  "city": "Lawrence",
  "state": "Kansas",
  "country": "US",
  "notes": "Active in school government."
}

Response

The talent education history that was successfully added.

idinteger

The identifier for the talent education history record.

talentIdinteger required

The identifier for the talent.

fromstring

The start date. This is an open-format text field containing the year, and possibly month of the date. For example, 2012, 9/12, 09-2012.

tostring

The date of completion. This is an open-format text field containing the year, and possibly month of the date. For example, 2016, 5/16, 05-2016.

schoolstring

The name of the educational institution.

schoolTypestring required

The type of school attended. Valid values are 'Highschool', 'Secondary', 'Trade', 'Community', 'College' and 'University'.

degreestring

The name of the obtained degree.

degreeTypestring required

The type of the degree obtained. Valid values are 'Secondary', 'High School or Equivalent', 'Some High School or Equivalent', 'HND/HNC or Equivalent', 'Vocational', 'Certification', 'Some College', 'Associates', 'Bachelors', 'Some Post-Graduate', 'Masters', 'Doctorate', 'Postdoctorate', 'Professional', 'Post Professional', 'Intermediate Graduate', 'Special Education', 'GED' and 'International'.

fieldstring

The field of studies.

gpastring

The Grade Point Average.

citystring

The city where the school is located.

statestring

The state/province or region where the school is located in open-format text.

countrystring

The country where the school is located in open-format text.

notesstring

Additional notes on the talent's education history.

Example response

{
  "id": 1397,
  "talentId": 19884,
  "from": "9/2012",
  "to": "5/2016",
  "school": "Kansas University",
  "schoolType": "College",
  "degree": "Bachelor's of Liberal Arts",
  "degreeType": "Bachelors",
  "field": "English",
  "gpa": "3.56",
  "city": "Lawrence",
  "state": "Kansas",
  "country": "US",
  "notes": "Active in school government."
}