ROSEPEOPLE Developers - Web API Reference

Payroll | Work Location

Service to manage entities of type 'WorkLocation'.

Overview


URL api/{tenantKey}/{orgKey}/payrollCore/workLocations
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 WorkLocations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payrollCore/workLocations

GET WorkLocations (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 WorkLocationResource.

Response status codes:

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

Resource URL:

GET /payrollCore/workLocations?page={page}&pageSize={pageSize}

GET WorkLocation 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 WorkLocationResource.

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

GET WorkLocation by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workLocationKey (string) Work Location.

Response:

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

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 /payrollCore/workLocations/{companyKey}/{workLocationKey}

GET Print WorkLocation 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 /payrollCore/workLocations/{id}/print?template={template}

GET Print WorkLocation by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
workLocationKey (string) Work Location.

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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/print

GET Original Print WorkLocationOriginal 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 /payrollCore/workLocations/{id}/printOriginal?template={template}

GET Original Print WorkLocation by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
workLocationKey (string) Work Location.

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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/printOriginal

POST Operations

POST WorkLocations

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /payrollCore/workLocations

PUT Operations

PUT Set Address WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/address

PUT Set BuildingNumber WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/buildingNumber

PUT Set CityName WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/cityName

PUT Set Company WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/company

PUT Set Contact WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/contact

PUT Set ContactName WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/contactName

PUT Set ContactTitle WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/contactTitle

PUT Set Country WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/country

PUT Set ElectronicMail WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/electronicMail

PUT Set Fax WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/fax

PUT Set FormattedAddress WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/formattedAddress

PUT Set IsActive WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/isActive

PUT Set IsHeadQuarter WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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:

PUT /payrollCore/workLocations/{companyKey}/{workLocationKey}/isHeadQuarter

PUT Set Mobile WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/mobile

PUT Set Name WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/name

PUT Set PostalZone WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/postalZone

PUT Set StreetName WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/streetName

PUT Set Telephone WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/telephone

PUT Set WorkLocationKey WorkLocation

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

The following elements are required:

workLocationKey (string) Work Location.
companyKey (string) The company key.
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 /payrollCore/workLocations/{companyKey}/{workLocationKey}/workLocationKey

DELETE Operations

DELETE WorkLocation 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 /payrollCore/workLocations/{id}

DELETE WorkLocation by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workLocationKey (string) Work Location.

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 /payrollCore/workLocations/{companyKey}/{workLocationKey}

Resources


ApiWorkLocationResource

The following elements are required:

workLocationKey (string) Work Location.
country (string) Country.
streetName (string) Street Name.
buildingNumber (string) Building Number.
cityName (string) City Name.
postalZone (string) Postal Zone.
company (string) Company.
isHeadQuarter (bool) Is Headquarters.

The following elements are optional:

name (string) Name.
contactName (string) Contact Name.
contactTitle (string) Contact Title.
formattedAddress (string) Formatted Address.
address (string) Address.
electronicMail (string) Email.
fax (string) Fax.
telephone (string) Telephone.
mobile (string) Mobile.
contact (string) Contact.


WorkLocationResource

The following elements are required:

workLocationKey (string) Work Location.
country (string) Country.
(fk) Allowed value: the natural key of a record of type Country.
streetName (string) Street Name.
buildingNumber (string) Building Number.
cityName (string) City Name.
postalZone (string) Postal Zone.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company.
isHeadQuarter (bool) Is Headquarters.

The following elements are optional:

name (string) Name.
contactName (string) Contact Name.
contactTitle (string) Contact Title.
formattedAddress (string) Formatted Address.
address (string) Address.
(fk) Allowed value: the natural key of a record of type Address.
electronicMail (string) Email.
fax (string) Fax.
telephone (string) Telephone.
mobile (string) Mobile.
contact (string) Contact.
(fk) Allowed value: the natural key of a record of type Contact.