Skip to main content

UserCollection Schema

Data structure for User Collection objects.

Item Type​

This is a collection (list) of User items.

Usage​

# Example: Working with UserCollection
items = [
    {"id":1,"name":"name-value-1","email":"email-value-1","score":1,"devices":[]},
    {"id":2,"name":"name-value-2","email":"email-value-2","score":2,"devices":[]}
]

# Pass to an action that requires this collection type
resource.some_action(body=items)

JSON Example​

[
  {
    "id": 1,
    "name": "name-value-1",
    "email": "email-value-1",
    "score": 1,
    "devices": []
  },
  {
    "id": 2,
    "name": "name-value-2",
    "email": "email-value-2",
    "score": 2,
    "devices": []
  }
]