API

Production APIs

POST production/serial-number-templates/{serialNumberTemplateId}/elements

Create new element for serial number template

HTTP method POST
URI https://api.rambase.net/production/serial-number-templates/{serialNumberTemplateId}/elements
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 3348, version 6

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
<SerialNumberElement>
2
     <OrderIndex
OrderIndex

Required/mandatory field

Line number for the serial number template. Is used for ordering the lines when building the serial number template.

Minimum value: 1

>{Integer}</OrderIndex>
3
     <ContentType
ContentType

Required/mandatory field

Where this part of the serialno string should come from.

values:
'TEXT' - A fixed text
'DATEFORMAT' - (YY, WW, MM...) - (from current date)
'FIELD' - given field from Rambase e.g. Product.
'SEQUENCE' - a system managed counter

Applicable domain values can be found here

>{String}</ContentType>
4
     <Content
Content

Dependent of the value of CONTENTTYPE.

If 'TEXT' this is a static text.
If 'FIELD' one of a predefined list of fields where a value can come from e.g. Product.
If 'SEQUENCE' - not available.

This field is optional.

>{String}</Content>
5
     <Format
Format

If PWOPRODSTART is selected as content or DATEFORMAT is selected as content type, use format to format the date

Applicable domain values can be found here

This field is optional.

>{String}</Format>
6
     <HasSequenceDependence
HasSequenceDependence

Changes in this value will make the counter cycle back to its STARTWITH value.

Default value: False

This field is optional.

>{Boolean}</HasSequenceDependence>
7
     <Sequence
Sequence

This field is optional.

>
8
          <StartValue
StartValue

The start value if CONTENTTYPE = SEQUENCE.

Minimum value: 1

Default value: 1

This field is optional.

>{Integer}</StartValue>
9
          <Length
Length

Only used when contenttype = 'SEQUENCE'.
If > 0 means the sequence will have a fixed length , and filled from the left using the FILLER value.

Minimum value: 1

Maximum value: 50

This field is optional.

>{Integer}</Length>
10
          <FillerCharacter
FillerCharacter

the character filled in when this is a sequence with LENGTH field > 0. (Usually '0').

Minimum value: 1

Maximum value: 1

Default value: 0

This field is optional.

>{String}</FillerCharacter>
11
     </Sequence>
12
</SerialNumberElement>
1
{
2
     "serialNumberElement": {
3
          "orderIndex
OrderIndex

Required/mandatory field

Line number for the serial number template. Is used for ordering the lines when building the serial number template.

Minimum value: 1

": "{Integer}",
4
          "contentType
ContentType

Required/mandatory field

Where this part of the serialno string should come from.

values:
'TEXT' - A fixed text
'DATEFORMAT' - (YY, WW, MM...) - (from current date)
'FIELD' - given field from Rambase e.g. Product.
'SEQUENCE' - a system managed counter

Applicable domain values can be found here

": "{String}",
5
          "content
Content

Dependent of the value of CONTENTTYPE.

If 'TEXT' this is a static text.
If 'FIELD' one of a predefined list of fields where a value can come from e.g. Product.
If 'SEQUENCE' - not available.

This field is optional.

": "{String}",
6
          "format
Format

If PWOPRODSTART is selected as content or DATEFORMAT is selected as content type, use format to format the date

Applicable domain values can be found here

This field is optional.

": "{String}",
7
          "hasSequenceDependence
HasSequenceDependence

Changes in this value will make the counter cycle back to its STARTWITH value.

Default value: False

This field is optional.

": "{Boolean}",
8
          "sequence
Sequence

This field is optional.

": {
9
               "startValue
StartValue

The start value if CONTENTTYPE = SEQUENCE.

Minimum value: 1

Default value: 1

This field is optional.

": "{Integer}",
10
               "length
Length

Only used when contenttype = 'SEQUENCE'.
If > 0 means the sequence will have a fixed length , and filled from the left using the FILLER value.

Minimum value: 1

Maximum value: 50

This field is optional.

": "{Integer}",
11
               "fillerCharacter
FillerCharacter

the character filled in when this is a sequence with LENGTH field > 0. (Usually '0').

Minimum value: 1

Maximum value: 1

Default value: 0

This field is optional.

": "{String}"
12
          }
13
     }
