HomeUsing the Platform APIPlatform API Reference

docs.getCategories

This method returns a list of categories or subcategories.

Parameters

NameTypeDescription
api_keystring(required)API key assigned to your account.
api_sigstring(optional)MD5 hash of the active request and your secret key. This is an optional security measure. See the signing documentation for more info.
session_keystring(optional)A session key for a signed in user. If this parameter is provided, your application will carry out actions on behalf of the signed in user corresponding to the session key. Otherwise, your application will carry out actions on behalf of the user account associated with the API account. See the authentication documentation for more information
my_user_idstring(optional)This parameter is intended for sites with their own user authentication system. You can create phantom Scribd accounts that correspond to your users by simply passing the unique identifier you use to identify your own user accounts to my_user_id. If you pass this parameter to an API method, the API will act as if it were executed by the phantom user corresponding to my_user_id. See the authentication documentation for more information.
category_idinteger(optional)The ID of category to retrieve children for. If none - all root categories will be returned.
with_subcategoriesboolean(optional)Include subcategories in results.

Sample return XML

<?xml version="1.0" encoding="UTF-8"?><rsp stat="ok"><result_set><result><id>2</id><name><![CDATA[Top Category 1]]></name><subcategories/></result><result><id>3</id><name><![CDATA[Top Category 2]]></name><subcategories><subcategory><id>4</id><name><![CDATA[Subcategory 1]]></name></subcategory></subcategories></result></result_set></rsp>

Result explanation

NameTypeDescription
result_setlistThis contains the list of results returned by method.
resultlistContains each individual category.
idintegerID of the category.
namestringCategory name.
subcategorieslistContains the list of subcategories returned by method when :with_subcategories is true.
subcategorylistContains each individual subcategory when :with_subcategories is true.
idintegerID of the subcategory.
namestringSubcategory name.

Error codes

401Unauthorized
500Internal Server Error. Scribd has been notified about this problem.
625Category could not be found

Back to Platform API Reference

scribd