Questionnaire request

Move an answer request to a new status

Changed on

Drives the whole review lifecycle of a single answer request: the answering company submits with IN_REVIEW, and the questionnaire's owner starts the review, asks for changes or marks it complete. Only the owner may set anything other than IN_REVIEW; anyone who is neither the owner nor the company being asked gets 404 rather than 403, so the endpoint never confirms a request they cannot see. Submitting for review is refused with 422 while a compulsory question is unanswered — a check that applies to the answering company, not the owner. IN_REVIEW also moves every answer that has not already been approved or denied into review, and COMPLETED approves whatever is still under review. The answering or requesting company is notified by email depending on the direction of the move, and the questionnaire's progress statistics are recomputed asynchronously. A request whose questionnaire is archived is read-only and answers 409 questionnaire_archived.

patch/api/questionnaires/{id}/requests/{requestId}/status

Request

  • Base URL
    https://api.retraced.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.retraced.com/api/questionnaires/{id}/requests/{requestId}/status
  • Auth
    none declared

Path parameters

idstring required
requestIdstring required

Request body

status'OPEN' | 'IN_REVIEW' | 'COMPLETED' | 'REQUEST_CHANGES' | 'DELETED' required

Response

Default Response

Changes

  • 52053c64373eRevision changes
    • info

      added the non-success response with the status

  • 97e51f27dc77Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed subschema #1 subschema #2 from the / response property anyOf list for the response status

    • info

      response property data/createdByCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/forCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/isRemoved list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/onBehalfOfCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/questionnaireName list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/status list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/updatedByUserId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/updatedByUserName list-of-types was narrowed by removing types null from media type application/json of response 200