...
Método de consulta que retorna as informações das categoria em formato de árvore.
GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Categoria/arvore
(Descrever o passo a passo da aplicação)
...
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
---|---|---|---|
IdCategoria | Identificador da categoria | integer($int64) | Não há. |
NroDivisao | Número da divisão | integer($int64) | Não há. |
Tipo | Tipo da categoria. Valores: M - Mix, C - Consumidor, L - Lista de Preço | string | Não há. |
Sentido | 1 - Busca no Sentido de categoria para subcategoria 2 - Busca no sentido de subcategoria para categoria | integer($int32) | Não há. |
Expand | Expandir os campos | string | Não há. |
Fields | Campos | string | Não há. |
Order | Ordenação | string | Não há. |
Page | Páginas | integer($int32) | Não há. |
PageSize | Tamanho das páginas | integer($int32) | Não há. |
Não há.
CODE 200 - SUCCESS
Bloco de código | ||
---|---|---|
| ||
{
"hasNext": true,
"items": [
{
"idCategoria": 0,
"nroDivisao": 0,
"descricao": "string",
"tipo": "string",
"aceitaFamilia": "string",
"objetivoNoNegocio": "string",
"percMargemLucro": 0,
"status": "string",
"idCategoriaImportacaoERP": 0,
"nroDivisaoImportacaoERP": 0,
"categoriasFilho": [
{
"idCategoria": 0,
"nroDivisao": 0,
"descricao": "string",
"tipo": "string",
"aceitaFamilia": "string",
"objetivoNoNegocio": "string",
"percMargemLucro": 0,
"status": "string",
"idCategoriaImportacaoERP": 0,
"nroDivisaoImportacaoERP": 0,
"categoriasFilho": [
null
]
}
]
}
]
} |
application/json, text/json
CODE 400 - BAD
Bloco de código | ||
---|---|---|
| ||
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"notificationType": 0,
"code": "string",
"message": "string",
"detailedMessage": "string",
"status": 0
}
]
} |