People | Vocational Training

Service to manage entities of type 'VocationalTraining'.

Overview

api/{tenantKey}/{orgKey}/people/vocationalTrainings

URL	api/{tenantKey}/{orgKey}/people/vocationalTrainings
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST VocationalTrainings
PUT:
DELETE:
- DELETE VocationalTraining by identifier
- DELETE VocationalTraining by key

All Resources

This service uses the following resources:

ApiVocationalTrainingResource
VocationalTrainingResource

GET Operations

GET VocationalTrainings

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/people/vocationalTrainings

GET /people/vocationalTrainings

GET VocationalTrainings (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 VocationalTrainingResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/people/vocationalTrainings?page={page}&pageSize={pageSize}

GET /people/vocationalTrainings?page={page}&pageSize={pageSize}

GET VocationalTraining 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 VocationalTrainingResource.

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}/people/vocationalTrainings/{id}

GET /people/vocationalTrainings/{id}

GET VocationalTraining by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
vocationalTrainingKey	(string) Vocational Training.

Response:

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

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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}

GET /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}

GET Print VocationalTraining 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}/people/vocationalTrainings/{id}/print?template={template}

GET /people/vocationalTrainings/{id}/print?template={template}

GET Print VocationalTraining by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
vocationalTrainingKey	(string) Vocational Training.

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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/print

GET /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/print

GET Original Print VocationalTrainingOriginal 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}/people/vocationalTrainings/{id}/printOriginal?template={template}

GET /people/vocationalTrainings/{id}/printOriginal?template={template}

GET Original Print VocationalTraining by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
vocationalTrainingKey	(string) Vocational Training.

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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/printOriginal

GET /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/printOriginal

POST Operations

POST VocationalTrainings

Creates a new entity record.

The following elements are required:

vocationalTrainingResource

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

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 ApiVocationalTrainingResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/people/vocationalTrainings

POST /people/vocationalTrainings

PUT Operations

PUT Set BenefitAccountType VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/benefitAccountType

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/benefitAccountType

PUT Set CertificationType VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/certificationType

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/certificationType

PUT Set Company VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/company

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/company

PUT Set Contract VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/contract

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/contract

PUT Set Designation VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/designation

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/designation

PUT Set Duration VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/duration

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/duration

PUT Set EndDate VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
value	(DateTime) 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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/endDate

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/endDate

PUT Set Evaluation VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/evaluation

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/evaluation

PUT Set IsActive VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/isActive

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/isActive

PUT Set IsEditable VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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.

Resource URL:

api/{tenantKey}/{orgKey}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/isEditable

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/isEditable

PUT Set StartDate VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
value	(DateTime) 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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/startDate

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/startDate

PUT Set TrainingArea VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingArea

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingArea

PUT Set TrainingEntity VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingEntity

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingEntity

PUT Set TrainingEntityType VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingEntityType

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingEntityType

PUT Set TrainingInitiative VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingInitiative

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingInitiative

PUT Set TrainingQualificationLevel VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingQualificationLevel

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingQualificationLevel

PUT Set TrainingReferencePeriod VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingReferencePeriod

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingReferencePeriod

PUT Set TrainingSchedule VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingSchedule

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingSchedule

PUT Set TrainingType VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingType

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/trainingType

PUT Set VocationalTrainingKey VocationalTraining

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

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
companyKey	(string) The company key.
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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/vocationalTrainingKey

PUT /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}/vocationalTrainingKey

DELETE Operations

DELETE VocationalTraining 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}/people/vocationalTrainings/{id}

DELETE /people/vocationalTrainings/{id}

DELETE VocationalTraining by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
vocationalTrainingKey	(string) Vocational Training.

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}/people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}

DELETE /people/vocationalTrainings/{companyKey}/{vocationalTrainingKey}

Resources

ApiVocationalTrainingResource

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
contract	(string) Contract.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
duration	(decimal) Duration (in hours).
trainingSchedule	(string) Training Schedule.
designation	(string) Designation.
trainingArea	(string) Training Area.
trainingInitiative	(string) Training Initiative.
trainingQualificationLevel	(string) Training Qualification Level.
trainingEntityType	(string) Training Entity Type.
trainingReferencePeriod	(string) Training Reference Period.
company	(string) Company.
trainingType	(string) Training Type.
certificationType	(string) Certification Type.

The following elements are optional:

evaluation	(string) Evaluation.
benefitAccountType	(string) Benefit Account Type.
trainingEntity	(string) Training Entity.
isEditable	(bool) Is Editable.

VocationalTrainingResource

The following elements are required:

vocationalTrainingKey	(string) Vocational Training.
contract	(string) Contract. (fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
duration	(decimal) Duration (in hours).
trainingSchedule	(string) Training Schedule. (fk) Allowed value: the natural key of a record of type TrainingSchedule. These records are accessibly through the TrainingSchedules service.
designation	(string) Designation.
trainingArea	(string) Training Area. (fk) Allowed value: the natural key of a record of type TrainingArea. These records are accessibly through the TrainingAreas service.
trainingInitiative	(string) Training Initiative. (fk) Allowed value: the natural key of a record of type TrainingInitiative. These records are accessibly through the TrainingInitiatives service.
trainingQualificationLevel	(string) Training Qualification Level. (fk) Allowed value: the natural key of a record of type TrainingQualificationLevel. These records are accessibly through the TrainingQualificationLevels service.
trainingEntityType	(string) Training Entity Type. (fk) Allowed value: the natural key of a record of type TrainingEntity. These records are accessibly through the TrainingEntities service.
trainingReferencePeriod	(string) Training Reference Period. (fk) Allowed value: the natural key of a record of type TrainingReferencePeriod. These records are accessibly through the TrainingReferencePeriods service.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
trainingType	(string) Training Type. (fk) Allowed value: the natural key of a record of type TrainingType. These records are accessibly through the TrainingTypes service.
certificationType	(string) Certification Type. (fk) Allowed value: the natural key of a record of type CertificationType. These records are accessibly through the CertificationTypes service.

The following elements are optional:

employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
evaluation	(string) Evaluation.
benefitAccountType	(string) Benefit Account Type. (fk) Allowed value: the natural key of a record of type BenefitAccountType. These records are accessibly through the BenefitAccountTypes service.
trainingEntity	(string) Training Entity. (fk) Allowed value: the natural key of a record of type Party.
isEditable	(bool) Is Editable.