Manage Guestbook API: Edit guestbook and Responses table

[ChengShi-1]

Overview of the Feature Request
According to native API guestbook, comparing with what we need for support SPA, we need some endpoints for guestbook management

Existing APIs to use:

• GET /api/guestbooks/{dataverseId}/list
• GET /api/guestbooks/{guestbookId}
• POST /api/guestbooks/{dataverseId}
• PUT /api/guestbooks/{dataverseIdentifier}/{guestbookId}/enabled
• GET /api/dataverses/{dataverseId}/guestbookResponses
• GET /api/dataverses/{dataverseId}/guestbookResponses?guestbookId={guestbookId}
• Add usage and response counts to get guestbooks list #12269

New / enhanced APIs needed:

• Edit Guestbook API
• get a list of responses with other infor in table API

1. edit a dataset guestbook
   `curl -PUT -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/guestbooks/{ID}" -d "$JSON"
2. get a list of responses in table (json response api, not the download)

What kind of user is the feature intended for?(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)

What inspired the request?
Manage Guestbook page is a must-have for SPA

Any open or closed issues related to this feature request?

Are you thinking about creating a pull request for this feature?
Help is always welcome, is this feature something you or your organization plan to implement?

[stevenwinship]

@ChengShi-1 Could you elaborate on what this requirement means

"get a list of responses with other infor in table API"
"get a list of responses in table (json response api, not the download)"

I think I found the answer:
Are you looking for an API that mimics the guestbook-responses.xhtml streamResponsesByDataverseIdAndGuestbookId?

[ChengShi-1]

@ChengShi-1 Could you elaborate on what this requirement means

"get a list of responses with other info in table API"
"get a list of responses in table (json response api, not the download)"

Both of them are same, for the table of guestbook response

It means each response row should include not just the raw guestbook answers, but also the table metadata the page displays, such as:

• dataset
• date
• type
• file
• user
• custom question answers

This could follow the same structure with the Download guestbook responses native api, and the sample response file Root_5_GuestbookResponses.csv, the json could be
{ "guestbook": "Guestbook f60daf83-a705-46f9-b660-9f1040da23e1", "dataset": "Darwin's Finches", "datasetPid": "doi:10.5072/FK2/WGWVMS", "date": "05/13/2026", "type": "Download", "fileName": "blob-1", "fileId": 198, "filePid": "doi:10.5072/FK2/WGWVMS/O0GTPD", "userName": "qewqeq", "email": "eqqw@gmsil.com", "institution": "", "position": "", "customQuestions": "" } and the CURL example could be
curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/dataverses/$ID/guestbookResponses?guestbookId=$GUESTBOOK_ID"

@ChengShi-1 Could you elaborate on what this requirement means

"get a list of responses with other infor in table API" "get a list of responses in table (json response api, not the download)"

I think I found the answer: Are you looking for an API that mimics the guestbook-responses.xhtml streamResponsesByDataverseIdAndGuestbookId?

[stevenwinship]

Currently the data is streamed as a csv file back to JSF. Would it make more sense return json with pagination?

[ChengShi-1]

Currently the data is streamed as a csv file back to JSF. Would it make more sense return json with pagination?

yes, pagination is a good approach. Thanks!