Árvore de páginas

Objetivo

Método de permite inserir informações nutricionais de famílias.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia/informacao-nutricional

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais 


Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

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*

Identificador da famíliainteger($int64)Não há.
descricao*

Descrição da informação nutricional

stringTamanho máximo: 50
observacao

Observação da informação nutricional

stringTamanho máximo: 250
qtdPorcao

Quantidade Porção

integer($int32)Mínimo: 0
Máximo: 9999
unidPorcao

Unidade Porção

stringTamanho máximo: 1
parteInteira

Parte Inteira - Informações Caseiras

stringTamanho máximo: 5
parteDecimal

Parte Decimal - Informações Caseiras

stringTamanho máximo: 5
medidaCaseira

Medida Caseira

stringTamanho máximo: 5
tabelaNutricional

Informações da tabela nutricional

Array
InsereTabelaNutricionalReqDTO

idAtributoFixo*

Identificador do Atributo Fixo

integer($int64)

Mínimo: 0
Máximo: 9999

Pertence ao array InsereTabelaNutricionalReqDTO

descricaoQtdPorcao*

Descrição da Quantidade por Porção

string

Tamanho máximo: 30

Pertence ao array InsereTabelaNutricionalReqDTO

percVlrDiaRef*Valor Diário Referêncianumber($double)

Mínimo: 0
Máximo: 9999

Pertence ao array InsereTabelaNutricionalReqDTO

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

{
  "expandables": [
    "string"
  ],
  "idFamilia": 0,
  "idInformacaoNutricional": 0,
  "descricao": "string",
  "observacao": "string",
  "qtdPorcao": 0,
  "unidPorcao": "string",
  "parteInteira": "string",
  "parteDecimal": "string",
  "medidaCaseira": "string",
  "tabelaNutricional": [
    {
      "idAtributoFixo": 0,
      "descricaoQtdPorcao": "string",
      "percVlrDiaRef": 0
    }
  ]
}


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