...

{
    "Code" : "FE001",
    "Message" : "Mensagem padrão no formato incorreto.",
    "DetailedMessage" : "",
	"HelpUrl": "http://tdn.totvs.com" 
}

...

Endpoint /contents

Recuperar uma lista de entidades

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

Onde:

• transactionID_version: indica a transação e versão para a qual se quer recuperar os itens. Parâmetro obrigatório.
• page: Indica a página a recuperar. Valor padrão: 1.
• pageSize: Indica a quantidade de itens por página: Valor padrão: 10.
• order: Contém a lista de campos, separados por vírgula, que devem ser considerados para ordenar a lista de itens. Quando a ordenação for decrescente, o sinal "-" deve preceder o nome do campo. Valor padrão: ordenação definida pelo backend.
  Ex: order=-description,code.
• fields: Contem a lista de campos, separados por vírgula, que deve constar no retorno. Valor padrão: todos os campos.
  Ex: field=code,description.
• field1...fieldN: Indica o filtro que deve ser aplicado para selecionar os itens do retorno. Valor padrão: sem filtro.
  Ex: code=10&description=Teste.

GET /totvseai/standardmessage/v1/contents/customervendor_1_000

{
    "HasNext" :  "true",
    "Items" : [
        {
            "Atributo1" : "",
            "Atributo2" : ""
        },
        {
            "Atributo1" : "",
            "Atributo2" : ""
        }
    ]
}

Recuperar uma entidade

GET /totvseai/standardmessage/v1/contents/{transactionID_version}/{internalID}?
fields={fieldList}&
{field1}={value1}&{fieldN}={valueN}

Onde:

• transactionID_version: parâmetro obrigatório, que identifica a transação e versão da entidade desejada.
• internalID: parâmetro obrigatório contendo o internalID da entidade desejada.
• fields: parâmetro opcional, contendo a lista de campos que devem constar no retorno. Valor padrão: todos os campos.
• field1...fieldN: conjunto de parâmetros opcionais, necessários para transações do tipo request. Os parâmetros podem variar conforme a transação e versão.
   

GET /totvseai/standardmessage/v1/contents/customervendor_1_000/10|30

{
    "Atributo1" : "valor1",
    "Atributo2" : "valor2"
}

Submeter uma entidade

POST /totvseai/standardmessage/v1/contents/{transactionID_version}

Onde:

...

Para transações do tipo event, representa a criação de um registro.

Para transações do tipo request, representa a execução de um processamento.

POST /totvseai/standardmessage/v1/contents/updateContractParcel_2_001/

{
    "Atributo1" : "valor1",
    "Atributo2" : "valor2"
}

Alterar uma entidade

PUT /totvseai/standardmessage/v1/contents/{transactionID_version}/{internalID}

Onde:

...

PUT /totvseai/standardmessage/v1/contents/customervendor_1_000/10|30

{

	"Atributo1" : "valorA1",
	"Atributo2" : "valorA2"

}

Eliminar uma entidade

DELETE /totvseai/standardmessage/v1/contents/{transactionID_version}/{internalID}

Onde:

...

DELETE /totvseai/standardmessage/v1/contents/customervendor_1_000/10|30

//Não necessita de corpo

A eliminação de um lote de entidades não é possível, pois necessitaria dos Internal IDs que, por sua vez, deveriam constar no corpo da mensagem.