Pular para o conteúdo principal

Recuperar um formulário da ordem

GEThttps://carchost.fieldcontrol.com.br/orders/{id}/forms/{formId}

Retorna um formulário concluído da ordem de serviço, com perguntas, respostas e pontuação.

Requer os headers X-Api-Key e User-Agent. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

formIdstringobrigatório

Identificador do formulário respondido.

Exemplo: ZGY4NzYwYTYtMmQwYi00Mjc3LTliNzMtMjEwOTBiYWVkNDVjOjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

  • 200

    Formulário encontrado.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 404

    Ordem inexistente, ou formulário inexistente, não concluído ou de outra ordem. Sem corpo.

  • 422

    Identificador no path inválido ou de outra conta (uriValidationErr), ou parâmetro de query inválido (parametersValidationErr). Um identificador válido que não existe retorna 404.

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.