API

Production APIs

POST production/product-marking-templates

Creates a new product marking template

HTTP method POST
URI https://api.rambase.net/production/product-marking-templates
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 5466, version 1

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
<ProductMarkingTemplate>
2
     <Name
Name

Required/mandatory field

Product marking template name

>
{String}</Name>
3
</ProductMarkingTemplate>
1
{
2
     "productMarkingTemplate": {
3
          "name
Name

Required/mandatory field

Product marking template name

":
"{String}"
4
     }
5
}

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
<ProductMarkingTemplate>
2
     <ProductMarkingTemplateId
ProductMarkingTemplateId

Product marking template identifier

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

Product marking template status

Possible domain values can be found here

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

Product marking template name

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

Product marking template description

>
{String}</Description>
6
     <Text
Text

Product marking template text. Type a number from 0 to 79 in curly brackets (e.g. {1}) to create an empty parameter, and then select its value from the list.

>
{String}</Text>
7
     <IsDefault
IsDefault

A flag to indicate if product marking template is default for all products

>
{Boolean}</IsDefault>
8
</ProductMarkingTemplate>
1
{
2
     "productMarkingTemplate": {
3
          "productMarkingTemplateId
ProductMarkingTemplateId

Product marking template identifier

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

Product marking template status

Possible domain values can be found here

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

Product marking template name

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

Product marking template description

":
"{String}",
7
          "text
Text

Product marking template text. Type a number from 0 to 79 in curly brackets (e.g. {1}) to create an empty parameter, and then select its value from the list.

":
"{String}",
8
          "isDefault
IsDefault

A flag to indicate if product marking template is default for all products

":
"{Boolean}"
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 107591 HTTP 400 Product marking template is deactivated
Error 107560 HTTP 400 Product marking template key cannot be empty
Error 107561 HTTP 400 Product marking template key already exists
Error 107575 HTTP 400 Parameter's content cannot be empty
Error 107576 HTTP 400 Invalid parameter's content {0}