Detalles de la Petición
- URL Base: {host}/ASMSAPI/
- Uri:
/api/v9/catalog/type={type}
- Tipo: GET
-
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.
- ASMSAPI/: Prefijo fijo de la API.
- Uri: Endpoint específico para la petición.
⚐ EJEMPLO URL:
https://{host}/ASMSAPI/api/v9/catalog/type=0
https://{host}/ASMSAPI/api/v9/catalog/type=1
https://{host}/ASMSAPI/api/v9/catalog/type=2
Parámetros
Nombre | Tipo de dato | Obligatorio | Descripción |
---|---|---|---|
type | Número | Sí | valor: 0 muestra los catálogos árbol y lista valor: 1 muestra el catalogo lista valor: 2 muestra el catalogo arbol |
ParentId | Número | NO |
Cuerpo de la petición
{
"Value": "Colombia",
"ParentId": "217122"
}
Respuesta
{
"totalItems": 3,
"content": [
{
"description": "",
"id": 12,
"isBuiltIn": true,
"name": "BRAND",
"parentId": null,
"status": 1,
"type": "N"
},
{
"description": "Descripción del segundo elemento",
"id": 13,
"isBuiltIn": false,
"name": "CATEGORY",
"parentId": 12,
"status": 1,
"type": "T"
},
{
"description": "Otro elemento de ejemplo",
"id": 14,
"isBuiltIn": false,
"name": "PRODUCT",
"parentId": null,
"status": 1,
"type": "N"
}
]
}
Parámetros Response
Nombre | Tipo de dato | Descripción |
---|---|---|
result | Booleano | Indica si la operación tuvo éxito |
Mensajes de Error
Código | Estado HTTP | Mensaje de error |
---|---|---|
403 | Unauthorized | DoNotHavePermissionForThisAction |
400 | Bad Request | FailureAddCatalogValue |