Páginas filhas
  • TSSPARAM - /V1/NFE/TSS/PARAM/:id - GET - API REST para retorno de todos os parâmetros da entidade no TSS

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tabelas utilizadas
  4. Informações relacionadas


01. VISÃO GERAL

Essa API retorna em json, todos os parâmetro da entidade informada por parâmetro existentes no TSS, informando se este é editável ou não via API.

...

Informações

API disponível apenas para uso do TSS REST SERVER


02. EXEMPLO DE UTILIZAÇÃO

2.1 Namespace da API

...

Deck of Cards
idapirest
Card
labelMétodo GET - Parâmetros de entrada

Deve-se informar o código da entidade na requisição como um parâmetro ao final da URL:

Bloco de código
themeRDark
firstline1
titleExemplo parâmetro requisição
linenumberstrue
/v1/nfe/tss/param/000001


Exemplo usando POSTMAN

Image RemovedImage Added





Card
labelMétodo GET - Retorno Sucesso
Retorno de sucesso
AtributoInformação
statusCódigo de retorno de status da requisição
messageMensagem de status da requisição
PARAMETROSparametros

Atributo array com todos os parâmetros encontrados, onde:

"entidade": Código da entidade

"nome": Nome do parâmetro

"conteudo": Conteúdo do parâmetro

"descrição": breve descrição para que serve o parâmetro

"editavel": 1-É possível edição de seu conteúdo através de API / 2-Não alterável via API



Image Added

Image RemovedImage Added

Card
labelMétodo GET - Retorno Falha
Retorno de erro
AtributoInformação
statusCódigo de retorno de status da requisição
messageMensagem de status da requisição
ErroserrosMensagens de erros mais detalhado gerados na requisição


03. TABELAS UTILIZADAS

SPED000 - Parâmetros do TSS.

04. Informações relacionadas

...