API

Production APIs

POST production/working-time-templates/{workingTimeTemplateId}/working-times

Create new production working time

HTTP method POST
URI https://api.rambase.net/production/working-time-templates/{workingTimeTemplateId}/working-times
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workingTimeTemplateId} Production working time template identification number
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6045, version 5

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
<WorkingTime>
2
     <Weekday
Weekday

Required/mandatory field

Day of week.

Applicable domain values can be found here

>{Integer}</Weekday>
3
     <StartTime
StartTime

Required/mandatory field

Starttime for the working hours. Format: 07:00.

>{Time}</StartTime>
4
     <EndTime
EndTime

Required/mandatory field

Endtime for the working hours. Format: 07:00.

>{Time}</EndTime>
5
     <ProductionResourcePlanningFactor
ProductionResourcePlanningFactor

Utilization factor. Hours is multiplied with this to get the shift capacity.

Minimum value: 1

This field is optional.

>{Integer}</ProductionResourcePlanningFactor>
6
</WorkingTime>
1
{
2
     "workingTime": {
3
          "weekday
Weekday

Required/mandatory field

Day of week.

Applicable domain values can be found here

": "{Integer}",
4
          "startTime
StartTime

Required/mandatory field

Starttime for the working hours. Format: 07:00.

": "{Time}",
5
          "endTime
EndTime

Required/mandatory field

Endtime for the working hours. Format: 07:00.

": "{Time}",
6
          "productionResourcePlanningFactor
ProductionResourcePlanningFactor

Utilization factor. Hours is multiplied with this to get the shift capacity.

Minimum value: 1

This field is optional.

": "{Integer}"
7
     }
8
}

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

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
<WorkingTime>
2
     <WorkingTimeId
WorkingTimeId

Working Time ID

>{Integer}</WorkingTimeId>
3
     <Weekday
Weekday

Day of week.

Possible domain values can be found here

>{Integer}</Weekday>
4
     <StartTime
StartTime

Starttime for the working hours. Format: 07:00.

>{Time}</StartTime>
5
     <EndTime
EndTime

Endtime for the working hours. Format: 07:00.

>{Time}</EndTime>
6
     <ProductionResourcePlanningFactor
ProductionResourcePlanningFactor

Utilization factor. Hours is multiplied with this to get the shift capacity.

>{Integer}</ProductionResourcePlanningFactor>
7
     <AddedAt
AddedAt

Date and time of creation

>{Datetime}</AddedAt>
8
</WorkingTime>
1
{
2
     "workingTime": {
3
          "workingTimeId
WorkingTimeId

Working Time ID

": "{Integer}",
4
          "weekday
Weekday

Day of week.

Possible domain values can be found here

": "{Integer}",
5
          "startTime
StartTime

Starttime for the working hours. Format: 07:00.

": "{Time}",
6
          "endTime
EndTime

Endtime for the working hours. Format: 07:00.

": "{Time}",
7
          "productionResourcePlanningFactor
ProductionResourcePlanningFactor

Utilization factor. Hours is multiplied with this to get the shift capacity.

": "{Integer}",
8
          "addedAt
AddedAt

Date and time of creation

": "{Datetime}"
9
     }
10
}

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 101551 HTTP 404 Object {0} not found
Error 108463 HTTP 400 You have tried to add a working time that overlaps with existing time span. You can’t add more than one time span for the same period.
Error 104613 HTTP 404 Working time element not found.