The related operation for the list of inventory measures is described.
Details of the request:
- Base URL: {host}/AFLSAPI/
- URI: /api/inventory/measure/list
-
Type: POST
-
Required headings:
- Content-Type: application/json
- X-Authorization: Bearer {Token}
URL Description
- {host}: It represents the domain of the environment in which the API is located.
- AFLSAPI/: Fixed API prefix.
- URI: Specific endpoint for the request.
⚐ EXAMPLE URL:
https://{host}/AFLSAPI/api/inventory/measure/list
Parameters:
Name | Data type | Obligatory | Description |
---|---|---|---|
isActive | Boolean | Yes | Active Measures Only |
providerId | Integer | No | Supplier to consult |
Word | String | Yes | String to be filtered minimum 3 characters |
page | Integer | Yes | Page number to return |
Rows | Integer | Yes | Number of records per page to be returned |
Body of the petition:
The request consists of a JSON object. Example:
{
"isActive": true,
"providerId": 0,
"word": "Metros",
"page": 1,
"rows": 10
}
Answer:
As an answer, a JSON object is obtained, with the following information:
[
{
"description": "Metros",
"isActive": true,
"name": "Metros",
"uniqueCode": 1
}
]
Error messages:
Code | HTTP status | Error Message |
---|---|---|
400 | BadRequest | No information found. |
500 | Internal Server Error | FailureLogin |