ROSEPEOPLE Developers - Web API Reference

People | Education Level

Service to manage entities of type 'EducationLevel'.

Overview


URL api/{tenantKey}/{orgKey}/peopleCore/educationLevels
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET EducationLevels

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /peopleCore/educationLevels

GET EducationLevels (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 EducationLevelResource.

Response status codes:

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

Resource URL:

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

GET EducationLevel 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 EducationLevelResource.

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 /peopleCore/educationLevels/{id}

GET EducationLevel by key

Returns the entity record that matches the specified key.

The following elements are required:

educationLevelKey (int) Education Level.

Response:

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

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 /peopleCore/educationLevels/{educationLevelKey}

GET Print EducationLevel 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:

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

GET Print EducationLevel by key

Prints the specified entity record.

The following elements are required:

educationLevelKey (int) Education Level.

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:

GET /peopleCore/educationLevels/{educationLevelKey}/print

GET Original Print EducationLevelOriginal 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:

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

GET Original Print EducationLevel by key

Prints the specified entity record.

The following elements are required:

educationLevelKey (int) Education Level.

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:

GET /peopleCore/educationLevels/{educationLevelKey}/printOriginal

Resources


EducationLevelResource

The following elements are required:

educationLevelKey (int) Education Level.
name (string) Name.