People | Batch Create Vocational Training

Overview

URL	api/{tenantKey}/{orgKey}/people/batchCreateVocationalTrainings
Methods Supported	GET, POST

All Operations

This service includes the following operations:

• GET:
  • GET Batch Create Vocational Training
• POST:
  • POST Batch Create Vocational Training

All Resources

This service uses the following resources:

• VocationalTrainingLine
• VocationalTrainingMain

GET Operations

GET Batch Create Vocational Training

Returns the list of entity records that can be processed by the 'VocationalTrainings' service.

The following elements are required:

pageIndex	(int) The index of the page of the list that should be returned.
pageSize	(int) The number of page elements that should be returned (max. is 1000).
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
duration	(decimal) Duration (in hours).
trainingArea	(string) Training Area.
designation	(string) Designation.
trainingInitiative	(string) Training Initiative.
trainingQualificationLevel	(string) Training Qualification Level.
trainingEntityType	(string) Training Entity Type.
certificationType	(string) Certification Type.
trainingReferencePeriod	(string) Training Reference Period.
trainingType	(string) Training Type.
trainingSchedule	(string) Training Schedule.

The following elements are optional:

workLocation	(string) Work Location This is a query string parameter.
profession	(string) Profession This is a query string parameter.
professionalCategory	(string) Professional Category This is a query string parameter.
trainingEntity	(string) Training Entity This is a query string parameter.
evaluation	(string) Evaluation This is a query string parameter.
benefitAccountType	(string) Benefit Account Type This is a query string parameter.
company	(string) Company This is a query string parameter.
country	(string) Country This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See VocationalTrainingLine.

Response status codes:

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

Resource URL:

POST Operations

POST Batch Create Vocational Training

Instructs the 'VocationalTrainings' service to process the specified entity records.

The following elements are required:

list	(VocationalTrainingLine) List of the entity records that should be processed. See VocationalTrainingLine.
companyKey	(string) The company key.

Response:

When successful, the response body is empty. The URL of the processed items is returned in the response location header.

Response status codes:

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

Resource URL:

Resources

VocationalTrainingLine

The following elements are required:

selected

(bool) Selected.

The following elements are optional:

contract	(string) Contract.
employee	(string) Employee.
contractState	(enum ContractState) Contract State. See ContractState.
workLocation	(string) Work Location.
company	(string) Company.
evaluation	(string) Evaluation.

VocationalTrainingMain

The following elements are required:

selectedCount	(int) Selected Count.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
duration	(decimal) Duration (in hours).
trainingArea	(string) Training Area.
designation	(string) Designation.
trainingInitiative	(string) Training Initiative.
trainingQualificationLevel	(string) Training Qualification Level.
trainingEntityType	(string) Training Entity Type.
certificationType	(string) Certification Type.
trainingReferencePeriod	(string) Training Reference Period.
trainingType	(string) Training Type.
trainingSchedule	(string) Training Schedule.

The following elements are optional:

workLocation	(string) Work Location.
profession	(string) Profession.
professionalCategory	(string) Professional Category.
trainingEntity	(string) Training Entity.
evaluation	(string) Evaluation.
benefitAccountType	(string) Benefit Account Type.
company	(string) Company.
country	(string) Country.