Classes
GET Catálogo de clases
Obtiene el catálogo de clases
Nombre |
Tipo y longitud o rango de dato |
Descripción |
Requerido |
Default |
---|---|---|---|---|
HOST |
URL |
Se indicará de acuerdo el ambiente donde será consumido el servicio:
|
Sí |
N/A |
Recursos URL
- GET HOST/v1/catalogs/classes/
- Encabezados de solicitud:
Authorization – Token del usuario (Token <token>)
- Parámetros de consulta:
status (boolean) – Estatus del registro true Activo false Inactivo.
- Códigos de Status:
200 OK – Ningún error.
400 Bad Request – Algún parámetro es incorrecto.
401 Unauthorized – Token no válido o no enviado.
500 Internal Server Error – Error interno.
Arreglo de clases
- Objeto JSON de respuesta:
id (string) – ID de la clase.
type (string) – Identificador del tipo de clase
name (string) – Descripción de la clase.
status (string) – Estatus del registro 1 Activo 0 Inactivo.
Tipo |
Descripción |
---|---|
C |
Cliente |
P |
Proveedor |
A |
Artículo |
Ejemplo de petición (estado = 1)
GET HOST/v1/catalogs/classes/?status=1 HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token (token del usuario)
Ejemplo de respuesta
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS
[
{
"id": "A",
"type": "A",
"name": "Artículo",
"status": "1"
},
{
"id": "G",
"type": "A",
"name": "Consulta Gral.",
"status": "1"
},
{
"id": "1",
"type": "C",
"name": "Dolce Gusto",
"status": "1"
},
{
"id": "3",
"type": "C",
"name": "AMEX",
"status": "1"
},
{
"id": "L",
"type": "P",
"name": "Publicidad",
"status": "1"
},
{
"id": "V",
"type": "P",
"name": "Servicios",
"status": "1"
}
]
Ejemplo de petición (estado = 1, tipo = C)
GET HOST/v1/catalogs/classes/?status=1&type=C HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token (token del usuario)
Ejemplo de respuesta
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS
[
{
"id": "#",
"type": "C",
"name": "HEMO-IONICS",
"status": "1"
},
{
"id": "%",
"type": "C",
"name": "PRIMA FREE",
"status": "1"
},
{
"id": "*",
"type": "C",
"name": "MON CHATEAU MEX",
"status": "1"
},
{
"id": "-",
"type": "C",
"name": "MICROCLICK",
"status": "1"
}
]