WebAPI – Alterar estado de um Pedido e classificação do serviço

WebAPI – Alterar estado de um Pedido e classificação do serviço

Este método permite efetuar a alteração de estado de um pedido e, caso seja estado final, permite a classificação do serviço.

O método a utilizar para a alteração de estado de um pedido é: 

POST {{url}/api/{{tenant}}/{{organization}}/requests/requests/changeStateRating/{{companyKey}}/{{requestKey}}/{{schemaEntityStateKey}}

No pedido à API deve ser passado:
  1. companyKey: chave da empresa;
  2. requestKey: chave do pedido;
  3. schemaEntityStateKey: chave do estado a transitar.

Este método permite alterar o estado do pedido de acordo com os seguintes parâmetros preenchidos:
  1. stateChangeDate: a data da alteração de estado. Se não for preenchido será utilizada a data atual;
  2. stateJustificationRemarks: motivo da mudança de estado. Este campo poderá ser obrigatório se a transição de estado assim o requerer.
  3. rate: número da classificação do serviço, número inteiro de 1 a 5. Esta informação só é gravada se o estado a transitar o pedido estiver configurado como sendo estado final e não cancelado;
  4. rateRemarks: observações da classificação do serviço, esta informação só é gravada se o estado a transitar o pedido estiver configurado como sendo estado final e não cancelado.

Quando este método é executado com sucesso devolve um HttpStatusCode.OK com a informação da mudança de estado.

Exemplo dos parâmetros no método:

POST {{url}/api/{{tenant}}/{{organization}}/requests/requests/changeStateRating/{{companyKey}}/{{requestKey}}/{{schemaEntityStateKey}}?stateChangeDate=2021-11-24T10:59:20.000%2B00:00&stateJustificationRemarks=Motivo&rate=5&rateRemarks=pedido executado




    • Related Articles

    • WebAPI - Criação de um pedido

      Este método permite, de forma simplificada, criar um pedido. O método a utilizar para a criação de um pedido é : POST url/api/mytenant/myorganization/Requests/requests Exemplo de Json para criação de um pedido: { "requestKey": "00001", "description": ...
    • Webapi - Como criar uma peça do tipo serviço?

      Este método permite, de forma simplificada, criar uma peça do tipo serviço. O método a utilizar para a criação de uma peça do tipo serviço é : POST url/api/mytenant/myorganization/businesscore/parts Exemplo de Json para criação de uma peça do tipo ...
    • WebAPI - Registo e Manutenção de Peças e Serviços

      Este método permite gerir o registo e manutenção de peças e serviços(criar novos registos e alterar dados dos existentes). No âmbito do inventário (peças), além do registo da peça permite complementar a sua classificação em termos de inventário, ...
    • WebAPI - Alteração de estado de um pedido

      Este método permite efetuar a mudança de estado de um pedido. O método a utilizar para a alteração de estado de um pedido é:  PUT {{url}/api/{{tenant}}/{{organization}}/requests/requests/{{companyKey}}/{{requestKey}}/schemaEntityState Os parâmetros ...
    • WebAPI – Alterar estado da ordem de trabalho

      Este método permite efetuar a mudança de estado de uma ordem de trabalho. O método a utilizar para a alteração de estado da ordem de trabalho é: Post {{url}/api/{{tenant}}/{{organization}}/maintenance/workorders/changeSchemaEntityState/{{companyKey}} ...