API

Production APIs

POST production/serial-number-templates/{serialNumberTemplateId}/applied-products

Applies serial number template to provided product

HTTP method POST
URI https://api.rambase.net/production/serial-number-templates/{serialNumberTemplateId}/applied-products
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {serialNumberTemplateId} Serial number template identifer
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3430, version 3

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
<AppliedProduct>
2
     <ProductStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

This field is optional.

>
{String}</ProductStructureRevision>
3
     <Product
Product

Required/mandatory field

This template is used by this product

>
4
          <ProductId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

>
{Integer}</ProductId>
5
     </Product>
6
</AppliedProduct>
1
{
2
     "appliedProduct": {
3
          "productStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

This field is optional.

":
"{String}",
4
          "product
Product

Required/mandatory field

This template is used by this product

":
{
5
               "productId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

":
"{Integer}"
6
          }
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.
$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
<AppliedProduct>
2
     <AppliedProductId
AppliedProductId

Serial number template product identifer.

>
{Integer}</AppliedProductId>
3
     <ProductStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>
{String}</ProductStructureRevision>
4
     <Product
Product

This template is used by this product

>
5
          <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
6
          <Name
Name

Name of the product

>
{String}</Name>
7
          <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
8
     </Product>
9
</AppliedProduct>
1
{
2
     "appliedProduct": {
3
          "appliedProductId
AppliedProductId

Serial number template product identifer.

":
"{Integer}",
4
          "productStructureRevision
ProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

":
"{String}",
5
          "product
Product

This template is used by this product

":
{
6
               "productId
ProductId

Product identifier

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

Name of the product

":
"{String}",
8
               "productLink
ProductLink

Product reference

":
"{String}"
9
          }
10
     }
11
}

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 104116 HTTP 404 Serialnumber template was not found.
Error 104208 HTTP 400 Serialnumber template product not found