API

System APIs

POST system/custom-number-series

Creates a new custom number series

HTTP method POST
URI https://api.rambase.net/system/custom-number-series
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 6006, 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
<CustomNumberSerie>
2
     <ObjectType
ObjectType

Required/mandatory field

The document type like COA, CIN, ...

>{String}</ObjectType>
3
     <DocumentType
DocumentType

The sub document type like RENTAL, PRODUCTION, ...

This field is optional.

>{String}</DocumentType>
4
     <ValidFrom
ValidFrom

This is the data the number series should be running from

This field is optional.

>{Date}</ValidFrom>
5
</CustomNumberSerie>
1
{
2
     "customNumberSerie": {
3
          "objectType
ObjectType

Required/mandatory field

The document type like COA, CIN, ...

": "{String}",
4
          "documentType
DocumentType

The sub document type like RENTAL, PRODUCTION, ...

This field is optional.

": "{String}",
5
          "validFrom
ValidFrom

This is the data the number series should be running from

This field is optional.

": "{Date}"
6
     }
7
}

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
<CustomNumberSerie>
2
     <CustomNumberSeriesId
CustomNumberSeriesId

Unique identifier for a flexible number series

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

Status of a file type is edit, waiting for activation, active and deactivated/finished.

Possible domain values can be found here

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

The document type like COA, CIN, ...

>{String}</ObjectType>
5
     <DocumentType
DocumentType

The sub document type like RENTAL, PRODUCTION, ...

>{String}</DocumentType>
6
     <CurrentCustomNumber
CurrentCustomNumber

The latest genereted number series for the given Object type and Document type

>{String}</CurrentCustomNumber>
7
     <ValidFrom
ValidFrom

This is the data the number series should be running from

>{Date}</ValidFrom>
8
     <CreatedAt
CreatedAt

Time and date when the flexible number series was first defined

>{Datetime}</CreatedAt>
9
</CustomNumberSerie>
1
{
2
     "customNumberSerie": {
3
          "customNumberSeriesId
CustomNumberSeriesId

Unique identifier for a flexible number series

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

Status of a file type is edit, waiting for activation, active and deactivated/finished.

Possible domain values can be found here

": "{Integer}",
5
          "objectType
ObjectType

The document type like COA, CIN, ...

": "{String}",
6
          "documentType
DocumentType

The sub document type like RENTAL, PRODUCTION, ...

": "{String}",
7
          "currentCustomNumber
CurrentCustomNumber

The latest genereted number series for the given Object type and Document type

": "{String}",
8
          "validFrom
ValidFrom

This is the data the number series should be running from

": "{Date}",
9
          "createdAt
CreatedAt

Time and date when the flexible number series was first defined

": "{Datetime}"
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 100138 HTTP 400 Only the operators NE and EQ can be used on Values containing a comma list or wildcards ( ?, * )
Error 102063 HTTP 400 Wildcard compare does not support both ? and *
Error 102064 HTTP 400 Wildcard compare does not support more than two asterisks (*)