The related operation for the list of inventory locations is described.
Details of the request:
- Base URL: {host}/AFLSAPI/
- URI: /api/inventory/location/list/{OnlyActive}
-
Type: GET
-
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/location/list/{OnlyActive}
Parameters:
Name | Data type | Obligatory | Description |
---|---|---|---|
OnlyActive | Boolean | Yes | Active Locations Only |
Answer:
As an answer, a JSON object is obtained, with the following information:
[
{
"addlAddressInfo": "Piso 7",
"address": "Floresta Outlet, Carrera 69, Santa Rosa, 11121 Suba, Distrito Capital, Colombia",
"contactMail": "tati_4@pruebas.com",
"contactName": "PRUEBAS",
"contactPhone": "3016153272",
"description": "Sede Norte",
"id": 1,
"isActive": true,
"isDefault": true,
"latitude": 4.69191580000000,
"locationCategoryId": 3,
"locationTypeId": 1,
"longitude": -74.07453940000000,
"name": "Sede Norte",
"parentId": 4
}
]
Error messages:
Code | HTTP status | Error Message |
---|---|---|
400 | BadRequest | No information found. |
500 | Internal Server Error | FailureLogin |