People | Promotion

Service to manage entities of type 'Promotion'.

Overview

api/{tenantKey}/{orgKey}/peopleCore/promotions

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Promotions
PUT:
DELETE:
- DELETE Promotion by identifier
- DELETE Promotion by key

All Resources

This service uses the following resources:

ApiPromotionResource
PromotionResource

All Enumerations

This service uses the following enumerations:

PromotionReason

GET Operations

GET Promotions

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/promotions

GET /peopleCore/promotions

GET Promotions (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 PromotionResource.

Response status codes:

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

Resource URL:

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

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

GET Promotion 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 PromotionResource.

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

GET /peopleCore/promotions/{id}

GET Promotion by key

Returns the entity record that matches the specified key.

The following elements are required:

promotionKey

(string) Promotion.

Response:

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

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/promotions/{promotionKey}

GET /peopleCore/promotions/{promotionKey}

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

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

GET Print Promotion by key

Prints the specified entity record.

The following elements are required:

promotionKey

(string) Promotion.

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/promotions/{promotionKey}/print

GET /peopleCore/promotions/{promotionKey}/print

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

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

GET Original Print Promotion by key

Prints the specified entity record.

The following elements are required:

promotionKey

(string) Promotion.

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/promotions/{promotionKey}/printOriginal

GET /peopleCore/promotions/{promotionKey}/printOriginal

POST Operations

POST Promotions

Creates a new entity record.

The following elements are required:

promotionResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/promotions

POST /peopleCore/promotions

PUT Operations

PUT Set Career Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
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/promotions/{promotionKey}/career

PUT /peopleCore/promotions/{promotionKey}/career

PUT Set Date Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
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}/peopleCore/promotions/{promotionKey}/date

PUT /peopleCore/promotions/{promotionKey}/date

PUT Set IsActive Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
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/promotions/{promotionKey}/isActive

PUT /peopleCore/promotions/{promotionKey}/isActive

PUT Set JobGrade Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
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/promotions/{promotionKey}/jobGrade

PUT /peopleCore/promotions/{promotionKey}/jobGrade

PUT Set Position Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
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/promotions/{promotionKey}/position

PUT /peopleCore/promotions/{promotionKey}/position

PUT Set PromotionKey Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
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/promotions/{promotionKey}/promotionKey

PUT /peopleCore/promotions/{promotionKey}/promotionKey

PUT Set Reason Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
value	(enum PromotionReason) The request body should contain the new value for the attribute. See PromotionReason.

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/promotions/{promotionKey}/reason

PUT /peopleCore/promotions/{promotionKey}/reason

PUT Set Remark Promotion

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

The following elements are required:

promotionKey	(string) Promotion.
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/promotions/{promotionKey}/remark

PUT /peopleCore/promotions/{promotionKey}/remark

DELETE Operations

DELETE Promotion 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/promotions/{id}

DELETE /peopleCore/promotions/{id}

DELETE Promotion by key

Deletes the entity record that matches the specified key.

The following elements are required:

promotionKey

(string) Promotion.

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/promotions/{promotionKey}

DELETE /peopleCore/promotions/{promotionKey}

Resources

ApiPromotionResource

The following elements are required:

promotionKey	(string) Promotion.
employee	(string) Employee.

The following elements are optional:

date	(DateTime) Date.
career	(string) Career.
position	(string) Position.
jobGrade	(string) Job Grade.
reason	(enum PromotionReason) Reason. See PromotionReason.
remark	(string) Remark.

PromotionResource

The following elements are required:

promotionKey	(string) Promotion.
employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.

The following elements are optional:

date	(DateTime) Date.
career	(string) Career. (fk) Allowed value: the natural key of a record of type Career. These records are accessibly through the Careers service.
position	(string) Position. (fk) Allowed value: the natural key of a record of type Position. These records are accessibly through the Positions service.
jobGrade	(string) Job Grade. (fk) Allowed value: the natural key of a record of type JobGrade. These records are accessibly through the JobGrades service.
reason	(enum PromotionReason) Reason. See PromotionReason.
remark	(string) Remark.

Enumerations

PromotionReason

1	Seniority
2	Merit
3	Other