14
}

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
<SerialNumberElement>
2
     <SerialNumberElementId
SerialNumberElementId

Serialnumber Template Element identifer.

>{Integer}</SerialNumberElementId>
3
     <OrderIndex
OrderIndex

Line number for the serial number template. Is used for ordering the lines when building the serial number template.

>{Integer}</OrderIndex>
4
     <Content
Content

Dependent of the value of CONTENTTYPE.

If 'TEXT' this is a static text.
If 'FIELD' one of a predefined list of fields where a value can come from e.g. Product.
If 'SEQUENCE' - not available.

>{String}</Content>
5
     <ContentType
ContentType

Where this part of the serialno string should come from.

values:
'TEXT' - A fixed text
'DATEFORMAT' - (YY, WW, MM...) - (from current date)
'FIELD' - given field from Rambase e.g. Product.
'SEQUENCE' - a system managed counter

Possible domain values can be found here

>{String}</ContentType>
6
     <Format
Format

If PWOPRODSTART is selected as content or DATEFORMAT is selected as content type, use format to format the date

Possible domain values can be found here

>{String}</Format>
7
     <HasSequenceDependence
HasSequenceDependence

Changes in this value will make the counter cycle back to its STARTWITH value.

>{Boolean}</HasSequenceDependence>
8
     <Sequence>
9
          <StartValue
StartValue

The start value if CONTENTTYPE = SEQUENCE.

>{Integer}</StartValue>
10
          <Length
Length

Only used when contenttype = 'SEQUENCE'.
If > 0 means the sequence will have a fixed length , and filled from the left using the FILLER value.

>{Integer}</Length>
11
          <FillerCharacter
FillerCharacter

the character filled in when this is a sequence with LENGTH field > 0. (Usually '0').

>{String}</FillerCharacter>
12
     </Sequence>
13
</SerialNumberElement>
1
{
2
     "serialNumberElement": {
3
          "serialNumberElementId
SerialNumberElementId

Serialnumber Template Element identifer.

": "{Integer}",
4
          "orderIndex
OrderIndex

Line number for the serial number template. Is used for ordering the lines when building the serial number template.

": "{Integer}",
5
          "content
Content

Dependent of the value of CONTENTTYPE.

If 'TEXT' this is a static text.
If 'FIELD' one of a predefined list of fields where a value can come from e.g. Product.
If 'SEQUENCE' - not available.

": "{String}",
6
          "contentType
ContentType

Where this part of the serialno string should come from.

values:
'TEXT' - A fixed text
'DATEFORMAT' - (YY, WW, MM...) - (from current date)
'FIELD' - given field from Rambase e.g. Product.
'SEQUENCE' - a system managed counter

Possible domain values can be found here

": "{String}",
7
          "format
Format

If PWOPRODSTART is selected as content or DATEFORMAT is selected as content type, use format to format the date

Possible domain values can be found here

": "{String}",
8
          "hasSequenceDependence
HasSequenceDependence

Changes in this value will make the counter cycle back to its STARTWITH value.

": "{Boolean}",
9
          "sequence": {
10
               "startValue
StartValue

The start value if CONTENTTYPE = SEQUENCE.

": "{Integer}",
11
               "length
Length

Only used when contenttype = 'SEQUENCE'.
If > 0 means the sequence will have a fixed length , and filled from the left using the FILLER value.

": "{Integer}",
12
               "fillerCharacter
FillerCharacter

the character filled in when this is a sequence with LENGTH field > 0. (Usually '0').

": "{String}"
13
          }
14
     }
15
}

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 103090 HTTP 400 Edit is only allowed in status 1
Error 104142 HTTP 400 Illegal Order Index.
Error 104143 HTTP 400 Illegal content type.
Error 104144 HTTP 400 Illegal CONTENT {0}
Error 108944 HTTP 400 Format can't be empty
Error 104145 HTTP 400 Illegal value sequence {0}.
Error 104169 HTTP 400 Several elements of contentype SEQUENCE not allowed.