API

Human resource APIs

GET human-resources/time-types

List of time types

HTTP method GET
URI https://api.rambase.net/human-resources/time-types
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 1812, version 14

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ForWorkAdjustments() Named filter Applicable for work adjustments
ForWorkAllowances() Named filter Applicable for work allowances
ForWorkPeriods() Named filter Applicable for work periods
Category Integer Category of the time type.
Description String Description of the time type.
InOut String Type/Direction of the time type. It can be either IN or OUT.
Overtime Integer Overtime percentage.
Status Integer Status of the time type.
TimeTypeId Integer Time type identifier.

Read more about filters and sorting on how to use sortable parameters

Category Integer Category of the time type
Description String Description of the time type
InOut String Type/Direction of the time type. It can be either IN or OUT
Overtime Integer Overtime percentage
Status Integer Status of the time type
TimeTypeId Integer Time type identifier

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<TimeTypes>
2
     <TimeType>
3
          <TimeTypeId
TimeTypeId

Time type identifier

>{Integer}</TimeTypeId>
4
          <Status
Status

Status of the time type

Possible domain values can be found here

>{Integer}</Status>
5
          <Category
Category

Category of the time type

Possible domain values can be found here

>{Integer}</Category>
6
          <Description
Description

Description of the time type

>{String}</Description>
7
          <InOut
InOut

Type/Direction of the time type. It can be either IN or OUT

Possible domain values can be found here

>{String}</InOut>
8
          <OvertimePercent
OvertimePercent

Overtime percentage

>{Integer}</OvertimePercent>
9
          <IsTimeEditable
IsTimeEditable

Saying whether the start/end times of the period can be modifed. This value can be changed according to the settings from SCV

>{Boolean}</IsTimeEditable>
10
          <PrefillNote
PrefillNote

Says whether note of the period can be populated automaticaly from time type description. Values are extracted from SCV

>{Boolean}</PrefillNote>
11
          <PrefillTime
PrefillTime

Says whether start/end times of the period can be populated automaticaly from scheduled work periods. Values are extracted from SCV

>{Boolean}</PrefillTime>
12
          <ExternalCodes
ExternalCodes

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

>
13
               <SalaryCodeForHourlyPaid
SalaryCodeForHourlyPaid

External salary code for hourly paid

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

>{String}</SalaryCodeForHourlyPaid>
14
               <SalaryCodeForMonthlyPaid
SalaryCodeForMonthlyPaid

External salary code for montly payments

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

>{String}</SalaryCodeForMonthlyPaid>
15
               <AbsenceCodeForHourlyPaid
AbsenceCodeForHourlyPaid

External absence code for hourly paid

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

>{String}</AbsenceCodeForHourlyPaid>
16
               <AbsenceCodeForMonthlyPaid
AbsenceCodeForMonthlyPaid

External absence code for monthly payments

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

>{String}</AbsenceCodeForMonthlyPaid>
17
          </ExternalCodes>
18
          <TimeTypeLink
TimeTypeLink

Reference to the time type

>{String}</TimeTypeLink>
19
     </TimeType>
20
     <Paging
Paging

Detailed paging information for this list.

>
21
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
22
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
23
          <Page
Page

Page index

>{Integer}</Page>
24
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
25
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
26
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
27
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
28
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
29
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
30
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
31
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
32
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
33
     </Paging>
34
</TimeTypes>
1
{
2
     "timeTypes": [
3
          {
4
               "timeTypeId
TimeTypeId

Time type identifier

": "{Integer}",
5
               "status
Status

Status of the time type

Possible domain values can be found here

": "{Integer}",
6
               "category
Category

Category of the time type

Possible domain values can be found here

": "{Integer}",
7
               "description
Description

Description of the time type

": "{String}",
8
               "inOut
InOut

Type/Direction of the time type. It can be either IN or OUT

Possible domain values can be found here

": "{String}",
9
               "overtimePercent
OvertimePercent

Overtime percentage

": "{Integer}",
10
               "isTimeEditable
IsTimeEditable

Saying whether the start/end times of the period can be modifed. This value can be changed according to the settings from SCV

": "{Boolean}",
11
               "prefillNote
PrefillNote

Says whether note of the period can be populated automaticaly from time type description. Values are extracted from SCV

": "{Boolean}",
12
               "prefillTime
PrefillTime

Says whether start/end times of the period can be populated automaticaly from scheduled work periods. Values are extracted from SCV

": "{Boolean}",
13
               "externalCodes
ExternalCodes

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

": {
14
                    "salaryCodeForHourlyPaid
SalaryCodeForHourlyPaid

External salary code for hourly paid

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

": "{String}",
15
                    "salaryCodeForMonthlyPaid
SalaryCodeForMonthlyPaid

External salary code for montly payments

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

": "{String}",
16
                    "absenceCodeForHourlyPaid
AbsenceCodeForHourlyPaid

External absence code for hourly paid

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

": "{String}",
17
                    "absenceCodeForMonthlyPaid
AbsenceCodeForMonthlyPaid

External absence code for monthly payments

This field is greyed out because it is an expandable field. You have to add $expand=TimeType.ExternalCodes in your request URI to get this field

": "{String}"
18
               },
19
               "timeTypeLink
TimeTypeLink

Reference to the time type

": "{String}"
20
          }
21
     ],
22
     "paging
Paging

Detailed paging information for this list.

": {
23
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
24
          "position
Position

Position of the first element in the list

": "{Integer}",
25
          "page
Page

Page index

": "{Integer}",
26
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
27
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
28
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
29
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
30
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
31
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
32
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
33
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
34
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
35
     }
36
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100136 HTTP 404 Settings and Configuration Values (SCV) with these parameters not found