Histórico da Página

Informações

icon	false

O método ConsultarStatusTicketLC_Integracao retorna o status atual do ticket de entrada solicitado.

Compatibilidade
Ambiente SAAS
Ambiente OnPremise

Informações

icon	false
title	Exemplo de Utilização:

Exemplo de consumo Via Postman:

Image Added

Informações

title	Parâmetros de Entrada

Campo	Tipo(Tamanho)	Descrição	Obrigatório
Chave	varchar(16)	Chave de acesso válida	Sim
CodigoSistemaSatelite	varchar(20)	Código sistema Satélite	Sim
NumeroTicket	varchar(16)	Numero do ticket de entrada que deseja consultar	Sim
PararProcessamentoComErro	Boolean	Parar Processamento de mensagens com Erro. Obs: Disponível a partir da versão 6.5.51	Não

Informações

title	Parâmetros de Retorno

Campo

Tipo(Tamanho)

Observação

DetalheSituacao

varchar(200)

NumeroSequencia

SituacaoProcessamento

varchar(200)

Tipos de status dos tickets de entrada:

Aguardando Processamento
Processado
Com Erro
Aguardando Confirmação

Informações

title	Exemplo de Chamada do Método

Bloco de código

theme	Confluence
title	Chamada método ConsultarStatusTicketLC_Integracao:
linenumbers	true

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:liv="http://LiveConnector/" xmlns:ren="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data" xmlns:ren1="http://schemas.datacontract.org/2004/07/Rentech.PracticoLive.Connector.Objects">
   <soapenv:Header/>
   <soapenv:Body>
      <liv:ConsultarStatusTicketLC_Integracao>
         <liv:parametro>
            <ren1:Chave>xxxxxxxx-xxxe-xxxx-xxxx-xxxxxxxxxxx</ren1:Chave>
            <ren1:CodigoSistemaSatelite>xxxxxxx</ren1:CodigoSistemaSatelite>
            <ren1:NumeroTicket>0201211340546960</ren1:NumeroTicket>
         </liv:parametro>
      </liv:ConsultarStatusTicketLC_Integracao>
   </soapenv:Body>
</soapenv:Envelope>

Bloco de código

theme	Confluence
title	Exemplo do retorno:
linenumbers	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <ConsultarStatusTicketLC_IntegracaoResponse xmlns="http://LiveConnector/">
            <ConsultarStatusTicketLC_IntegracaoResult xmlns:a="http://schemas.datacontract.org/2004/07/Rentech.PracticoLive.Connector.Objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <a:LC_SituacaoDocumentoTicket>
                    <ClassID xmlns="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data">LC_SituacaoDocumentoTicket</ClassID>
                    <Creation xmlns="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data">2020-11-27T12:10:13.5004179-03:00</Creation>
                    <LastUpdate xmlns="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data">2020-11-27T12:10:13.5004179-03:00</LastUpdate>
                    <ObjectID xmlns="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data">00000000-0000-0000-0000-000000000000</ObjectID>
                    <OwnerID xmlns="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data">00000000-0000-0000-0000-000000000000</OwnerID>
                    <UserID xmlns="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data">00000000-0000-0000-0000-000000000000</UserID>
                    <a:DetalheSituacao>Erro inexistente</a:DetalheSituacao>
                    <a:NumeroSequencia>123456</a:NumeroSequencia>
                    <a:SituacaoProcessamento>Processado</a:SituacaoProcessamento>
                </a:LC_SituacaoDocumentoTicket>
            </ConsultarStatusTicketLC_IntegracaoResult>
        </ConsultarStatusTicketLC_IntegracaoResponse>
    </s:Body>
</s:Envelope>

Descriçã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.

Exemplo de funcionamento

O PDVSync.Client.Down envia o status a cada 30 minutos
Caso não haja o Status ele irá criar na tabela StatusServico no PDVSync.Core.Controle
Caso já exista o dado ele irá atualizar

Definição dos endpoints

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

...

Retornos

HTTP 200 - Ok

...

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 17

Nova versão Atual

Chave

Descrição

Exemplo de funcionamento

Definição dos endpoints

POST

Exemplo de body da requisição

Definição dos campos de requisição

Retornos

GET

Definição dos campos de requisição

Retornos