...

• /transactions: para receber mensagens através do engine de EAI. Ex: POST /totvseai/standardmessage/v1/transactions/customervendor_1_000.
• /contents: para receber e recuperar mensagens de forma direta, sem passar pelo engine do EAI. O que interessa é Usado quando apenas o conteúdo trafegado . Ex: GET é relevante.

Endpoint /transactions

Submeter mensagens em lote

POST /totvseai/standardmessage/v1/

...

transactions?batchType={batchType}

Onde batchType indica o tipo de lote

Endpoint /transactions

Submeter mensagens em lote

POST /totvseai/standardmessage/v1/transactions?batchType={batchType}

Onde batchType indica o tipo de lote sendo enviado

• simpleBatch: Este é o tipo default, quando o parâmetro não for informado, e indica que as transações podem ser processadas individualmente. Eventuais erros não comprometem as demais. Se houver transações distintas num simpleBatch, deve ser gerado erro;;
• businessTransaction: indica que as transações dentro businessTransaction: indica que as transações dentro do lote devem ser processadas de forma atômica: ou processa tudo ou não aceita nenhuma. O lote pode conter mensagens de uma mesma transação e versão.

...

POST /totvseai/standardmessage/v1/transactions?batchType=businessTransaction

{
    "items" : [
		{
            "header" : {
                "UUID" : "",
                "type" : "BusinessMessage",
                "subType" : "event",
                "transaction" : "customerVendor",
                "version" : "2.001",
                "sourceApplication": "",
                "productName" : "",
                "productVersion" : "",
                "generatedOn" : "",
                "deliveryType" : "async",
            },
            "content" : {
                "atributo1" : "",
                "atributo2" : "",
                ...
                "atributoN" : ""
            }
        },{
            "header" : {
                "UUID" : "",
                ...
                "transaction" : "item",
                "version" : "3.001",
                ...
                "deliveryType" : "sync" // Rejeitar toda a requisição e informar que só aceita assíncrono
            },
            "content" : {
                "atributo1" : "",
                "atributo2" : "",
                ...
                "atributoN" : ""
            }
        }
    ]
}

Submeter mensagens em lote - mesma transação e versão

...

Submeter uma única mensagem

...

POST /totvseai/standardmessage/v1/transactions

O parâmetro batchType não é relevante para esta situação. Logo, se for informado, deve ser ignorado

Não será possível pelo endpoint /transactions. O endpoint /contents existe para esta finalidade.

Submeter uma mensagem, com header

Se for informado o batchType, ignorar.

POST /totvseai/standardmessage/v1/transactions/

{
    "header" : {
        "UUID" : "",
        "type" : "BusinessMessage",
        "subType" : "event|request",
        "transaction" : "customerVendor",
        "version" : "2.001",
        "sourceApplication": "",
        "productName" : "",
        "productVersion" : "",
        "companyId" : "",
        "branchId" : "",
        "generatedOn" : "",
        "deliveryType" : "asyncsync",
    },
    "content" : {
        "atributo1" : "",
        "atributo2" : "",
        ...
        "atributoN" : ""
    }
}

Eliminar uma mensagem

...

DELETE /totvseai/standardmessage/v1/transacions

Justificando a presença de corpo na requisição de DELETE, é necessário identificar se a transação é síncrona ou não. Sem o corpo, todas as informações teriam que ser colocadas na URL da requisição.

Bloco de código
language js
DELETE /totvseai/standardmessage/v1/transactions/ { "header" : { "UUID" : "", "type" : "BusinessMessage", "subType" : "event|request", "transaction" : "customerVendor", "version" : "2.001", "sourceApplication": "", "productName" : "", "productVersion" : "",  "companyId" : "", "branchId" : "", "generatedOn" : "", "deliveryType" : "asyncsync", }, "content" : { "atributo1" : "", "atributo2" : "", ... "atributoN" : "" } }

