Arlo

REST Auth API: ListItems

ListItem resources are a subresource of Lists, and represent a distinct string value within a list.

ListItems collection resource

The Items collection resource represents the set of all Items associated with a parent List resource.

Resource URI

/api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/items/

Resource properties

Property Description
Text A string denoting the displayable value of this item, up to 128 characters long.
Code An optional string representing the code of this list item, up to 32 characters long. This is designed to be the persisted machine reference to the item, even if the display value of the item changes.

HTTP GET

Returns a representation of the collection as a set of Item elements.

Optional parameters
Parameter Description
skip Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The skip and top parameters are generally used for collection paging.
top Returns a subset of records from the collection, starting at index 0 or index skip, and returns the first N records. The skip and top parameters are generally used for collection paging.
Example

GET /api/2012-02-01/auth/resources/events/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/items/

<Items>
  <Item>
    <Text>1 hour</Text>
    <Code>1h</Code>
  </Item>
  <Item>
    <Text>2 hours</Text>
    <Code>2h</Code>
  </Item>
  <Item>
    <Text>Half day</Text>
    <Code>0.5d</Code>
  </Item>
  <Item>
    <Text>1 day</Text>
    <Code>1d</Code>
  </Item>
  <Item>
    <Text>2 days</Text>
    <Code>2d</Code>
  </Item>
  <Item>
    <Text>1 week</Text>
    <Code>1w</Code>
  </Item>
  <Item>
    <Text>Fornight</Text>
    <Code>2w</Code>
  </Item>
  <Item>
    <Text>1 month</Text>
    <Code>1m</Code>
  </Item>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/lists/7a2a4563-3702-4b63-80a2-05de2cb6cbc4/items/" />
</Items>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.