IQSS / IQSS/dataverse

API Retrieve Guestbook Responses for a Dataverse Collection in JSON format

Open
#12,451 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Guestbook GREI Re-arch Size: 10 SPA
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

When a sub-collection uses guestbooks inherited from its parent collection, we need to retrieve the guestbook responses using a specific Dataverse collection ID.

We have an api similarly but in csv format Retrieve Guestbook Responses for a Dataverse Collection in Native API, but we also need return responses in JSON format.

Can we extend this API to support a Dataverse collection ID as well?
curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/guestbooks/$ID/responses?limit10&offset=0"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Native API entry point for retrieving guestbook responses, linked in the issue, and compare the existing CSV behavior with the curl endpoint shown. Add support for a Dataverse collection ID and JSON responses, including inherited guestbooks; done means the endpoint returns the collection's responses with limit and offset parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, json
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.