Eliminar um lote de mensagens

...

...

language	js

DELETE /totvseai/standardmessage/v1/transactions

...

?batchType={batchType}

A eliminação em lote utiliza o mesmo endpoint, variando apenas o corpo, onde as mensagens a eliminar estarão dentro de um array JSON. Somente mensagens assíncronas serão aceitas. O endpoint aceita o parâmetro batchType, e o comportamento será o mesmo descrito para quando um lote de mensagens é submetido. Se o parâmetro for omitido, terá valor "simpleBatch".

Bloco de código
language js
DELETE /totvseai/standardmessage/v1/transactions { "items" : [

Formato de mensagem de resposta

O JSON equivalente a Response Message será:

{
    "header" : {
        "UUID" : "",
        "type" : "Response",
        "subType" : "",
        "transaction" : "",
        "version" : "",
        "sourceApplication" : "",
        "productName" : "",
        "productVersion" : "",
        "generatedOn" : "",
        "deliveryType": ""
    },
    "content" : {
        "receivedMessage" : {
            "UUIDheader" : "<originalMsgUUID>",
{
                "SentByUUID" : "<sourceApplication>",
                "eventtype" : "upsert|delete"        BusinessMessage",
        },
        "processingInformationsubType" : {
"event",
                "processedOntransaction" : "customerVendor",
                "statusversion" : "OK|ERROR|WARNING2.001",
                "detailssourceApplication" : ["",
                {
"productName" : "",
                  "codeproductVersion" : "",
                    "messagegeneratedOn" : "",
                    "detailedMessagedeliveryType" : "async",
            },
        "helpUrl"   : "http://<serverName>content" : // Opcional
    {
            },
     "atributo1" : "",
         {
       "atributo2" : "",
           "code" : "",
    ...
                "messageatributoN" : "",
            }
        "detailedMessage" : ""},
        {
            "helpUrlheader" : "http://<serverName>" {
    // Opcional
				}
            ]"UUID" : "",
        },
        "returnContenttype" : {"BusinessMessage",
                "atributo1subType" : "event",
                "atributo2transaction" : "customerVendor",
                "listOfInternalIDversion" : [ "2.001",
        // Opcional em caso de resposta de requests
 "sourceApplication": "",
              {
  "productName" : "",
                "nameproductVersion" : "InternalIdName",
                    "origingeneratedOn" : "",
                    "destinationdeliveryType" : "async",
            },
            },
  "content" : {
              {
  "atributo1" : "",
                "nameatributo2" : "InternalIdName",
                ...
                "originatributoN" : "",
            }
        "destination"}
 : ""
                }
            ]
        }
    }
}

Endpoint /contents

As requisições deste endpoint são exclusivamente síncronas.

Recuperar um lote de mensagens

...

  ]
}

Endpoint /contents

Recuperar um lote de mensagens

GET /totvseai/standardmessage/v1/contents/{transactionID_version}?page={page}&pageSize={pageSize}&order={orderList}&fields={fieldList}&{field1}={value1}&{field2}={value2}&{fieldN}={valueN}

Onde:

• page:
• pageSize:
• order:
• fields:
• field1...fieldN:

// Permitir também os filtros por atributo
GET /totvseai/standardmessage/v1/contents/customervendor_1_000?page={page}&pageSize={pageSize}&order={campos}

{
    "hasNext" :  "true",
    "items" : [
        {
            "atributo1" : "",
            "atributo2" : ""
        },
        {
            "atributo1" : "",
            "atributo2" : ""
        }
    ]
}

Recuperar uma entidade

...

O termo entidade está sendo usado no lugar de mensagem, porque neste endpoint (e nos demais) não haverá os controles que são feitos no endpoint /transactions. Uma mensagem implica em um remetente, um destinatário e um conteúdo. Neste caso, temos explicito apenas o conteúdo, correspondente a uma entidade no destino, que é identificada pelo internalID.

...