V1.Metadata.Common:View

Jump to: navigation, search

View

Contains information about which items in a list of items were returned.

Elements

NameTypeDescription
count Integer Number of items returned in the response. Returned only for requests with a specified offset parameter or a default or specified count parameter.
offset Integer Number of the first item returned from a list of items, with zero being the first item in the list. Returned only if the count or offset parameter is specified in the request.
total Integer The number of items:
  • If count is not returned, the number of items returned.
  • If count is returned, the number of items available to be returned.

XML Response Example

Sample response if the request specifies the count or offset parameter.
<view>
  <offset>25</offset>
  <count>5</count>
  <total>126</total>
</view>

XML Response Example 2

Sample response if the request does not specify the count or offset parameter.
<view>
  <total>126</total>
</view>

JSON Response Example

Sample response if the request specifies the count or offset parameter.
  "view": {
    "offset": 25,
    "count": 5,
    "total": 126
  },

JSON Response Example 2

Sample response if the request does not specify the count or offset parameter.
  "view": {
    "total": 126
  },
 
Personal tools