PUT (/users/xuid(xuid)/lists/PINS/)
Updates the items in a list according to the indexes specified for each item in the request body. The domain for these URIs iseplists.xboxlive.com.
- Remarks
- URI parameters
- Authorization
- HTTP status codes
- Required Request Headers
- Request body
- Response body
Remarks
This call will update the items in a list according to the indexes specified for each item in the request body. This call will not insert items into the list, and if items do not exist at the specified indexes, then the call will return a 400 Bad Request status. Multiple items can be updated in a single call, but all must exist in the current list. That is, all get updated or none get updated. This call will allow the item to be updated to be specified by the itemId instead of index. To do this, simply use “-1” for the index in the IndexedItems structure that is sent to the service. Obviously in this case, the itemId cannot be changed as part of the update, so it will only work for changes to other metadata fields. The provider/providerId combo can be used instead of itemId to identify the item. Internally, the service searches the list for these items and figures out the proper indexes to update. If the item or items cannot be found then a 400 Bad Request status will be returned and no items will be updated. This call requires an If-Match:versionNumber header to be included in the request if using indexes to identify items. If using item IDs to identify the items (and the list doesn’t allow duplicates), then the If-Match header is optional. If present, the if-Match header will always be validated. In the header, the versionNumber is the current version number of the list. If it is not included (and required), or does not match the current list version number, then an HTTP 412 Precondition Failed status code will be returned and the body of the response will contain the latest metadata of the list that includes the current version number. This is to guard against updates from different clients trampling on one another.URI parameters
Authorization
This call expects an XSTS SAML token in the Authorization header. A Xuid claim must exist within that SAML token to identify the caller. This value is used to determine if the caller has access rights to the list data in question. The list itself will be identified by the Xuid as well and will be included in the URI for the list. Using this, we may in the future support shared access to lists, but that is not a feature at this time. Currently, all lists that a user accesses will be their own and there is no shared access. Thus the Xuid in the URI must match the Xuid in the SAML claims token.Note:
Both XBL Auth 2.0 and 3.0 tokens are supported at present.