Retrieve a work order form

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

Returns a completed form of the work order, with questions, answers and score.

Requires the X-Api-Key and User-Agent 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.

Responses

• 200

  Form found.

• 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 does not exist, or form does not exist, is not completed or belongs to another order. No body.

• 422

  Invalid identifier in the path or one from another account (uriValidationErr), or invalid query parameter (parametersValidationErr). A valid identifier that does not exist returns 404.

• 429

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

• 500

  Unexpected server error.