Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Consultar o vinculo da família com a categoria.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia/familia-categoria

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

Parâmetros URI (URI Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

IdFamiliaidentificador da família

array[integer]

não há
IdDivisaoidentificador da divisãoarray[integer]não há
NroCategorianumero da categoriaarray[integer]não há
DataHoraAlteracaoData/hora da alteraçãostring($date-time)não há
AceitaFamiliaIndica se a categoria aceita famíliastringnão há
TipoCategoriatipo da categoriastringnão há
Statustipo de statusstringnão há
Expandpropriedade para expandir os camposstringnão há
Fieldscamposstringnão há
Orderordenação dos camposstringnão há
Pagenumero da páginainteger($int32)não há
PageSizetamanho da páginainteger($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": [
    {
      "idFamilia": 0,
      "idCategoria": 0,
      "nroDivisao": 0,
      "status": "string",
      "dataHoraAlteracao": "2021-02-12T14:18:35.887Z",
      "usuarioAlteracao": "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
    }
  ]
}