Histórico da Página
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "Header": { "UUID": "c18535da-75b8-4925-9e32-b6445d4f2927", "Type": "BusinessMessage", "SubType": "request", "Transaction": "AccountsReceivableOffsetting", "StandardVersion": "1.000", "SourceApplication": "RM", "CompanyId": "2", "BranchId": "2", "GeneratedOn": "2016-06-21T19:41:21", "DeliveryType": "Sync", "Version": "2.000", "ProductName": "RM", "ProductVersion": "11.83.55" }, "Content": { "CompanyInternalId": "CompanyInternalId1", "CompanyId": "CompanyId1", "BranchId": "BranchId1", "InternalId": "InternalId1", "AccountReceivableDocumentInternalId": "AccountReceivableDocumentInternalId1", "AdvanceInternalId": "AdvanceInternalId1", "OffsettingDate": "1900-01-01T00:00:00", "HistoryText": "HistoryText1", "OffsettingValue": 1.0 } } |
Onde:
- BusinessContentContent: contem JSON com informações necessárias para o processamento, normalmente parâmetros de entrada.
...
Informações |
---|
...
| ||
Uma BusinessMessage, seja do tipo Event quanto do tipo Request, tem seu atributo Content definido no schema da mensagem padronizada TOTVS. Conforme pode ser visto nesta página, deve-se indicar, através do atributo x-totvs na seção info do schema qual modelo será utilizado para definir o atributo Content (transactionDefinition/BusinessContentType). |
ResponseMessage
Âncora | ||||
---|---|---|---|---|
|
Uma ResponseMessage representa
...
Uma ResponseMessage representa o resultado do processamento de uma BusinessMessage pelo aplicativo que a recebeu e o seu conteúdo pode variar de acordo com o tipo de mensagem e com o resultado do processamento.
Todas as respostas geradas por uma BusinessMessage devem ser associadas à mensagem original e mantidas pelo aplicativo-origem, como forma de rastrear quem processou aquela mensagem e qual o resultado do processamento.
A mensagem de resposta contém informações sobre o resultado do processamento de uma BusinessMessage. pelo aplicativo que a recebeu e o seu conteúdo pode variar de acordo com o tipo de mensagem e com o resultado do processamento.
Todas as respostas geradas por uma BusinessMessage devem ser associadas à mensagem original e mantidas pelo aplicativo-origem, como forma de rastrear quem processou aquela mensagem e qual o resultado do processamento.
A mensagem de resposta contém informações sobre o resultado do processamento de uma BusinessMessage.
Exemplo de um JSON de resposta Exemplo de um JSON de resposta de processamento sem erros
...
- ReceivedMessage: Segmento com informações sobre a mensagem original (BusinessMessage) que deu origem a esta resposta.
- SentBy: Indica qual foi a instancia que gerou a mensagem original
- UUID: Identificador universal da mensagem de origem
- Event: Qual foi o evento associado à mensagem (pode ser upsert – inclusão/alteração – ou delete – eliminação).
- ProcessingInformation: Segmento com informações sobre o resultado do processamento
- ProcessedOn: Timestamp de quando a mensagem foi processada pelo destino
- Status: Situação final do processamento (ok ou error)
- Details: Lista de mensagens (erro ou aviso) retornadas no processamento.
- : Lista de mensagens (erro ou aviso) retornadas no processamento.
- ReturnContent: JSON com as informações de negócio retornadas no processamento
Informações | ||
---|---|---|
| ||
Da mesma forma que o atributo Content de uma BusinessMessage, o atributo ReturnContent de uma ResponseMessage é definido no schema da mensagem padronizada. De acordo com a documentação sobre schemas, na atributo x-totvs da seção info deve ser referenciado o modelo que definirá o ReturnContent (transactionDefinition/ReturnContentType). |
Exemplo de um JSON de resposta de processamento com erros:
...