Se describe la operación relacionada para la creación de ubicaciones de inventario.
Detalles de la petición:
- URL Base: {host}/AFLSAPI/
- URI: /api/inventory/location
-
Tipo: POST
- Encabezados requeridos:
- Content-Type: application/json
- X-Authorization: Bearer {Token}
Descripción de la URL
- {host}: Representa el dominio del ambiente en el que se encuentra la API.
- AFLSAPI/: Prefijo fijo de la API.
- Uri: Endpoint específico para la petición.
⚐ EJEMPLO URL:
https://{host}/AFLSAPI/api/inventory/location
Parámetros:
Nombre | Tipo de dato | Obligatorio | Descripción |
---|---|---|---|
addlAddressInfo | string | No | Información adicional de dirección |
address | string | No | Dirección de la sede (Obligatorio para LocationTypeId = 1) |
contactMail | string | No | Email de contacto |
contactName | string | No | Nombre de Contacto |
contactPhone | string | No | Teléfono de contacto |
description | string | Si | Descripción de la sede |
isActive | boolean | Si | Estado de la sede |
isDefault | boolean | Si | Sede por defecto |
latitude | number | No | Latitud de dirección de contacto (Obligatorio para LocationTypeId = 1) |
locationCategoryId | integer | Si | Id de la categoría Sede(1 - Edificio, 2 - Almacén, 3 - Bodega) Transporte(4 - Vehículo, 5 - Camión) |
locationTypeId | integer | Si | Id tipo de Ubicación (1 - Sede, 2 - Transporte) |
longitude | number | No | Longitud de dirección de contacto (Obligatorio para LocationTypeId = 1) |
name | string | Si | Nombre para LocationTypeId = 1 o Placa para LocationTypeId = 2 |
parentId | integer | Si | Verificar su uso siempre va en 4 |
Cuerpo de la petición:
La petición consiste de un objeto JSON. Ejemplo:
{
"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",
"isActive": true,
"isDefault": true,
"latitude": 4.69191580000000,
"locationCategoryId": 3,
"locationTypeId": 1,
"longitude": -74.07453940000000,
"name": "Sede Norte",
"parentId": 4
}
Respuesta:
Como respuesta se obtiene un objeto JSON, con la siguiente información:
{
"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
}
Mensajes de error:
Código | Estado HTTP | Mensaje de error |
---|---|---|
400 | BadRequest | Address is required. |
400 | BadRequest | Latitude is required. |
400 | BadRequest | Longitude is required. |
400 | BadRequest | Maxlength of Name exceeded. |
400 | BadRequest | LocationCategoryId invalid. |
400 | BadRequest | Address is not required. |
400 | BadRequest | AddlAddressInfo is not required. |
400 | BadRequest | Latitude is not required. |
400 | BadRequest | Longitude is not required. |
400 | BadRequest | Other location exist with the same name. |
400 | BadRequest | No information found. |
500 | Internal Server Error | FailureLogin |