API Function - Get User Set

Back to API list

Use this service to get a single set saved in the specified user's Sets, optionally provide a Set List ID to limit the count to that set list. If they don't have the set, it will return a quantity of 0.

URL /api/get_user_set
Method GET
Parameters key - API Key
format - How to display output data. Valid values: xml, json, csv, tsv
callback - Optional JSONP callback function name
email - The user's logon email.
pass - The user's password.
hash - User Hash Key, alternate to providing email+pass.
set - The Set ID to look up (e.g. 8258-1)
setlist_id - Optional Set List ID to query
Returns

Output data with fields:

  • N/A - The number of sets owned by the user.
  • Error Codes:

  • INVALIDKEY - The API Key is invalid
  • INVALIDPASS - Invalid user email or password
  • INVALIDHASH - The hash key does not match a user/password
  • NOUSER - The user could not be found
  • NOSET - The set could not be found
  • Test Values

    API Key:
    Format:
    User email:
    User password:
    User hash:
    Set ID:
    Set List ID:
    Test

    Test Results