TOTVS Varejo Franquias e Redes

Atalhos

Árvore de páginas

Este método é responsável pelo envio de status

  • Endpoint: /api/retaguarda/v2/statusservico
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda


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

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çoAceita nulo

idDevice

stringId do dispoisitivo que está utilizando o serviçoAceita nulo

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

versaoClient

stringVersão da Aplicação/Serviço utilizadaAceita nulo

{
    "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",

        "versaoClient": "3.8.0.0",
        "_expandables": []
    }
}

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"
        }
    ]
}

  • Sem rótulos