GetProfileEntitiesRequest

class wwt_api_client.communities.GetProfileEntitiesRequest(communities_client)[source]

Bases: wwt_api_client.communities.CommunitiesAPIRequest

Get “entities” associated with the logged-in user.

Entities include communities, folders, and content files. The response is JSON.

Methods

invalidity_reason(self)

Check whether the parameters of this request are valid.

make_request(self)

Generate a requests.Request from the current parameters.

send(self[, raw_response])

Issue the request and return its result.

to_text(self)

Issue the request and return its results as text.

to_xml(self)

Issue the request and return its results as parsed XML.

Attributes Summary

current_page

What page of search results to return – starting at 1.

entity_type

What kind of entity to query.

page_size

How many items to return per page of search results.

Methods Summary

invalidity_reason(self)

Check whether the parameters of this request are valid.

make_request(self)

Generate a requests.Request from the current parameters.

Attributes Documentation

current_page = 1

What page of search results to return – starting at 1.

entity_type = 'Content'

What kind of entity to query. Only COMMUNITY and CONTENT are allowed.

page_size = 99999

How many items to return per page of search results.

Methods Documentation

invalidity_reason(self)[source]

Check whether the parameters of this request are valid.

Returns
reasonstring or None

If None, indicates that this request is valid. Otherwise, the returned string explains what about the request’ parameters is invalid.

Examples

You can manually check if a request is correctly set up:

>>> from wwt_api_client import Client
>>> req = Client().show_image('http://example.com/space.jpg', 'My Image')
>>> assert req.invalidity_reason() is None
make_request(self)[source]

Generate a requests.Request from the current parameters.

This method returns a requests.Request object ready for sending to the API server.

Returns
requestrequests.Request object

The HTTP request.

Examples

Get the URL that will be accessed for a request:

>>> from six.moves.urllib.parse import urlparse
>>> from wwt_api_client import Client
>>> req = Client().show_image('http://example.com/space.jpg', 'My Image')
>>> parsed_url = urlparse(req.make_request().prepare().url)
>>> print(parsed_url.path)
/WWTWeb/ShowImage.aspx