...
| Warning | ||
|---|---|---|
| ||
Please read the API Usage Notice before implementing API consumption and notice the API have a connection timeout on 180 seconds. |
URLs
There are three main URLs to know when using Remoting Web Service:
...
Every entity in the System that can be created and managed through remoting API is called a RemotableEntity. Examples of such entities are User, Department, Position, Document, Candidate, Questionnaire etc. The base properties of RemotableEntity are as follows:
| Property | Type | Description |
|---|---|---|
| Id | RemotableId | Id of the entity (se next session) |
| ParentDepartmentId | RemoteableId | Id of the department where the entity belongs |
| Title | String | Title, name, text or value of the entity |
Remotable Id
Each RemotableEntity has ability to store two different ids – one System id and one third-party id. The API functions requiring a RemotableId expect one or both of these ids, depending on the API function. The base properties of RemotableId are as follows:
| Property | Type | Description |
|---|---|---|
| Id | T | The unique id of the entity in the system. This id can be a String, Integer, Long or some other data type. |
| ThirdPartyId | String | The unique id of the entity in the third party system |
Property Bag
As no two system are equal in terms of functionality or data they store, the System provides a way to store additional information from third party systems together with the entities. This information is stored in a PropertyBag of the entity. A property bag is a basic list of key-value pairs of strings.
...
A single Property in a PropertyBag consists of following properties.
| Property | Type | Description |
|---|---|---|
| Key | String | Identifying key of the property. The key must be unique within a single entity. |
| Value | String | Value of the property |
The Request Objects
Each request object in an API function inherits from an abstract class called RequestBase that defines base properties for each request regardless of API function. These properties are as follows:
| Property | Type | Description |
|---|---|---|
| CustomerId | Integer | System id of the Customer. Always the same for a given Customer. |
| DepartmentId | RemotableId | System or third party id of the department for which the API function is being called. |
| SystemLanguageType | Enumerator | Some of the properties in entities, such as dropdown items, store multi-lingual values. This property defines which language to use when reading/writing such properties in the corresponding API function.
|
| AuthenticationToken | String | The api key that is set in department settings in HRMTS |
| ReferenceToken | String | A unique token sent by the third party system with each API function request. The same token is returned to the third party system in the corresponding response. |
| IncludeDebugOverview | Boolean | A reserved flag to use in conjunction with HR Manager Support to debug various issues in API functions. |
The Response Objects
Each response object in an API function inherits from an abstract class called ResponseBase that defines base properties for each response regardless of API function. These properties are as follows:
| Property | Type | Description |
|---|---|---|
| TransactionStatus | TransactionStatus | A custom object representing the state of the transaction along with potential error/failure information. |
| SystemLanguageType | Enumerator | Some of the properties in entities, such as dropdown items, store multi-lingual values. This property defines which language to use when reading/writing such properties in the corresponding API function.
|
| ReferenceToken | String | The unique third party token sent with the corresponding request object. |
The List Request Objects
For API functions that returns lists, the request objects inherit from an abstract class called ListRequestBase that again inherits from RequestBase as described above. This class defines base properties that are unique for list operations regardless of API function. These properties are as follows:
| Property | Type | Description |
|---|---|---|
| LimitReturnedDataSizeToBytes | Long | Defines a limit in bytes for how much data to return in current transaction. Send 0 to get one complete list item.. |
| IncludeDetails | Boolean | Flag to include details of items being returned. This feature must be enabled in Customer configuration on the server to function. |
| ItemIdList | List<Integer> | List of System ids of items to fetch. This property is usually used in consecutive calls to fetch items that were not returned in the first or previous call. |
The List Response Objects
For API functions that returns lists, the response objects inherit from an abstract class called ListResponseBase that again inherits from ResponseBase as described above. This class defines base properties that are unique for list operations regardless of API function. These properties are as follows:
| Property | Type | Description |
|---|---|---|
| RemainingItemIdList | List<Integer> | List of System ids of items that matched the criteria, but were not returned in the current call. Pass this property to the same function call again to get these items. |