Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método de consulta que retorna os dados da divisão da família.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia/divisao

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

IdFamilia

Código da família.array[integer]Não há.

IdDivisao

Código da divisãoarray[integer]Não há.
ExpandOpção de expandir.

string

Não há.
FieldsCampos.stringNão há.
OrderOrdenação dos campos.stringNão há.

Page

Número da página.integer($int32)Não há.
PageSizeTamanho da página.integer($int32)Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "idFamilia": 0,
      "idDivisao": 0,
      "padraoEmbTransf": 0,
      "padraoEmbCompra": 0,
      "idComprador": 0,
      "idTributacao": 0,
      "finalidadeFamilia": "string",
      "formaAbastecimento": "string",
      "dtaHorInclusao": "2020-11-10T16:51:41.924Z",
      "usuarioInclusao": "string",
      "dtaHorAlteracao": "2020-11-10T16:51:41.924Z",
      "usuarioAlteracao": "string",
      "codOrigemTrib": "string",
      "idPauta": 0,
      "idPautaIcms": 0,
      "familia": {
        "expandables": [
          "string"
        ],
        "idFamilia": 0,
        "nomeFamilia": "string"
      },
      "divisao": {
        "expandables": [
          "string"
        ],
        "idDivisao": 0,
        "nomeDivisao": "string"
      }
    }
  ]
}


application/json, text/json

CODE 400 - BAD

{
  "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
    }
  ]
}