API

Human resource APIs

PUT human-resources/work-days/{workDayId}/periods/{workPeriodId}

Saves information about the work period. If end time goes over midnight period will be split.

HTTP method PUT
URI https://api.rambase.net/human-resources/work-days/{workDayId}/periods/{workPeriodId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workDayId} Workday identifier
Integer, minimum 100000
- URI parameter {workPeriodId} Work period identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3706, version 8

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
<WorkPeriod
WorkPeriod

This field is optional.

>
2
     <Note
Note

Note/comment of the work period, allowance or adjustment

This field is optional.

>{String}</Note>
3
     <IsIn
IsIn

Type of work period, allowance or adjustment.

This field is optional.

>{Boolean}</IsIn>
4
     <TimeType
TimeType

This field is optional.

>
5
          <TimeTypeId
TimeTypeId

Time type identifier

Minimum value: 100000

This field is optional.

>{Integer}</TimeTypeId>
6
     </TimeType>
7
     <Start
Start

This field is optional.

>
8
          <Time
Time

Start time of work period or allowance

This field is optional.

>{Time}</Time>
9
          <Site
Site

Site at start time of work period

Applicable domain values can be found here

This field is optional.

>{String}</Site>
10
     </Start>
11
     <End
End

This field is optional.

>
12
          <Time
Time

End time of work period or allowance

This field is optional.

>{Time}</Time>
13
          <Site
Site

Site at end time of work period

Applicable domain values can be found here

This field is optional.

>{String}</Site>
14
     </End>
15
     <ShortTermAbsence
ShortTermAbsence

This field is optional.

>
16
          <ShortTermAbsenceId
ShortTermAbsenceId

Short-term absence identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShortTermAbsenceId>
17
     </ShortTermAbsence>
18
</WorkPeriod>
1
{
2
     "workPeriod
WorkPeriod

This field is optional.

": {
3
          "note
Note

Note/comment of the work period, allowance or adjustment

This field is optional.

": "{String}",
4
          "isIn
IsIn

Type of work period, allowance or adjustment.

This field is optional.

": "{Boolean}",
5
          "timeType
TimeType

This field is optional.

": {
6
               "timeTypeId
TimeTypeId

Time type identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
7
          },
8
          "start
Start

This field is optional.

": {
9
               "time
Time

Start time of work period or allowance

This field is optional.

": "{Time}",
10
               "site
Site

Site at start time of work period

Applicable domain values can be found here

This field is optional.

": "{String}"
11
          },
12
          "end
End

This field is optional.

": {
13
               "time
Time

End time of work period or allowance

This field is optional.

": "{Time}",
14
               "site
Site

Site at end time of work period

Applicable domain values can be found here

This field is optional.

": "{String}"
15
          },
16
          "shortTermAbsence
ShortTermAbsence

This field is optional.

": {
17
               "shortTermAbsenceId
ShortTermAbsenceId

Short-term absence identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
18
          }
19
     }
20
}

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.

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

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

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

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
1

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 100087 HTTP 404 User not found
Error 100481 HTTP 404 Time type not found
Error 100511 HTTP 400 Invalid date
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 104731 HTTP 400 Please enter a note
Error 104753 HTTP 400 Please enter a note with at least 3 characters
Error 104754 HTTP 400 Please remove sick leave certificate from period before changing timetype
Error 107741 HTTP 400 A short-term absence period can not be more than {0} hours