[TYPE 1] [Collections]

[jorwoods]

Summary

Support Collections endpoint

Request Type

If you know, say which of these types your request is in the title, and follow the suggestions for that type when writing your description.

Type 1: support a REST API:
If it is functionality that already exists in the REST API, example API calls are the clearest way to explain your request.

Description

CRUD operations for collections are support in 3.28+. Add support into TSC.

Please assign this issue to me.

[jorwoods]

The Collections API endpoints return JSON by default. They can be made to return XML by passing in the correct request header. Regarding adding the support, I have a few questions.

1. Should the Collections endpoints operate in JSON, their default, or XML the way most of TSC does?
2. The fields within the collections endpoint to "List items in a collection" don't have the same structure as what is returned by the rest of the XML endpoints. E.G. for workbooks, owner details are not nested under an owner element. Tags are <tags><value>some tag</value></tags> instead of <tags><tag>some tag</tag></tags>. So even if the XML is used, the parsing will have to follow separate paths.
3. If the we decide not to include full object parsing directly in the Collections listing, does it support anything like fields so we can reduce network traffic of unused XML attributes?
4. The "List Items in a collection" XML contains a "position" attribute on the item element. This value is negative. Can you help me understand this value? Is a closer to 0 value earlier or later in the collection?
5. The official API docs don't contain any details on the various error codes and what they might mean. Should I try to parse these into ServerResponseErrors or something else?
6. There are values like id, ownerId, siteId, etc. that are purely numeric and not UUID4s like I am used to seeing. Do we need to do anything with those IDs? Do they correspond to IDs returned by other REST or Metadata endpoints?