Proveedores / Fabricantes
En este módulo se pueden añadir y leer tanto proveedores como fabricantes.
AÑADIR FABRICANTE / PROVEEDOR
Esta función permite añadir un nuevo proveedor o fabricante en el sistema. Para el sistema establecido, ambos tipos se tratan en la misma tabla por lo que, para diferenciarlos se deberá dar valor a uno de los campos establecidos como parámetro de la llamada. No obstante, un mismo registro puede ser ambos tipos.
URL
/CTNEAT/SUPPLIER/ADD/{tkn}
Método HTTP
POST
Parámetros de la solicitud
| Nombre del parámetro | Tipo de dato | Descripción del parámetro | Obligatorio | Formato del valor |
|---|---|---|---|---|
| NAME | cadena (ANSI) | Nombre del proveedor/fabricante | Sí | - |
| NIF | cadena (ANSI) | NIF/CIF del proveedor/fabricante | Sí | - |
| ADDRESS | cadena (ANSI) | Dirección postal | No | - |
| POSTALCODE | cadena (ANSI) | Código postal | No | - |
| CITY | cadena (ANSI) | Ciudad | No | - |
| STATE | cadena (ANSI) | Provincia | No | - |
| cadena (ANSI) | Correo electrónico | No | - | |
| TELEPHONE | cadena (ANSI) | Número de teléfono | No | - |
| WEBSITE | cadena (ANSI) | Página web | No | - |
| ISSUPPLIER | booleano | Indica si es un proveedor | No | 0 o 1 (Siendo 0 "false" y 1 "true") |
| ISMANUFACTURER | booleano | Indica si es un fabricante | No | 0 o 1 (Siendo 0 "false" y 1 "true") |
Encabezados de la solicitud
| Nombre del encabezado | Descripción del encabezado | Obligatorio |
|---|---|---|
| Content-Type | Tipo de contenido de la solicitud | Sí |
Parámetros de la respuesta
| Nombre del parámetro | Tipo de dato | Descripción del parámetro | Formato |
|---|---|---|---|
| ErrorContent, SuccessContent | JSON | Json con la descripción del resultado de la operación | Formato ErrorContent |
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 |
Cuerpo de la solicitud
Formato del cuerpo de la solicitud: application/json
Descripción del cuerpo de la solicitud:
{
"NAME": "NOMBRE_PROVEEDOR_O_FABRICANTE",
"NIF": "NIF_O_CIF",
"ADDRESS": "DIRECCION_POSTAL",
"POSTALCODE": "CODIGO_POSTAL",
"CITY": "CIUDAD",
"STATE": "PROVINCIA",
"EMAIL": "CORREO_ELECTRONICO",
"TELEPHONE": "TELEFONO",
"WEBSITE": "PAGINA_WEB",
"ISSUPPLIER": 1,
"ISMANUFACTURER": 0
}
Ejemplo de respuesta
{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Supplier / manufacturer added", "detail":"Entry NOMBRE_PROVEEDOR_O_FABRICANTE successfully added" } }
OBTENER PROVEEDORES
Con esta función, se tiene la capacidad de leer los proveedores que han sido registrados en el sistema. Es importante destacar que se puede proporcionar el nombre del proveedor que se desea leer a través de un parámetro de URL query. En caso de no especificar este parámetro, se llevará a cabo la lectura de todos los proveedores del sistema.
URL
/CTNEAT/SUPPLIER/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 |
|---|---|---|---|---|
| NAME | cadena | Nombre del proveedor | No (Si el nombre no se especifica, la API devolverá todos los proveedores del sistema) | Cualquiera |
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].ADDRESS: Es la dirección física.
- Result.Data[x].CITY: Es la ciudad.
- Result.Data[x].EMAIL: Es el correo electrónico.
- Result.Data[x].NAME: Es el nombre comercial.
- Result.Data[x].NIF: Es el NIF.
- Result.Data[x].POSTALCODE: Es el código postal.
- Result.Data[x].STATE: Es la província.
- Result.Data[x].TELEPHONE: Es el número de teléfono.
- Result.Data[x].WEBSITE: Es la página web.
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/SUPPLIER/READ/693DDFEC2F4BFDDEAF04DD2724984C9B3CA89D553DD8E5B9BB233AD6BB6075F1?NAME=NOMBRE_PROVEEDOR
Ejemplo de respuesta
{
"NRecords":1,
"Data":[
{
"NAME":"NOMBRE_COMECIAL",
"NIF":"NIF1234567",
"ADDRESS":"DIRECCIÓN",
"POSTALCODE":"CP000",
"CITY":"CIUDAD",
"STATE":"ESTADO O PROVÍNCIA",
"EMAIL":"EMAIL",
"TELEPHONE":"931001000"
"WEBSITE":"www.una-url.com"
}
]
}
OBTENER FABRICANTES
Con esta función, se tiene la capacidad de leer los fabricantes que han sido registrados en el sistema. Es importante destacar que se puede proporcionar el nombre del fabricante que se desea leer a través de un parámetro de URL query. En caso de no especificar este parámetro, se llevará a cabo la lectura de todos los fabricantes del sistema.
URL
/CTNEAT/MANUFACTURER/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 |
|---|---|---|---|---|
| NAME | cadena | Nombre del fabricante | No (Si el nombre no se especifica, la API devolverá todos los fabricantes del sistema) | Cualquiera |
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].ADDRESS: Es la dirección física.
- Result.Data[x].CITY: Es la ciudad.
- Result.Data[x].EMAIL: Es el correo electrónico.
- Result.Data[x].NAME: Es el nombre comercial.
- Result.Data[x].NIF: Es el NIF.
- Result.Data[x].POSTALCODE: Es el código postal.
- Result.Data[x].STATE: Es la província.
- Result.Data[x].TELEPHONE: Es el número de teléfono.
- Result.Data[x].WEBSITE: Es la página web.
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/MANUFACTURER/READ/693DDFEC2F4BFDDEAF04DD2724984C9B3CA89D553DD8E5B9BB233AD6BB6075F1?NAME=NOMBRE_FABRICANTE
Ejemplo de respuesta
{
"NRecords":1,
"Data":[
{
"NAME":"NOMBRE_COMECIAL",
"NIF":"NIF1234567",
"ADDRESS":"DIRECCIÓN",
"POSTALCODE":"CP000",
"CITY":"CIUDAD",
"STATE":"ESTADO O PROVÍNCIA",
"EMAIL":"EMAIL",
"TELEPHONE":"931001000"
"WEBSITE":"www.una-url.com"
}
]
}