RamBase REST APIs
Saves information about the department
| HTTP method | PUT |
| URI | https://api.rambase.net/finance/departments/{departmentId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {departmentId} |
Department identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 3111, version 4 |
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.
Department
This field is optional.
>Name
Name of department
This field is optional.
>{String}</Name>Description
Description of department
This field is optional.
>{String}</Description>Validity
This field is optional.
>EffectivePeriod
Effective period of the department
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</EffectivePeriod>ExpirationPeriod
Expiration period of the department
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</ExpirationPeriod>Responsible
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Department
This field is optional.
": {Name
Name of department
This field is optional.
": "{String}",Description
Description of department
This field is optional.
": "{String}",Validity
This field is optional.
": {EffectivePeriod
Effective period of the department
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}",ExpirationPeriod
Expiration period of the department
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}"Responsible
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"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.
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 101079 HTTP 400 | Mismatch in size of revision parameters |
| Error 100613 HTTP 400 | Expiration period must be later than effective period |
| Error 103701 HTTP 400 | To period is not valid: {0} |
| Error 103703 HTTP 400 | To period is not valid. General ledger postings exists. |