Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return labels in data API for qualitative analysis responses #4627

Closed
jnm opened this issue Sep 7, 2023 · 1 comment
Closed

Return labels in data API for qualitative analysis responses #4627

jnm opened this issue Sep 7, 2023 · 1 comment
Assignees
Labels

Comments

@jnm
Copy link
Member

jnm commented Sep 7, 2023

UUIDs should be private and internal only, although they must be returned by APIs used for the front-end qualitative analysis UI.

I decided to leave the UUIDs and return the labels additionally. @magicznyleszek, does this output format work for you?

{
  "_supplementalDetails": {
    "source_question_path": {
      "qual": [
        {
          "val": {
            "uuid": "260488e0-0dc7-4faa-85fb-bc1806c0d74e",
            "labels": {
              "_default": "this is a select one choice label"
            }
          },
          "type": "qual_select_one",
          "uuid": "73fae086-1249-4f97-a7eb-e0d3456c0015",
          "qpath": "source_question_path",
          "scope": "by_question#survey",
          "labels": {
            "_default": "this is a select one question label"
          }
        },
        {
          "val": [
            {
              "uuid": "70953b7c-1b1d-496c-86ef-a5cc70ea36aa",
              "labels": {
                "_default": "this is a select multiple choice label 1"
              }
            },
            {
              "uuid": "0e6f9cde-aab5-4419-8e57-af33a795da68'",
              "labels": {
                "_default": "this is a select multiple choice label 2"
              }
            }
          ],
          "type": "qual_select_multiple",
          "uuid": "bcdd6444-25dc-42b1-8f8b-28c11b324ee1",
          "qpath": "source_question_path",
          "scope": "by_question#survey",
          "labels": {
            "_default": "this is a select multiple question label"
          }
        },
        {
          "val": "this is a text response",
          "type": "qual_text",
          "uuid": "507dc90d-2b66-4433-aa03-7a5bb28a1580",
          "qpath": "source_question_path",
          "scope": "by_question#survey",
          "labels": {
            "_default": "this is a text question label"
          }
        }
      ],
      "transcript": {
        "value": "this is the english transcript of submission 1",
        "revisions": [
          {
            "value": "this is the english transcript",
            "dateModified": "2023-09-08 16:34:12",
            "languageCode": "en"
          }
        ],
        "dateCreated": "2023-09-08 16:34:22",
        "dateModified": "2023-09-08 16:34:22",
        "languageCode": "en"
      }
    }
  }
}
@jnm jnm self-assigned this Sep 7, 2023
@jnm jnm added the Back end label Sep 7, 2023
@jnm jnm changed the title Return labels in data API for qualitative analysis responses instead of UUIDs Return labels in data API for qualitative analysis responses Sep 8, 2023
@magicznyleszek
Copy link
Member

magicznyleszek commented Sep 21, 2023

@jnm I think I mentioned it already somewhere, but for clarity: yes, these looks good :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants