System APIs
Add a new property to a custom number series
| HTTP method | POST |
| URI | https://api.rambase.net/system/custom-number-series/{customNumberSeriesId}/properties |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customNumberSeriesId} |
Unique identifier for a flexible number series
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 6114, version 5 |
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.
FieldType
Required/mandatory field
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
>{Integer}</FieldType>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>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>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>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>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>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>FieldType
Required/mandatory field
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
": "{Integer}",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}",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}",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}",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}",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}",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}"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.
PropertyId
Unique identifier for a flexible numbers series property
>{Integer}</PropertyId>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
- ...
Possible domain values can be found here
>{Integer}</FieldType>Filler
If you have set a length of a field this is the value that will be used to fill the space.
>{Integer}</Filler>Length
This is the length of the field type if it should have a fixed length. Alignment will always be set to right side,
>{Integer}</Length>Priority
Order of the added fields so that the flexible number series is built in the correct order.
>{Integer}</Priority>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
>{Integer}</StartingNumber>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
Possible domain values can be found here
>{Integer}</ResetPeriod>Value
The various fieldtypes can have different values that are stored here.
Could be a fixed text, number or macro.
PropertyId
Unique identifier for a flexible numbers series property
": "{Integer}",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
- ...
Possible domain values can be found here
": "{Integer}",Filler
If you have set a length of a field this is the value that will be used to fill the space.
": "{Integer}",Length
This is the length of the field type if it should have a fixed length. Alignment will always be set to right side,
": "{Integer}",Priority
Order of the added fields so that the flexible number series is built in the correct order.
": "{Integer}",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
": "{Integer}",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
Possible domain values can be found here
": "{Integer}",Value
The various fieldtypes can have different values that are stored here.
Could be a fixed text, number or macro.
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 |