People | Education

Service to manage entities of type 'Education'.

Overview

api/{tenantKey}/{orgKey}/peopleCore/educations

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Educations
PUT:
DELETE:
- DELETE Education by identifier
- DELETE Education by key

All Resources

This service uses the following resources:

ApiEducationResource
EducationResource

GET Operations

GET Educations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/educations

GET /peopleCore/educations

GET Educations (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 EducationResource.

Response status codes:

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

Resource URL:

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

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

GET Education 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 EducationResource.

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

GET /peopleCore/educations/{id}

GET Education by key

Returns the entity record that matches the specified key.

The following elements are required:

educationKey

(string) Education.

Response:

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

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/educations/{educationKey}

GET /peopleCore/educations/{educationKey}

GET Print Education 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/educations/{id}/print?template={template}

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

GET Print Education by key

Prints the specified entity record.

The following elements are required:

educationKey

(string) Education.

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/educations/{educationKey}/print

GET /peopleCore/educations/{educationKey}/print

GET Original Print EducationOriginal 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/educations/{id}/printOriginal?template={template}

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

GET Original Print Education by key

Prints the specified entity record.

The following elements are required:

educationKey

(string) Education.

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/educations/{educationKey}/printOriginal

GET /peopleCore/educations/{educationKey}/printOriginal

POST Operations

POST Educations

Creates a new entity record.

The following elements are required:

educationResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/educations

POST /peopleCore/educations

PUT Operations

PUT Set Country Education

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

The following elements are required:

educationKey	(string) Education.
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/educations/{educationKey}/country

PUT /peopleCore/educations/{educationKey}/country

PUT Set EducationKey Education

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

The following elements are required:

educationKey	(string) Education.
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/educations/{educationKey}/educationKey

PUT /peopleCore/educations/{educationKey}/educationKey

PUT Set EducationLevel Education

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

The following elements are required:

educationKey	(string) Education.
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/educations/{educationKey}/educationLevel

PUT /peopleCore/educations/{educationKey}/educationLevel

PUT Set IsActive Education

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

The following elements are required:

educationKey	(string) Education.
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/educations/{educationKey}/isActive

PUT /peopleCore/educations/{educationKey}/isActive

PUT Set IsImported Education

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

The following elements are required:

educationKey	(string) Education.
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}/peopleCore/educations/{educationKey}/isImported

PUT /peopleCore/educations/{educationKey}/isImported

PUT Set Name Education

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

The following elements are required:

educationKey	(string) Education.
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/educations/{educationKey}/name

PUT /peopleCore/educations/{educationKey}/name

DELETE Operations

DELETE Education 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/educations/{id}

DELETE /peopleCore/educations/{id}

DELETE Education by key

Deletes the entity record that matches the specified key.

The following elements are required:

educationKey

(string) Education.

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/educations/{educationKey}

DELETE /peopleCore/educations/{educationKey}

Resources

ApiEducationResource

The following elements are required:

educationKey	(string) Education.
name	(string) Name.
country	(string) Country.
educationLevel	(string) Education Level.
isImported	(bool) Is Imported.

EducationResource

The following elements are required:

educationKey	(string) Education.
name	(string) Name.
country	(string) Country. (fk) Allowed value: the natural key of a record of type Country.
educationLevel	(string) Education Level. (fk) Allowed value: the natural key of a record of type EducationLevel. These records are accessibly through the EducationLevels service.
isImported	(bool) Is Imported.