Histórico da Página

...

Definição dos endpoints

...

POST

URL: /api/monitoramentopdvsyncclient/v2/statusstatusservico

Exemplo de body da requisição

...

Campo	Tipo	Descrição	Observações
idInquilino	string	Id do inquilino que enviou o status	Não Nulo
aplicacao	sring	Aplicação utilizada ex.: WSH/PDVSync	Não nulo
retaguarda	string	Retaguarda utilizada pelo serviço ex.: Winthor/Protheus	Não nulo
servico	string	Serviço que enviou o status ex.: PDVSync.Client.Down/PDVSync.Client.UP/Client.WSH/ClientProtheus	Não nulo
idLojaRetaguarda	string	Id retaguarda da loja que está utilizando o serviço	Não nulo
dispositivo	string	Dispositivo que está utilizando o serviço	Nullable
idDevice	string	Id do dispoisitivo que está utilizando o serviço	Nullable
status	string	Status do serviço ex.: Ativo/Inativo	Não nulo
dataServidor	Timestamp	Data que o serviço enviou o status	Não nulo

Retornos

HTTP 200 - Ok

{
  "success": true,
  "message": "",
  "data": {
  "aplicacao": "AplicacaoTeste",
  "retaguarda": "RetaguardaTeste",
  "servico": "ServicoTeste",
  "idLojaRetaguarda": "IdLojaRetaguardaTeste",
  "dispositivo": "DispositivoTeste",
  "idDevice": "IdDeviceTeste",
  "status": "StatusTeste",
  "dataServidor": "2023-11-22T13:00:00Z",
  "idInquilino": "IdInquilinoTeste",
  "dataAtualizacao": "2023-11-22T15:24:38.1057876Z",
  "dataCadastro": "2023-11-22T15:24:38.105787Z",
  "id": "19",
  "_expandables": []
  }
}

HTTP 400 - Bad request (Retorno recebido quando um campo obrigatório não é enviado)

{
  "code": "",
  "message": "",
  "detailedMessage": "",
  "helpUrl": "",
  "details": [
  {
  "guid": "23d3d6cd-084d-413a-8b1f-f596df5a9fe6",
  "code": "CQIFlap.Pber.Pbagebyr.Qbznva.Ragvgvrf.FgnghfFreivpb.FgnghfFreivpb+Reebe.5",
  "message": "O Status deve conter um status.",
  "detailedMessage": "StatusShouldHaveStatusSpecification"
  }
  ]
}

...

GET

URL:/api/monitoramentopdvsyncclient/v2/statusstatusservico

Definição dos campos de requisição

...

Campo	Tipo	Descrição	Observações
idInquilino	string	Id do inquilino	Nullable
aplicacao	string	Aplicação que enviou o status ex.: WSH/PDVSync	Nullable
idLojaRetaguarda	string	Id Retaguarda da loja que enviou o status	Nullable
servico	string	Serviço que enviou o status ex.: PDVSync.Client.Down/PDVSync.Client.UP/Client.WSH/ClientProtheus	Nullable

Retornos

HTTP 200 - Ok

[
  {
  "aplicacao": "PDVSync",
  "retaguarda": null,
  "servico": "PDVSync.Client.Up",
  "idLojaRetaguarda": "2",
  "dispositivo": "dispositivo teste",
  "idDevice": "id teste",
  "status": "Ativo",
  "dataServidor": "2023-11-16T14:07:24.088Z",
  "idInquilino": "1",
  "dataAtualizacao": "2023-11-21T22:51:42.438325Z",
  "dataCadastro": "2023-11-21T22:51:42.438255Z",
  "id": "4",
  "_expandables": []
  }
]

...

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Definição dos endpoints

POST

Exemplo de body da requisição

Retornos

GET

Definição dos campos de requisição

Retornos