ROSEPEOPLE Developers - Web API Reference

People | Training Type

Service to manage entities of type 'TrainingType'.

Overview


URL api/{tenantKey}/{orgKey}/people/trainingTypes
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET TrainingTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /people/trainingTypes

GET TrainingTypes (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 TrainingTypeResource.

Response status codes:

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

Resource URL:

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

GET TrainingType 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 TrainingTypeResource.

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:

GET /people/trainingTypes/{id}

GET TrainingType by key

Returns the entity record that matches the specified key.

The following elements are required:

code (string) Code.

Response:

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

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:

GET /people/trainingTypes/{code}

Resources


TrainingTypeResource

The following elements are required:

code (string) Code.
name (string) Name.