ROSEPEOPLE Developers - Web API Reference

People | Professional Category

Service to manage entities of type 'ProfessionalCategory'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET ProfessionalCategories

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /peopleCore/professionalCategories

GET ProfessionalCategories (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 ProfessionalCategoryResource.

Response status codes:

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

Resource URL:

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

GET ProfessionalCategory 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 ProfessionalCategoryResource.

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

GET ProfessionalCategory by key

Returns the entity record that matches the specified key.

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.

Response:

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

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/professionalCategories/{professionalCategoryKey}/{country}

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

GET Print ProfessionalCategory by key

Prints the specified entity record.

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.

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/professionalCategories/{professionalCategoryKey}/{country}/print

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

GET Original Print ProfessionalCategory by key

Prints the specified entity record.

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.

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/professionalCategories/{professionalCategoryKey}/{country}/printOriginal

POST Operations

POST ProfessionalCategories

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /peopleCore/professionalCategories

PUT Operations

PUT Set Country ProfessionalCategory

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

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.
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:

PUT /peopleCore/professionalCategories/{professionalCategoryKey}/{country}/country

PUT Set IsActive ProfessionalCategory

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

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.
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:

PUT /peopleCore/professionalCategories/{professionalCategoryKey}/{country}/isActive

PUT Set Name ProfessionalCategory

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

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.
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:

PUT /peopleCore/professionalCategories/{professionalCategoryKey}/{country}/name

PUT Set ProfessionalCategoryKey ProfessionalCategory

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

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.
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:

PUT /peopleCore/professionalCategories/{professionalCategoryKey}/{country}/professionalCategoryKey

DELETE Operations

DELETE ProfessionalCategory 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:

DELETE /peopleCore/professionalCategories/{id}

DELETE ProfessionalCategory by key

Deletes the entity record that matches the specified key.

The following elements are required:

professionalCategoryKey (string) Professional Category.
country (string) Country.

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:

DELETE /peopleCore/professionalCategories/{professionalCategoryKey}/{country}

Resources


ApiProfessionalCategoryResource

The following elements are required:

professionalCategoryKey (string) Professional Category.
name (string) Name.
country (string) Country.


ProfessionalCategoryResource

The following elements are required:

professionalCategoryKey (string) Professional Category.
name (string) Name.
country (string) Country.
(fk) Allowed value: the natural key of a record of type Country.