People | Profession

Service to manage entities of type 'Profession'.

Overview

api/{tenantKey}/{orgKey}/peopleCore/professions

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Professions
PUT:
DELETE:
- DELETE Profession by identifier
- DELETE Profession by key

All Resources

This service uses the following resources:

ApiProfessionResource
ProfessionResource

GET Operations

GET Professions

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/professions

GET /peopleCore/professions

GET Professions (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 ProfessionResource.

Response status codes:

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

Resource URL:

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

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

GET Profession 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 ProfessionResource.

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

GET /peopleCore/professions/{id}

GET Profession by key

Returns the entity record that matches the specified key.

The following elements are required:

professionKey

(string) Profession.

Response:

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

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/professions/{professionKey}

GET /peopleCore/professions/{professionKey}

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

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

GET Print Profession by key

Prints the specified entity record.

The following elements are required:

professionKey

(string) Profession.

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/professions/{professionKey}/print

GET /peopleCore/professions/{professionKey}/print

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

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

GET Original Print Profession by key

Prints the specified entity record.

The following elements are required:

professionKey

(string) Profession.

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/professions/{professionKey}/printOriginal

GET /peopleCore/professions/{professionKey}/printOriginal

POST Operations

POST Professions

Creates a new entity record.

The following elements are required:

professionResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/professions

POST /peopleCore/professions

PUT Operations

PUT Set IsActive Profession

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

The following elements are required:

professionKey	(string) Profession.
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/professions/{professionKey}/isActive

PUT /peopleCore/professions/{professionKey}/isActive

PUT Set IsImported Profession

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

The following elements are required:

professionKey	(string) Profession.
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/professions/{professionKey}/isImported

PUT /peopleCore/professions/{professionKey}/isImported

PUT Set Name Profession

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

The following elements are required:

professionKey	(string) Profession.
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/professions/{professionKey}/name

PUT /peopleCore/professions/{professionKey}/name

PUT Set ProfessionKey Profession

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

The following elements are required:

professionKey	(string) Profession.
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/professions/{professionKey}/professionKey

PUT /peopleCore/professions/{professionKey}/professionKey

DELETE Operations

DELETE Profession 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/professions/{id}

DELETE /peopleCore/professions/{id}

DELETE Profession by key

Deletes the entity record that matches the specified key.

The following elements are required:

professionKey

(string) Profession.

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/professions/{professionKey}

DELETE /peopleCore/professions/{professionKey}

Resources

ApiProfessionResource

The following elements are required:

professionKey	(string) Profession.
isImported	(bool) Is Imported.

The following elements are optional:

name	(string) Name.

ProfessionResource

The following elements are required:

professionKey	(string) Profession.
isImported	(bool) Is Imported.

The following elements are optional:

name	(string) Name.