API

Human resource APIs

POST human-resources/work-allowances

Creates new work allowance

HTTP method POST
URI https://api.rambase.net/human-resources/work-allowances
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3719, version 10

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
<WorkAllowance>
2
     <Note
Note

Required/mandatory field

Note/comment of the work allowance

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

Required/mandatory field

Date of the work allowance.

>{Date}</Date>
4
     <TimeType>
5
          <TimeTypeId
TimeTypeId

Required/mandatory field

Time type identifier

Minimum value: 100000

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

This field is optional.

>
8
          <Hours
Hours

Total time, in hours, of the work allowance

Minimum value: 0

This field is optional.

>{Decimal}</Hours>
9
     </Total>
10
     <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
11
</WorkAllowance>
1
{
2
     "workAllowance": {
3
          "note
Note

Required/mandatory field

Note/comment of the work allowance

": "{String}",
4
          "date
Date

Required/mandatory field

Date of the work allowance.

": "{Date}",
5
          "timeType": {
6
               "timeTypeId
TimeTypeId

Required/mandatory field

Time type identifier

Minimum value: 100000

": "{Integer}"
7
          },
8
          "total
Total

This field is optional.

": {
9
               "hours
Hours

Total time, in hours, of the work allowance

Minimum value: 0

This field is optional.

": "{Decimal}"
10
          },
11
          "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
12
     }
13
}

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.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

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 101015 HTTP 404 Permission not found
Error 100481 HTTP 404 Time type not found
Error 100511 HTTP 400 Invalid date
Error 100537 HTTP 400 Could not find work arrangements for employee {0} on date {1}
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