Human resource APIs
Work agreement details for provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/human-resources/work-agreements/{workAgreementId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {workAgreementId} |
Work agreement identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2071, 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.
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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
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.
WorkAgreementId
Work agreement identifier
>{Integer}</WorkAgreementId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of work agreement
>{String}</Name>Description
Description of work agreement
>{String}</Description>Group
The group to which the work scheme belongs
Possible domain values can be found here
>{Integer}</Group>IsApprovalRequired
Flag indicating whether work log entries using the WSR require approval by a manager
>{Boolean}</IsApprovalRequired>PaymentCategory
Payment category of the work schedule
Possible domain values can be found here
>{String}</PaymentCategory>WorkAgreementId
Work agreement identifier
": "{Integer}",Status
Status of work agreement
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of work agreement
": "{String}",Description
Description of work agreement
": "{String}",Group
The group to which the work scheme belongs
Possible domain values can be found here
": "{Integer}",IsApprovalRequired
Flag indicating whether work log entries using the WSR require approval by a manager
": "{Boolean}",PaymentCategory
Payment category of the work schedule
Possible domain values can be found here
": "{String}"
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 100009 HTTP 400 | Missing required input arguments |
| Error 100515 HTTP 404 | Work Scheme not found |