GET Next Number
The GET Next Number API allows you to get a next up number from a given sequence counter.
This API is broken down into two lgfapi operations:
- A detail operation where the sequence counter's id is already know and is provided in the URL.
- A list operations where a series of filters are provided in the "parameters" section of the request body to find the sequence
URL Signature
Detail lookup when id is already known:
POST
/entity/seq_counter/{id}/get_next_number
List search by filters:
POST /entity/seq_counter/get_next_number
Request Body
- Both URLs support the "count" option.
Section | Name | Required | Type | Default | Comments |
---|---|---|---|---|---|
options | count | integer | 1 | Count of next up numbers to be returned. Max value of 1000. |
{
"options": {
"count": 2
}
}
Available Filters
When filtering is required, a combination of the following may be used to determine the sequence counter.
- facility_id
- Allows for filtering on fields like "code"
- company_id
- Allows for filtering on fields like "code"
- counter_code
- sub_code
- destination_company_id
- Allows for filtering on fields like "code"
- destination_facility_id
- Allows for filtering on fields like "code"
{
"parameters": {
"facility_id": 1,
"company_id__code": "ABC",
"counter_code": "OBLPN"
}
}