Number Range Resource¶

Get All Number Ranges¶

HTTP Request

GET /api/numberRanges

📋 Description: Retrieves a list of available number ranges, providing essential data for managing numerical identifiers within the application.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "entityType": "string",
    "prefix": "string",
    "rangeSeperator": "string",
    "rangeFrom": "string",
    "rangeTo": "string",
    "lastGenerated": "string",
    "isAvailable": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[NumberRangeDTO]	false	none	[Data transfer object representing a defined range of numerical values, utilized for validating input parameters and ensuring data integrity within business processes.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» entityType	string	false	none	Type of the entity
» prefix	string	false	none	Specifies the prefix used to categorize or identify a range of numerical values within the NumberRangeDTO schema.
» rangeSeperator	string	false	none	Specifies the character used to separate values within a defined numerical range, facilitating clear communication of range parameters in business applications.
» rangeFrom	string	false	none	Specifies the starting value of a numerical range, facilitating precise data filtering and analysis within the application.
» rangeTo	string	false	none	Specifies the upper limit of the numerical range, facilitating precise data filtering and analysis within the system.
» lastGenerated	string	false	none	Timestamp indicating the last time a number range was generated, providing insight into the frequency of updates within the system.
» isAvailable	boolean	false	none	Whether the resource is available

Create Number Range¶

HTTP Request

POST /api/numberRanges

📋 Description: Creates a new number range entry in the system, enabling efficient management and allocation of numerical identifiers for various business processes.

Parameters

Name	In	Type	Required	Description
body	body	NumberRangeDTO	true	Request body containing the numerical range specifications, including start and end values, for effective data segmentation and analysis.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "entityType": "string",
  "prefix": "string",
  "rangeSeperator": "string",
  "rangeFrom": "string",
  "rangeTo": "string",
  "lastGenerated": "string",
  "isAvailable": true
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses

Update Number Range¶

HTTP Request

POST /api/numberRanges/{id}

📋 Description: Creates or updates a number range identified by the specified ID, allowing for efficient management of numerical data within the application.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	NumberRangeDTO	true	Request body containing the updated number range details, including the range values and associated metadata for effective data management.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "entityType": "string",
  "prefix": "string",
  "rangeSeperator": "string",
  "rangeFrom": "string",
  "rangeTo": "string",
  "lastGenerated": "string",
  "isAvailable": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Find All Entity Types¶

HTTP Request

GET /api/numberRanges/entityTypes

📋 Description: Retrieves a list of available entity types for number ranges, enabling users to effectively manage and categorize their data within the application.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "ASSET"
]