Árvore de páginas

Versões comparadas

Chave

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

...

titleDescrição

A api de StatusServicos foi criada com o intuito de que os serviços que utilizam o

...

POSH possam sinalizar que estão funcionando.

expand
Informações
titleExemplo de funcionamento
  1. O PDVSync.Client.Down envia o status a cada 30 minutos
  2. Caso não haja o Status ele irá criar na tabela StatusServico no PDVSync.Core.Controle
  3. Caso já exista o dado ele irá atualizar 

...

Exibir filhos

POST

URL: /api/pdvsyncclient/v2/statusservico

Exemplo de body da requisição

{
    "idInquilino": "IdInquilinoTeste",
    "aplicacao":"AplicacaoTeste",
    "retaguarda": "RetaguardaTeste",
    "servico": "ServicoTeste",
    "idLojaRetaguarda": "IdLojaRetaguardaTeste",
    "dispositivo": "DispositivoTeste",
    "idDevice": "IdDeviceTeste",
    "status": "StatusTeste",
    "dataServidor": "2023-11-22T13:00:00.000Z"
}

Definição dos campos de requisição

...

Campo

...

Tipo

...

Descrição

...

Observações

...

idInquilino

...

aplicacao

...

retaguarda

...

servico

...

idLojaRetaguarda

...

dispositivo

...

idDevice

...

status

...

dataServidor

...

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/pdvsyncclient/v2/statusservico

Definição dos campos de requisição

OBS: Os campos abaixo devem ser enviados como parâmetro no header da requisição

...

Campo

...

Tipo

...

Descrição

...

Observações

...

pageStatusServicos

Retornos
  • HTTP 200 - Ok

[
    {
        "aplicacao":"WSH/PDVSync",
        "retaguarda":"Winthor/Protheus",
        "servico":"PDVSync.Client.Down",
        "idLojaRetaguarda":"07",
        "dispositivo":"",
        "idDevice":"",
        "status":"Ativo",
        "dataServidor":"2024-02-29T13:24:14.971127+00:00",
        "idInquilino":"6a34W3REZqSCHVGpAk0L",
        "dataAtualizacao":"2024-02-29T13:24:15.538758+00:00",
        "dataCadastro":"2024-02-29T13:17:28.509172+00:00",
        "id":"6",
        "_expandables":[]
    }
]OBS: As datas retornadas na api estão em UTC+0 e deve ser convertida para o horário local no momento da visualização