Histórico da Página

Segue abaixo o link onde contém explicações detalhadas sobre a mensagem padronizada:

• Padrão para criação de Mensagem Padronizada

COLOCAR O LINK MENSAGEM PADRONIZADA (SUBSTITUIR)

Com o objetivo de padronizar as integrações com os produtos TOTVS, foi definida uma nova diretriz para os projetos de integração onde todos os produtos TOTVS devem se comunicar através de mensagem XML ou JSON única, evitando desta forma, o processo de transformação de mensagens. O layout completo da mensagem padronizada conta com cabeçalho e elementos com informações de origem e destino, status de processamento e erros. Isto permite que dentro de uma mensagem específica seja definido apenas o conteúdo de negócio e retorno, mas quando o XML ou JSON completo for trafegar entre os produtos, todas as informações citadas anteriormente também façam parte da estrutura da mensagem.

Segue abaixo um exemplo do XML de uma mensagem padronizada (XML) completa:

Image Removed

Exemplo de um XML de resposta de processamento sem erros:

Image Removed

Exemplo de um XML de resposta de processamento com erros:

Image Removed

Exemplo de um XML de ReceiptMessage:

<ReceiptMessage>
	<ReceivedMessage>
		<SentBy>protheus_server1</SentBy>
		<UUID>25121218-a5c8-e581-b010-0a139a59f4bf</UUID>
		<MessageContent>
			<![CDATA[...]]>
		</MessageContent>	
	</ReceivedMessage>
	<ReceiptData>
		<ReceivedOn>2011-06-23T17:04:16</ReceivedOn>
	</ReceiptData>
</ReceiptMessage>

Observação: Uma ReceiptMessage representa a confirmação de recebimento de uma BusinessMessage pelo aplicativo destino. Diferente da ResponseMessage, uma ReceiptMessage não irá conter qualquer informação relevante sobre o processamento da mensagem. O envio da ReceiptMessage deverá ocorrer somente no envio de mensagem no modo assíncrona.

Informações Comuns Nas Mensagens Padronizadas

As mensagens TOTVS possuem um segmento chamado MessageInformation que possui as principais informações utilizadas para identificação e roteamento da mensagem. Segue abaixo um exemplo:

	<MessageInformation version="2.002">
		<BranchId>L MG 01</BranchId>
		<CompanyId>T2</CompanyId>
		<UserId>22</UserId/>
		<DeliveryType>Sync</DeliveryType>
		<GeneratedOn>2018-03-20T12:49:39Z</GeneratedOn>
		<Product name="PROTHEUS" version="12"/>
		<SourceApplication>P12_DEV_SERVERT2</SourceApplication>
		<StandardVersion>1.000</StandardVersion>
		<Transaction>UNITOFMEASURE</Transaction>
		<Type>BusinessMessage</Type>
		<UUID>69f90943-9cfc-b5e9-b485-500f17604e38</UUID>
	</MessageInformation>

A seguir é apresentado uma descrição detalhada de cada tag do segmento MessageInformation apresentado acima:

...

MessageInformation

...

DeliveryType

...

String

...

5

...

Forma de envio da mensagem, podendo ser "Sync" ou "Async", ou seja, "síncrono" ou "assíncrono" respectivamente;

...

SourceApplication

...

String

...

60

...