REST Auth API: ListRelatedObjects

ListRelatedObjects are inline resource fragments that contain a reference to a List. As such, they represent neither a resource or sub resource, but are instead a more complex member of an enclosing resource.

All ListRelatedObject fragments are enclosed within a container element whose name will be noted in the documentation referencing this document.

Properties

Property	Description
Items	An array of Items, each Item child element being a simple string
ContainerID	A Guid value indicating the platform container that describes the List related resource.

Related resource links

Link (title)	Description
ObjectListContainer	Reference to the List resource representing the list from which Item values will be derived.

Example

The following XML fragment illustrates a list related object, with a top level container element of NewsletterSubscriptions, and with child elements as referred to in this document.

<NewsletterSubscriptions>
  <Items>
    <Item>Marketing</Item>
  </Items>
  <ContainerID>81f4b414-90c7-437f-a31e-421c41dbae85</ContainerID>
  <Link rel="http://schemas.learningsourceapp.com/api/2012/02/auth/related/ObjectListContainer" type="application/xml" title="ObjectListContainer" href="https://api.learningsourceapp.com/demo/api/2012-02-01/auth/resources/lists/7b26257b-d455-406c-940a-f520116751b4/" />
</NewsletterSubscriptions>