Leer UID
Con esta función es posible llevar a cabo la lectura de los datos asociados a un contenedor específico identificado por su número de identificación única (UID).
URL
/CTNEAT/UID/READ/{tkn}
Método HTTP
GET
Parámetros de la solicitud
| Nombre del parámetro | Tipo de dato | Descripción del parámetro | Obligatorio | Posibles valores |
|---|---|---|---|---|
| UID | cadena | Código único del contenedor | No (Si el UID no se especifica, la API devolverá todos los UID del sistema) | Cualquiera |
| DATEOFRECEIPT | cadena | Fecha de recepción del UID | No (Si no se especifica, se leerán todos los UIDs. Si se especifica el valor, se mostrarán todos los registros entre la introducida y la actual. En cambio, si el valor introducido no se corresponde con el formato adecuado, no se realizará la búsqueda por fecha) | Cualquiera en formato YYYYMMDDHHMMSS |
Encabezados de la solicitud
| Nombre del encabezado | Descripción del encabezado | Obligatorio |
|---|
Cuerpo de la solicitud
No se requiere un cuerpo de solicitud para este método HTTP.
Parámetros de la respuesta
| Nombre del parámetro | Tipo de dato | Descripción del parámetro |
|---|---|---|
| Result | JSON | Json con la descripción del resultado de la operación |
Elementos de Result
- Result.NRecords: Valor numérico que indica el número de registros en la matriz Result.Data.
- Result.Data: Matriz que contiene uno o más objetos (Cantidad de registrios leídos).
- Result.Data[x].UID: Representa el código del contenedor.
- Result.Data[x].ItemCode: código de artículo del producto.
- Result.Data[x].InitialQTY: Cantidad inicial del contenedor.
- Result.Data[x].RemainingQTY: Cantidad restante del contenedor.
- Result.Data[x].DateCode: DateCode del contenedor.
- Result.Data[x].LotNumber: Número de lote del contenedor.
- Result.Data[x].MPartNumber: Part Number del fabricante del contenedor.
- Result.Data[x].SPartNumber: Part Number del proveedor del contenedor.
- Result.Data[x].OrderNumber: Número del pedido del contenedor.
- Result.Data[x].LineOrderNumber: Número de la línea del pedido.
- Result.Data[x].Type: Tipo del contenedor.
- Result.Data[x].Format: Formato del contenedor.
- Result.Data[x].IDDelivNoteLine: Referencia interna del albarnán de entrega.
- Result.Data[x].User: Usuario de creación del contenedor.
- Result.Data[x].Date: Fecha de creación del contenedor.
- Result.Data[x].Supplier: Proveedor del contenedor.
- Result.Data[x].Price: Precio del lote.
- Result.Data[x].PriceNoShipping: Precio del lote sin portes.
Códigos de estado de la respuesta
| Código de estado | Descripción del código de estado | Posibles razones |
|---|---|---|
| 200 | OK | La solicitud fue exitosa |
| 400 | Petición errónea | Alguno de los parámetros pasados no es correcto |
| 500 | Error interno | Error en el servidor |
| 401 | Unauthorized | El usuario no está autenticado |
Ejemplo de consulta
http://ctincoming/UID/READ/82567D1EEEA399427154D52F98DB1D95FFAAA6440D535B8B50C8BF7088ACE84E?UID=UID0001&DATEOFRECEIPT=20251005200000
Ejemplo de respuesta
{
"NRecords": 1,
"Data": [
{
"UID": "UID0001",
"ItemCode": "CODIGO_PN",
"InitialQTY": 1000,
"RemainingQTY": 500,
"DateCode": "2302",
"LotNumber": "LOT_1",
"MPartNumber": "PN_1",
"SPartNumber": "SPN_1",
"OrderNumber": "ORDER_NUMBER_0001",
"LineOrderNumber": 1,
"DeliveryNoteNumber": "DELNOTE01",
"Type": "REEL",
"Format": "H08S",
"IDDelivNoteLine": 0,
"User": "API-CTNEAT",
"Date": "2023-05-10T11:09:35.465",
"Supplier": "SUPPLIER_1",
"Price": 0,
"PriceNoShipping": 0,
}
]
}