Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
titleInformações
Expandir
titleDescrição

A api de StatusServicos foi criada com o intuito de que os serviços que utilizam o PDVSync possam sinalizar que estão funcionando.

Expandir
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 
Informações
titleDefinição dos enpoints
Expandir
titlePOST /api/pdvsyncclient/v2/statusservico
Expandir
titleExemplo 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"
}

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

idInquilino

stringId do inquilino que enviou o statusNão Nulo 

aplicacao

sringAplicação utilizada ex.: WSH/PDVSyncNão nulo

retaguarda

stringRetaguarda utilizada pelo serviço ex.: Winthor/ProtheusNão nulo

servico

stringServiço que enviou o status ex.: PDVSync.Client.Down/PDVSync.Client.UP/Client.WSH/ClientProtheusNão nulo

idLojaRetaguarda

stringId retaguarda da loja que está utilizando o serviçoNão nulo 

dispositivo

stringDispositivo que está utilizando o serviçoNullable

idDevice

stringId do dispoisitivo que está utilizando o serviçoNullable

status

stringStatus do serviço ex.: Ativo/InativoNão nulo

dataServidor

TimestampData que o serviço enviou o status OBS: Enviar a data com timezoneNão nulo
Expandir
titleRetornos
Expandir
titleHTTP 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": []
    }
}

Expandir
titleHTTP 400 - Bad Request

Retorno ocorre quando uma 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"
        }
    ]
}

Expandir
titleGET /api/pdvsyncclient/v2/statusservico
Expandir
titleDefiniçã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

idInquilinostringId do inquilinoNullable
aplicacaostringAplicação que enviou o status ex.: WSH/PDVSyncNullable
idLojaRetaguardastringId Retaguarda da loja que enviou o statusNullable
servicostringServiço que enviou o status ex.: PDVSync.Client.Down/PDVSync.Client.UP/Client.WSH/ClientProtheusNullable
Expandir
titleRetornos
Expandir
titleHTTP 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