VocabList Endpoints
This endpoint gives you access to all lists a user would have access to (except for ChinesePod lists), as well as the ability to make the same sorts of edits the user is authorized to make. Use this endpoint if you want to:
- See what lists Skritter has available.
- See what lists the user is studying, and where they are in their progress.
- Control what lists a user is studying, or any other such setting.
- Create, reorganize, or delete lists, or modify their meta data.
Example: List of Lists Being Studied
Goal:
Print out the names of the lists the user is studying.
Solution:
Use the "sort" field to specify.
# prepare the request GET parameters
params = {
'sort': 'studying',
'gzip': False,
}
# fetch the first 100
response = client.get('http://beta.skritter.com/api/v0/vocablists', params)
response = json.loads(response.content)
for vocab_list in response['VocabLists']:
print 'studying', vocab_list['name'], 'with state', vocab_list['studyingMode']
Example: Fetching Words
Goal:
Get a complete list of Vocab ids in a list.
Solution:
Fetch the list by id, then compile the Vocab ids in there.
# prepare the request GET parameters
params = {
# minor optimization, not required
'fields':'sections',
'sectionFields':'vocabIds,tradVocabIds',
'gzip': False
}
# fetch the first 100
response = client.get('http://beta.skritter.com/api/v0/vocablists/%s' % vocab_list_id, params)
response = json.loads(response.content)
# compile the Vocab ids
vocab_ids = set()
for section in response['VocabList']['sections']:
for row in section['rows']:
vocab_ids.add(row['vocabId'])
vocab_ids.add(row['tradVocabId'])
return vocab_ids
Example: New List
Goal:
Create a new custom list, and have some sections in there.
Solution:
Build the list, then use POST to save it.
# prepare the request GET parameters
params = {
'gzip': False
}
# build the list
vocab_list = {
'name': 'New List', # required
'lang': 'ja', # required
'description': 'Made through the API',
'tags':['intermediate', 'technology'],
'sections': [
{ 'name': 'Section 1' }, # section name required too
{ 'name': 'Section 2' },
{ 'name': 'Section 3' },
]
}
# POST it
data = json.dumps(vocab_list)
response = client.post('http://beta.skritter.com/api/v0/vocablists', params, data=data)
response = json.loads(response.content)
return response['VocabList']['id'] # now you have the id
Example: Editing Lists
Goal:
Given a VocabList id, reverse its name, shuffle its sections, and delete its last section, for science.
Solution:
Fetch the list, make the edits, and use PUT to return the result.
# no special GET parameters needed
params = {
'gzip': False
}
url = 'http://beta.skritter.com/api/v0/vocablists/%s' % vocab_list_id
# fetch the list
response = client.get(url, params)
response = json.loads(response.content)
vocab_list = response['VocabList']
# reverse the list name
name = list(vocab_list['name'])
name.reverse()
vocab_list['name'] = ''.join(name)
# randomize the sections
import random
random.shuffle(vocab_list['sections'])
# delete the last section
if vocab_list['sections']:
vocab_list['sections'][-1]['deleted'] = True
# save changes
data = json.dumps(vocab_list)
response = client.put(url, params, data=data)
# print results
if response.status_code == 200:
print 'operation "list chaos" successful'
else:
print '%s: %s' % (response.get('error'), response.get('message'))
· · · Table of Contents · · ·
Topics
Resource Endpoints
- Cancellations
- Coupons
- Items
- Payments
- ProgressStats
- Reviews
- SRSConfigs
- Subscriptions
- Users
- Vocabs
- VocabLists
- VocabListSections
- VocabUpdates