API

Production APIs

POST production/resources/{productionResourceId}/restricted-stock-locations

Creates new restricted stock location

HTTP method POST
URI https://api.rambase.net/production/resources/{productionResourceId}/restricted-stock-locations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionResourceId} Production resource identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3471, version 9

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
<RestrictedStockLocation>
2
     <StockLocation>
3
          <StockLocationId
StockLocationId

Required/mandatory field

Stock location identifier

Minimum value: 100000

>{Integer}</StockLocationId>
4
     </StockLocation>
5
</RestrictedStockLocation>
1
{
2
     "restrictedStockLocation": {
3
          "stockLocation": {
4
               "stockLocationId
StockLocationId

Required/mandatory field

Stock location identifier

Minimum value: 100000

": "{Integer}"
5
          }
6
     }
7
}

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
<RestrictedStockLocation>
2
     <RestrictedStockLocationId
RestrictedStockLocationId

Production resource restricted stock location item identifier

>{Integer}</RestrictedStockLocationId>
3
     <Status
Status

Status of the resticted stock location

Possible domain values can be found here

>{Integer}</Status>
4
     <AddedAt
AddedAt

Production resource restricted stock location creation date

>{Datetime}</AddedAt>
5
     <StockLocation>
6
          <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
7
          <Name
Name

Name of stock location

>{String}</Name>
8
          <Label
Label

Name of current- and parent stock locations, including seperator for location

>{String}</Label>
9
          <Description
Description

Description of stock location

>{String}</Description>
10
          <Location>
11
               <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
12
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
13
          </Location>
14
          <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
15
     </StockLocation>
16
     <AddedBy>
17
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
18
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
19
     </AddedBy>
20
</RestrictedStockLocation>
1
{
2
     "restrictedStockLocation": {
3
          "restrictedStockLocationId
RestrictedStockLocationId

Production resource restricted stock location item identifier

": "{Integer}",
4
          "status
Status

Status of the resticted stock location

Possible domain values can be found here

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

Production resource restricted stock location creation date

": "{Datetime}",
6
          "stockLocation": {
7
               "stockLocationId
StockLocationId

Stock location identifier

": "{Integer}",
8
               "name
Name

Name of stock location

": "{String}",
9
               "label
Label

Name of current- and parent stock locations, including seperator for location

": "{String}",
10
               "description
Description

Description of stock location

": "{String}",
11
               "location": {
12
                    "locationId
LocationId

Location identifier

": "{Integer}",
13
                    "locationLink
LocationLink

Location reference

": "{String}"
14
               },
15
               "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
16
          },
17
          "addedBy": {
18
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
19
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
20
          }
21
     }
22
}

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 101278 HTTP 404 Stock location not found
Error 104292 HTTP 400 Restricted stock location already exists