People | Career

Service to manage entities of type 'Career'.

Overview

api/{tenantKey}/{orgKey}/peopleCore/careers

URL	api/{tenantKey}/{orgKey}/peopleCore/careers
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Careers
- POST Career
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiCareerCareerJobGradesResource
ApiCareerResource
CareerJobGradeResource
CareerResource
MoneyResource

GET Operations

GET Careers

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See CareerResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers

GET /peopleCore/careers

GET Careers (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See CareerResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers?page={page}&pageSize={pageSize}

GET /peopleCore/careers?page={page}&pageSize={pageSize}

GET Career by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See CareerResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{id}

GET /peopleCore/careers/{id}

GET Career by key

Returns the entity record that matches the specified key.

The following elements are required:

careerKey

(string) Career.

Response:

When successful, the response body contains the entity record. See CareerResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}

GET /peopleCore/careers/{careerKey}

GET Print Career by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{id}/print?template={template}

GET /peopleCore/careers/{id}/print?template={template}

GET Print Career by key

Prints the specified entity record.

The following elements are required:

careerKey

(string) Career.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/print

GET /peopleCore/careers/{careerKey}/print

GET Original Print CareerOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{id}/printOriginal?template={template}

GET /peopleCore/careers/{id}/printOriginal?template={template}

GET Original Print Career by key

Prints the specified entity record.

The following elements are required:

careerKey

(string) Career.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/printOriginal

GET /peopleCore/careers/{careerKey}/printOriginal

POST Operations

POST Careers

Creates a new entity record.

The following elements are required:

careerResource

(ApiCareerResource) The request body should contain the entity record that should be created.
See ApiCareerResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCareerResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers

POST /peopleCore/careers

POST Career

Inserts a new 'Career Job Grade' in the 'Career'.

The following elements are required:

careerKey	(string) Career.
value	(ApiCareerCareerJobGradesResource) The ApiCareerCareerJobGradesResource instance. See ApiCareerCareerJobGradesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades

POST /peopleCore/careers/{careerKey}/careerJobGrades

PUT Operations

PUT Set CareerKey Career

Updates the value of attribute 'CareerKey' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerKey

PUT /peopleCore/careers/{careerKey}/careerKey

PUT Set Currency CareerJobGrade

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/currency

PUT /peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/currency

PUT Set Description CareerJobGrade

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/description

PUT /peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/description

PUT Set IsActive Career

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/isActive

PUT /peopleCore/careers/{careerKey}/isActive

PUT Set JobGrade CareerJobGrade

Updates the value of attribute 'JobGrade' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/jobGrade

PUT /peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/jobGrade

PUT Set Level CareerJobGrade

Updates the value of attribute 'Level' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
lineId	(string) The detail identifier.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/level

PUT /peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/level

PUT Set MaxWage CareerJobGrade

Updates the value of attribute 'MaxWage' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
lineId	(string) The detail identifier.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/maxWage

PUT /peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/maxWage

PUT Set MinWage CareerJobGrade

Updates the value of attribute 'MinWage' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
lineId	(string) The detail identifier.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/minWage

PUT /peopleCore/careers/{careerKey}/careerJobGrades/{lineId}/minWage

PUT Set Name Career

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

careerKey	(string) Career.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/name

PUT /peopleCore/careers/{careerKey}/name

DELETE Operations

DELETE Career Job Grade by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

careerKey	(string) Career.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}/careerJobGrades/{lineId}

DELETE /peopleCore/careers/{careerKey}/careerJobGrades/{lineId}

DELETE Career by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{id}

DELETE /peopleCore/careers/{id}

DELETE Career by key

Deletes the entity record that matches the specified key.

The following elements are required:

careerKey

(string) Career.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/careers/{careerKey}

DELETE /peopleCore/careers/{careerKey}

Resources

ApiCareerCareerJobGradesResource

The following elements are required:

minWage	(MoneyResource) Min Wage. See MoneyResource .
maxWage	(MoneyResource) Max Wage. See MoneyResource .
currency	(string) Currency.
jobGrade	(string) Job Grade.

The following elements are optional:

level	(int) Level.
description	(string) Description.

ApiCareerResource

The following elements are required:

careerKey	(string) Career.
name	(string) Name.

The following elements are optional:

careerJobGrades

(List of ApiCareerCareerJobGradesResource) Career Job Grades.
See ApiCareerCareerJobGradesResource.

CareerJobGradeResource

The following elements are required:

minWage	(MoneyResource) Min Wage. See MoneyResource .
maxWage	(MoneyResource) Max Wage. See MoneyResource .
currency	(string) Currency.
jobGrade	(string) Job Grade.

The following elements are optional:

level	(int) Level.
description	(string) Description.

CareerResource

The following elements are required:

careerKey	(string) Career.
name	(string) Name.

The following elements are optional:

careerJobGrades

(List of CareerJobGradeResource) Career Job Grades.
See CareerJobGradeResource.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.