NumberingSequence

Retrieves the collection of NumberingSequenceOutput resources.

SecurityBearer
Request
query Parameters
sequenceName
string
sequenceName[]
Array of strings
year
integer
year[]
Array of integers
page
integer

The collection page number

Responses
200

NumberingSequenceOutput collection response

get/numbering-sequences
Request samples 
Response samples 
[
  • {
    }
]
Creates a NumberingSequence resource.
SecurityBearer 
Request 
Request Body schema: 
The new NumberingSequence resource


name
required
string
 
format
required
string
 
number
integer
 
Responses 
201
NumberingSequence resource created


400
Invalid input


404
Resource not found


post/numbering-sequences
Request samples 
{
  • "name": "string",
  • "format": "string",
  • "number": 0
}
Response samples 
{
  • "uuid": "string",
  • "name": "string",
  • "year": 0,
  • "format": "string",
  • "number": 0,
  • "last_date": "string",
  • "created_at": "string",
  • "updated_at": "string"
}
Get current numbering sequence.
Get the numbering sequence that is used now for the given sequence name.


SecurityBearer 
Request 
path Parameters
name
required
string
 
Responses 
200
The current numbering sequence.


404
No numbering sequence found.


get/numbering-sequences/current/{name}
Request samples 
Create or update the current numbering sequence.
Create or update the numbering sequence that is used now for the given sequence name.


SecurityBearer 
Request 
path Parameters
name
required
string
 
Request Body schema: 
The updated NumberingSequence resource


format
required
string
 
number
integer
 
Responses 
200
Numbering sequence created or updated.


400
Request is invalid.


put/numbering-sequences/current/{name}
Request samples 
{
  • "format": "string",
  • "number": 0
}
Retrieves a NumberingSequenceOutput resource.
SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
200
NumberingSequenceOutput resource response


404
Resource not found


get/numbering-sequences/{id}
Request samples 
Response samples 
{
  • "uuid": "string",
  • "name": "string",
  • "year": 0,
  • "format": "string",
  • "number": 0,
  • "last_date": "string",
  • "created_at": "string",
  • "updated_at": "string"
}
Replaces the NumberingSequence resource.
SecurityBearer 
Request 
path Parameters
id
required
string
 
Request Body schema: 
The updated NumberingSequence resource


format
required
string
 
number
integer
 
Responses 
200
NumberingSequence resource updated


400
Invalid input


404
Resource not found


put/numbering-sequences/{id}
Request samples 
{
  • "format": "string",
  • "number": 0
}
Response samples 
{
  • "uuid": "string",
  • "name": "string",
  • "year": 0,
  • "format": "string",
  • "number": 0,
  • "last_date": "string",
  • "created_at": "string",
  • "updated_at": "string"
}
Removes the NumberingSequence resource.
SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
204
NumberingSequence resource deleted


404
Resource not found


delete/numbering-sequences/{id}
Request samples