Retrieve simple-type survey questions for a feed

GET /task/v1/feeds/{feed_key}/survey

Operation id: getFeedSurvey

Description

Retrieves simple-type survey questions attached to a feed for the given button status. Simple surveys only — COMPLEX and FORM types return E338.

Feed Identification Modes

Path Parameters

Language Resolution Priority

1. requested_lang_code (if provided in request)
2. Locale from requested_user_id kernel user-details lookup (if requested_lang_code absent and requested_user_id present)
3. Session langCode as fallback (always available)

Language lookup failure (bad requested_user_id) is non-fatal — logs a warning and falls back to session langCode. Error messages to the client always use session langCode, regardless of the resolved service language.

Response Fields — form_array[*]

Error Scenarios

Error Codes Reference

Tags: MyWorkFeeds

Parameters

Path parameters

Query parameters

Security

• AuthTokenHeader (apiKey)
  • Session authentication token validated server-side against the user session store.

Responses

200 — Success — {status: OK, form_array[]}.

No data → E404. No simple survey (complex/form type or none) → E338.

Content type: application/json

400 — - E127 — btn_status is mandatory

• E129 — feed_key ≤ 0 and required_unit_id or cluster_id missing

Content type: application/json

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — Success — {status: OK, form_array[]}.

No data → E404. No simple survey (complex/form type or none) → E338.

Content type: application/json

Schema

JSON object (structure varies by endpoint).

{
  "type": "object",
  "description": "JSON object (structure varies by endpoint)."
}

Example:

{
  "status": "OK",
  "form_array": [
    {
      "question_id": 1,
      "question_text": "Was the task completed satisfactorily?",
      "question_type": "RADIO",
      "mandatory": true,
      "options": [
        {
          "option_id": 1,
          "option_text": "Yes"
        },
        {
          "option_id": 2,
          "option_text": "No"
        }
      ]
    }
  ]
}

400 — - E127 — btn_status is mandatory

• E129 — feed_key ≤ 0 and required_unit_id or cluster_id missing

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E202",
  "response": "User session is invalid"
}

500 — Unexpected server-side error

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}