Skip to main content

Change the answers of a work order form

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

Changes the answers to questions of a work order form. It does not work on locked orders.

Requires the X-Api-Key, User-Agent and Content-Type: application/json headers. Limit: 1 request per second (learn more).

Request​

Path parameters

idstringrequired

Work order identifier.

Example: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

formIdstringrequired

Answered form identifier.

Example: ZGY4NzYwYTYtMmQwYi00Mjc3LTliNzMtMjEwOTBiYWVkNDVjOjIyOTE1.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

JSON, sent with the Content-Type: application/json header.

questionslist of objectsrequired

Answers to change. The other questions keep their current answer.

Fields of questions
idstringrequired

Question identifier.

answerstringrequired

New answer, validated according to the question type (e.g. existing option, date, number).

At least 1 characters.

Responses

  • 200

    Answers changed.

  • 401

    API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

  • 403

    Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

  • 404

    Order or form does not exist, or form belongs to another order. No body.

  • 422

    Invalid body (resourceValidationErr): question that does not belong to the form (reason: not found) or answer incompatible with the question type; locked order (resourceLockedErr); invalid identifier (uriValidationErr).

  • 429

    Limit of 1 request per second exceeded. See Rate limit.

  • 500

    Unexpected server error.