API

System APIs

PUT system/custom-number-series/{customNumberSeriesId}/properties/{propertyId}

Property changes for a custom number series

HTTP method PUT
URI https://api.rambase.net/system/custom-number-series/{customNumberSeriesId}/properties/{propertyId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {customNumberSeriesId} Unique identifier for a flexible number series
Integer, minimum 100000
- URI parameter {propertyId} Unique identifier for a flexible numbers series property
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 6131, 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
<Property
Property

This field is optional.

>
2
     <FieldType
FieldType

The field type of the properties entry.

Fields can be one of these and more may be added later:
- NUMBER
- TEXT
- MACRO
- YEAR
- MONTH
- ...

Applicable domain values can be found here

This field is optional.

>{Integer}</FieldType>
3
     <Filler
Filler

If you have set a length of a field this is the value that will be used to fill the space.

This field is optional.

>{Integer}</Filler>
4
     <Length
Length

This is the length of the field type if it should have a fixed length. Alignment will always be set to right side,

Minimum value: 1

This field is optional.

>{Integer}</Length>
5
     <Priority
Priority

Order of the added fields so that the flexible number series is built in the correct order.

Minimum value: 1

This field is optional.

>{Integer}</Priority>
6
     <StartingNumber
StartingNumber

If the field type is NUMBER then this defines what the number will start on and it will always increase by 1 for each time a new flexible number series is added

Minimum value: 1

This field is optional.

>{Integer}</StartingNumber>
7
     <ResetPeriod
ResetPeriod

If a running number is added to the given flexible number series the valid period can be set if the number should be reset to the start number provided in the setup.
Empty = running number will never be reset
118604 = running number will be reset first time used every month
118605 = running number will be reset first time used every year

Applicable domain values can be found here

This field is optional.

>{Integer}</ResetPeriod>
8
     <Value
Value

The various fieldtypes can have different values that are stored here.
Could be a fixed text, number or macro.

This field is optional.

>{String}</Value>
9
</Property>
1
{
2
     "property
Property

This field is optional.

": {
3
          "fieldType
FieldType

The field type of the properties entry.

Fields can be one of these and more may be added later:
- NUMBER
- TEXT
- MACRO
- YEAR
- MONTH
- ...

Applicable domain values can be found here

This field is optional.

": "{Integer}",
4
          "filler
Filler

If you have set a length of a field this is the value that will be used to fill the space.

This field is optional.

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

This is the length of the field type if it should have a fixed length. Alignment will always be set to right side,

Minimum value: 1

This field is optional.

": "{Integer}",
6
          "priority
Priority

Order of the added fields so that the flexible number series is built in the correct order.

Minimum value: 1

This field is optional.

": "{Integer}",
7
          "startingNumber
StartingNumber

If the field type is NUMBER then this defines what the number will start on and it will always increase by 1 for each time a new flexible number series is added

Minimum value: 1

This field is optional.

": "{Integer}",
8
          "resetPeriod
ResetPeriod

If a running number is added to the given flexible number series the valid period can be set if the number should be reset to the start number provided in the setup.
Empty = running number will never be reset
118604 = running number will be reset first time used every month
118605 = running number will be reset first time used every year

Applicable domain values can be found here

This field is optional.

": "{Integer}",
9
          "value
Value

The various fieldtypes can have different values that are stored here.
Could be a fixed text, number or macro.

This field is optional.

": "{String}"
10
     }
11
}

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.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

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 108412 HTTP 400 Number series not found