Mensagem API

CONTEÚDO

Endpoint:	Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/mensagem
Método:	POST
*Descrição:*	Utilize este recurso para inserir um novo cadastro.
*Modelo JSON (envio):*	{ "codigo": "Mensagem001", "titulo": "Título da Mensagem", "descricao": "Descrição da mensagem", }
Status de retorno: (HTTP - Status Code)	201 - Created (Criado) 400 - Bad Request (Um ou mais campos estão inválidos. Faça o preenchimento correto e tente novamente) 401 - Unauthorized (Falha na autenticação)
*Modelo JSON (retorno) quando retorna status 201:*	{ "id": "abdfdcf5-80a5-4289-9144-318bd405365b", "codigo": "Mensagem001", "titulo": "Título da Mensagem", "descricao": "Descrição da mensagem", }

Atributo	Detalhes
Código
Título	Informar título da mensagem.
Descrição	Informar descrição e conteúdo da mensagem.

Endpoint:	Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/mensagem{id}
Método:	PUT
*Descrição:*	Utilize este recurso para atualizar os dados de um registro já cadastrado.
Parâmetro:	Id: valor utilizado para encontrar o registro que será alterado com os dados do corpo da requisição.
*Modelo JSON (envio):*	{ "codigo": "Mensagem001", "titulo": "Título da Mensagem", "descricao": "Descrição da mensagem", }
Status de retorno: (HTTP - Status Code)	200 - OK

Endpoint:	Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/mensagem/{id}
Método:	DELETE
*Descrição:*	Utilize este recurso para excluir um registro.
Parâmetro:	Id: valor utilizado para encontrar o registro que será excluído.
Status de retorno: (HTTP - Status Code)	204 - No Content

Endpoint:	Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/mensagem/{id}
Método:	GET
*Descrição:*	Utilize este recurso para detalhar os dados de um registro.
Parâmetro:	Id: valor utilizado para encontrar o registro que será alterado com os dados do corpo da requisição.
*Modelo JSON (retorno)*	{ "id": "abdfdcf5-80a5-4289-9144-318bd405365b", "codigo": "Mensagem001", "titulo": "Título da Mensagem", "descricao": "Descrição da mensagem", }
Status de retorno: (HTTP - Status Code)	200 - OK

Endpoint:	Ambiente Stage: https://stg.motorfiscal.raas.varejo.totvs.com.br/registering/api/v1/mensagem/filtros
Método:	GET
*Descrição:*	Utilize este recurso para detalhar os dados de um registro.
Parâmetros:	Filtros: tipoAtor: tipo do ator (PESSOA_FISICA, PESSOA_JURIDICA, ESTRANGEIRO) documento: numero do documento fiscal do ator (CNPJ, CPF, ID ESTRANGEIRO) nomeFantasia: nome do ator (preenchido quando for do tipo pessoa jurídica) razaoSocial: nome jurídico do ator (preenchido quando for do tipo pessoa jurídica) nome: nome do ator (preenchido quando for do tipo pessoa física) codigoExterno: código utilizado para identificação do ator.
*Modelo JSON (retorno)*	{ "content": [ { "id": "abdfdcf5-80a5-4289-9144-318bd405365b", "codigo": "Mensagem001", "titulo": "Título da Mensagem", "descricao": "Descrição da mensagem", } ], "pageable": { "sort": { "sorted": false, "unsorted": true, "empty": true }, "pageNumber": 0, "pageSize": 20, "offset": 0, "unpaged": false, "paged": true }, "last": true, "totalPages": 1, "totalElements": 1, "numberOfElements": 1, "first": true, "size": 20, "number": 0, "sort": { "sorted": false, "unsorted": true, "empty": true }, "empty": false }
Status de retorno: (HTTP - Status Code)	200 - OK