API

Production APIs

POST production/manufacturing-material-locations

Creates new manufacturing material location

HTTP method POST
URI https://api.rambase.net/production/manufacturing-material-locations
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3798, 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.

Format:
1
<ManufacturingMaterialLocation>
2
     <Name
Name

Required/mandatory field

Manufacturing material location name

>{String}</Name>
3
     <Description
Description

Manufacturing material location description

This field is optional.

>{String}</Description>
4
     <IsExternal
IsExternal

Flag to indicate if manufacturing material location is an external location

Default value: False

This field is optional.

>{Boolean}</IsExternal>
5
     <ParentManufacturingMaterialLocation
ParentManufacturingMaterialLocation

This field is optional.

>
6
          <ManufacturingMaterialLocationId
ManufacturingMaterialLocationId

Reference to the level above this manufacturing material location. If empty then this is the top location.

Minimum value: 100000

This field is optional.

>{Integer}</ManufacturingMaterialLocationId>
7
     </ParentManufacturingMaterialLocation>
8
     <Location>
9
          <LocationId
LocationId

Required/mandatory field

Location identifier

Minimum value: 10000

>{Integer}</LocationId>
10
     </Location>
11
</ManufacturingMaterialLocation>
1
{
2
     "manufacturingMaterialLocation": {
3
          "name
Name

Required/mandatory field

Manufacturing material location name

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

Manufacturing material location description

This field is optional.

": "{String}",
5
          "isExternal
IsExternal

Flag to indicate if manufacturing material location is an external location

Default value: False

This field is optional.

": "{Boolean}",
6
          "parentManufacturingMaterialLocation
ParentManufacturingMaterialLocation

This field is optional.

": {
7
               "manufacturingMaterialLocationId
ManufacturingMaterialLocationId

Reference to the level above this manufacturing material location. If empty then this is the top location.

Minimum value: 100000

This field is optional.

": "{Integer}"
8
          },
9
          "location": {
10
               "locationId
LocationId

Required/mandatory field

Location identifier

Minimum value: 10000

": "{Integer}"
11
          }
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.
$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
<ManufacturingMaterialLocation>
2
     <ManufacturingMaterialLocationId
ManufacturingMaterialLocationId

Manufacturing material location identifier

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

Manufacturing material location status

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Manufacturing material location name

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

Unique name for the manufacturing material location. Built using name from this and levels above

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

Manufacturing material location description

>{String}</Description>
8
     <IsExternal
IsExternal

Flag to indicate if manufacturing material location is an external location

>{Boolean}</IsExternal>
9
     <TreeLevel
TreeLevel

Manufacturing material location's tree level

>{Integer}</TreeLevel>
10
     <ParentManufacturingMaterialLocation>
11
          <ManufacturingMaterialLocationId
ManufacturingMaterialLocationId

Reference to the level above this manufacturing material location. If empty then this is the top location.

>{Integer}</ManufacturingMaterialLocationId>
12
          <ManufacturingMaterialLocationLink
ManufacturingMaterialLocationLink

Manufacturing material location reference

>{String}</ManufacturingMaterialLocationLink>
13
     </ParentManufacturingMaterialLocation>
14
     <Location>
15
          <LocationId
LocationId

Location identifier

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

Location reference

>{String}</LocationLink>
17
          <ParentManufacturingMaterialLocation>
18
               <ManufacturingMaterialLocationId
ManufacturingMaterialLocationId

Manufacturing material location identifier

>{Integer}</ManufacturingMaterialLocationId>
19
               <Name
Name

Manufacturing material location name

>{String}</Name>
20
               <TreeLevel
TreeLevel

Manufacturing material location's tree level

>{Integer}</TreeLevel>
21
               <ManufacturingMaterialLocationLink
ManufacturingMaterialLocationLink

Manufacturing material location reference

>{String}</ManufacturingMaterialLocationLink>
22
          </ParentManufacturingMaterialLocation>
23
     </Location>
24
</ManufacturingMaterialLocation>
1
{
2
     "manufacturingMaterialLocation": {
3
          "manufacturingMaterialLocationId
ManufacturingMaterialLocationId

Manufacturing material location identifier

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

Manufacturing material location status

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Manufacturing material location name

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

Unique name for the manufacturing material location. Built using name from this and levels above

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

Manufacturing material location description

": "{String}",
9
          "isExternal
IsExternal

Flag to indicate if manufacturing material location is an external location

": "{Boolean}",
10
          "treeLevel
TreeLevel

Manufacturing material location's tree level

": "{Integer}",
11
          "parentManufacturingMaterialLocation": {
12
               "manufacturingMaterialLocationId
ManufacturingMaterialLocationId

Reference to the level above this manufacturing material location. If empty then this is the top location.

": "{Integer}",
13
               "manufacturingMaterialLocationLink
ManufacturingMaterialLocationLink

Manufacturing material location reference

": "{String}"
14
          },
15
          "location": {
16
               "locationId
LocationId

Location identifier

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

Location reference

": "{String}",
18
               "parentManufacturingMaterialLocation": {
19
                    "manufacturingMaterialLocationId
ManufacturingMaterialLocationId

Manufacturing material location identifier

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

Manufacturing material location name

": "{String}",
21
                    "treeLevel
TreeLevel

Manufacturing material location's tree level

": "{Integer}",
22
                    "manufacturingMaterialLocationLink
ManufacturingMaterialLocationLink

Manufacturing material location reference

": "{String}"
23
               }
24
          }
25
     }
26
}

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 105311 HTTP 400 Manufacturing material location's parent belongs to other location
Error 105318 HTTP 400 Parent manufacturing material location is not active
Error 105283 HTTP 400 Name of manufacturing material location cannot be empty
Error 105282 HTTP 400 Name of main manufacturing material location does not match the name of location
Error 105281 HTTP 400 Cannot change name of manufacturing material location when it has got children
Error 105339 HTTP 400 You cannot include separator in the name of manufacturing material location